Creates a new work order
Request Information
URI Parameters :
None.
Body Parameters :
jobsName | Description | Type | Additional information |
---|---|---|---|
id |
Primary Key |
globally unique identifier | |
_parent_id |
Reference to a parent job (in case of Multi Job) |
globally unique identifier | |
_parent_job |
Embedded entity "job" for parent (multi job level) when adding/updating job |
jobs | |
_parent_jobs_reference_back_office |
Embedded entity "job" for parent (multi job level) using ERP PK when adding/updating job |
string | |
project_id |
Foreign key of project for this job |
globally unique identifier |
Optionally required : project_id, project_reference_back_office or project must be provided |
project_reference_back_office |
Embedded entity "project" using ERP PK when adding/updating job |
string |
Optionally required : project_id, project_reference_back_office or project must be provided |
project |
Embedded entity "project" when adding/updating job |
project |
Optionally required : project_id, project_reference_back_office or project must be provided |
job_type_id |
Foreign key of job type for this job |
globally unique identifier |
Optionally required : job_type_id, job_type_code or job_type must be provided |
job_type_code |
Embedded entity "job_type" using ERP PK when adding/updating job |
string |
Optionally required : job_type_id, job_type_code or job_type must be provided |
job_type |
Embedded entity "job_type" when adding/updating job |
job_type |
Optionally required : job_type_id, job_type_code or job_type must be provided |
job_priority_id |
Foreign key of job priority for this job |
globally unique identifier | |
job_priority_code |
Foreign key of job status for this job. If you don't know the GUID, use job_type_code |
string | |
job_priority |
Embedded entity "job_priority" when adding/updating job |
job_priority | |
job_status_id |
Foreign key of job status for this job |
globally unique identifier |
Optionally required : job_status_id or job_status_code must be provided |
job_status_code |
Foreign key of job status using code. Use "Canceled,ToBePlanned, Waiting, Pooling, Suggested, Activated or Open" If Status=Suggested AND suggested_user filled AND suggested_date_start filled THEN a job_planning will be added |
string |
Optionally required : job_status_id or job_status_code must be provided |
db_address_id |
Foreign key of db_address if job is not on a mobile equipment.Must be the address_id of the location or the equipment |
globally unique identifier | |
contact_id |
Foreign key of contact if the main contact of the job is different than the one of the project |
globally unique identifier | |
requested_by_company_id |
Foreign key of company if a specific company makes the request for this job |
globally unique identifier | |
requested_by_contact_id |
Foreign key of contact to specify why contact of the requested_company_id makes the request |
globally unique identifier | |
reference_back_office |
The Id/Ref of the back office for this job. Used by Embedded entity |
string |
Max length: 50 |
name |
Name of the Job |
string |
Required Max length: 255 |
description |
Description of the job |
string |
Max length: 4000 |
working_sequence |
In case of mutli job, they will be ordered by this sequence |
integer | |
internal_memo |
Internal field for communication between BackOffice/Planners/Technicians |
string | |
prejob_information |
Information usefull for the technician before start (Call the customer,...) |
string | |
estimated_time |
Estimation of the time needed (in minute). Will be used for planning and statistic |
integer | |
earliest_date_plannable |
Use this field if there is a minimum date for the planning (Not Before) |
date | |
due_date |
Deadline of Max date for the planning (Not After) |
date | |
date_create |
Creation date+time |
date | |
date_update |
Update date+time |
date | |
date_closed |
Date+time job goes to completed |
date | |
suggested_user_id |
Foreign key of user if there is a suggested user (used for planning) If Status=Suggested AND suggested_user filled AND suggested_date_start filled THEN a job_planning will be added |
globally unique identifier | |
suggested_user_code |
Embedded entity "suggested user" using ERP PK when adding/updating job |
string | |
suggested_user |
Embedded entity "sugessted user" when adding/updating job |
user | |
suggested_date_start |
Suggested date+time start (used for planning) If Status=Suggested AND suggested_user filled AND suggested_date_start filled THEN a job_planning will be added |
date | |
skill_id |
Foreign key of skill if the job requires a specific skill (used for planning) |
globally unique identifier | |
skill_code |
Embedded entity "skill" using ERP PK when adding/updating job |
string | |
skill |
Embedded entity "skill" when adding/updating job |
skill | |
customer_reference |
Reference of this job for the customer |
string |
Max length: 50 |
approval_responsible_user_id |
In case of multi user job, foreign key of user that is the "WO Leader" |
globally unique identifier | |
date_reported_by_company |
Date+time when company reported the problem |
date | |
id2 |
Internal ID (numeric). Will be used if reference_back_office is empty |
integer | |
company_id |
This field will be filled automatically based on the project_id |
globally unique identifier | |
company_code |
This field will be filled automatically based on the project_id |
string | |
db_address_name |
When mobile equipment, the address to use |
string |
Max length: 100 |
db_address_street |
When mobile equipment, the address to use and this field is mandatory |
string |
Max length: 50 |
db_address_street2 |
It is sub street |
string |
Max length: 50 |
db_address_street_number |
When mobile equipment, the address to use |
string |
Max length: 50 |
db_address_city |
When mobile equipment, the address to use and this field is mandatory |
string |
Max length: 50 |
db_address_zip |
When mobile equipment, the address to use and this field is mandatory |
string |
Max length: 50 |
db_address_db_country_id |
When mobile equipment, the address to use |
globally unique identifier | |
db_address_db_country_code |
When mobile equipment, the address to use |
string | |
db_address_phone |
When mobile equipment, the address to use |
string |
Max length: 50 |
db_address_email |
When mobile equipment, the address to use |
string |
Max length: 250 |
db_address_latitude_decimal |
Latitude |
decimal number | |
db_address_longitude_decimal |
Latitude |
decimal number | |
estimated_quantity_remark |
Description of the parts your technician should use or pick up |
string |
Max length: 4000 |
modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date |
Request Formats :
application/json, text/json
{ "id": "65e2a626-395d-41ee-9e91-6a9be4d65268", "_parent_id": "15e1f1f2-3600-4b8b-9a52-12dcce658d76", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "efee0646-4100-47d4-a0c4-d4077bbd9c69", "project_reference_back_office": "sample string 5", "project": { "id": "f9309be4-1b42-486b-9892-9c70af4016df", "_parent_id": "25c50207-8c59-4198-a2ac-266401e9a1a7", "root_parent_id": "9ca0bd0f-8f26-4dfd-a3ff-c04eb3b34631", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "41fa7fde-2f24-4e9d-a90c-bd97f3738292", "equipment_family_code": "sample string 6", "equipment_family": { "id": "04f31919-f986-4bf5-a12d-5eac6f833134", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "db9c980c-dc66-4415-b4f9-19faf329e6a5", "_parent_code": "sample string 6", "sales_organization_id": "f3f054c9-5c2d-49b9-9d88-827ce0f564b9", "sales_organization_code": "sample string 8", "sales_organization": { "id": "5249bc90-e7ba-42e1-8ee5-ffc5c13f128d", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "772322bd-4ccc-47f0-97fe-f71b548b39ed", "db_currency_id": "2166eb6c-3da9-4acc-8110-af8ab02e8314", "db_language_id": "159d1715-e53c-4333-8e76-4f56726accd2", "accountancy_code": "sample string 8", "archived": true, "default_unit_of_measure_system_type": "sample string 10", "street": "sample string 11", "street2": "sample string 12", "street_number": "sample string 13", "zip": "sample string 14", "city": "sample string 15", "email": "sample string 16", "phone": "sample string 17", "fax": "sample string 18", "url": "sample string 19", "vat_reg_code": "sample string 20", "modified_dateutc": "2025-07-15T19:10:22.5335713+00:00" }, "modified_dateutc": "2025-07-15T19:10:22.5335713+00:00" }, "equipment_model_id": "7427134d-65a4-4980-949c-cde805ab9c08", "equipment_model_code": "sample string 8", "equipment_model": { "id": "344cb0e1-9386-46e0-9ca2-267d6f757009", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "47623fec-5dc5-4a65-ad55-28a3e3684bbd", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "ca84996a-b049-46f4-9a5a-e2a235c5b6df", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "5da78496-c039-4094-9277-af5846a322f9", "sales_organization_code": "sample string 5", "sales_organization": { "id": "5249bc90-e7ba-42e1-8ee5-ffc5c13f128d", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "772322bd-4ccc-47f0-97fe-f71b548b39ed", "db_currency_id": "2166eb6c-3da9-4acc-8110-af8ab02e8314", "db_language_id": "159d1715-e53c-4333-8e76-4f56726accd2", "accountancy_code": "sample string 8", "archived": true, "default_unit_of_measure_system_type": "sample string 10", "street": "sample string 11", "street2": "sample string 12", "street_number": "sample string 13", "zip": "sample string 14", "city": "sample string 15", "email": "sample string 16", "phone": "sample string 17", "fax": "sample string 18", "url": "sample string 19", "vat_reg_code": "sample string 20", "modified_dateutc": "2025-07-15T19:10:22.5335713+00:00" }, "modified_dateutc": "2025-07-15T19:10:22.5335713+00:00" }, "equipment_family_id": "d75718e9-a0ff-4132-a233-6d2afef5ad11", "equipment_family_code": "sample string 8", "equipment_family": { "id": "04f31919-f986-4bf5-a12d-5eac6f833134", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "db9c980c-dc66-4415-b4f9-19faf329e6a5", "_parent_code": "sample string 6", "sales_organization_id": "f3f054c9-5c2d-49b9-9d88-827ce0f564b9", "sales_organization_code": "sample string 8", "sales_organization": { "id": "5249bc90-e7ba-42e1-8ee5-ffc5c13f128d", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "772322bd-4ccc-47f0-97fe-f71b548b39ed", "db_currency_id": "2166eb6c-3da9-4acc-8110-af8ab02e8314", "db_language_id": "159d1715-e53c-4333-8e76-4f56726accd2", "accountancy_code": "sample string 8", "archived": true, "default_unit_of_measure_system_type": "sample string 10", "street": "sample string 11", "street2": "sample string 12", "street_number": "sample string 13", "zip": "sample string 14", "city": "sample string 15", "email": "sample string 16", "phone": "sample string 17", "fax": "sample string 18", "url": "sample string 19", "vat_reg_code": "sample string 20", "modified_dateutc": "2025-07-15T19:10:22.5335713+00:00" }, "modified_dateutc": "2025-07-15T19:10:22.5335713+00:00" }, "date_in_production_since": "2025-07-15T19:10:22.5335713+00:00", "date_out_of_production_since": "2025-07-15T19:10:22.5335713+00:00", "date_end_support": "2025-07-15T19:10:22.5335713+00:00", "sales_organization_id": "2bf143a5-678f-446e-992a-1659f126cc1f", "sales_organization_code": "sample string 13", "sales_organization": { "id": "5249bc90-e7ba-42e1-8ee5-ffc5c13f128d", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "772322bd-4ccc-47f0-97fe-f71b548b39ed", "db_currency_id": "2166eb6c-3da9-4acc-8110-af8ab02e8314", "db_language_id": "159d1715-e53c-4333-8e76-4f56726accd2", "accountancy_code": "sample string 8", "archived": true, "default_unit_of_measure_system_type": "sample string 10", "street": "sample string 11", "street2": "sample string 12", "street_number": "sample string 13", "zip": "sample string 14", "city": "sample string 15", "email": "sample string 16", "phone": "sample string 17", "fax": "sample string 18", "url": "sample string 19", "vat_reg_code": "sample string 20", "modified_dateutc": "2025-07-15T19:10:22.5335713+00:00" }, "replacement_period_nb_months": 14, "warranty_period_nb_months": 15, "translations": [ { "field_name": "sample string 1", "language_code": "sample string 2", "value_translated": "sample string 3" }, { "field_name": "sample string 1", "language_code": "sample string 2", "value_translated": "sample string 3" } ], "modified_dateutc": "2025-07-15T19:10:22.5491932+00:00" }, "project_status_id": "6d95ae39-dc9d-4178-829a-633da53526d2", "project_status_code": "sample string 10", "project_status": { "id": "2e853071-31fd-4cca-90ae-f67a5a9f7a8d", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "ce492e36-47f8-40e7-8d63-98fb6baecaf6", "sales_organization_code": "sample string 6", "sales_organization": { "id": "5249bc90-e7ba-42e1-8ee5-ffc5c13f128d", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "772322bd-4ccc-47f0-97fe-f71b548b39ed", "db_currency_id": "2166eb6c-3da9-4acc-8110-af8ab02e8314", "db_language_id": "159d1715-e53c-4333-8e76-4f56726accd2", "accountancy_code": "sample string 8", "archived": true, "default_unit_of_measure_system_type": "sample string 10", "street": "sample string 11", "street2": "sample string 12", "street_number": "sample string 13", "zip": "sample string 14", "city": "sample string 15", "email": "sample string 16", "phone": "sample string 17", "fax": "sample string 18", "url": "sample string 19", "vat_reg_code": "sample string 20", "modified_dateutc": "2025-07-15T19:10:22.5335713+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-07-15T19:10:22.5491932+00:00" }, "company_id": "3d1198a8-1fd6-427c-b68f-79d013919030", "company_code": "sample string 12", "db_address_id": "034ab115-7935-4aa2-8357-55cf5aec1d72", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "4c296558-17b4-4a52-8e14-a265af018bb2", "contact_reference_back_office": "sample string 17", "owner_user_id": "697040a0-cc16-43ee-8783-f32edc8f00e7", "name": "sample string 19", "description": "sample string 20", "reference_back_office": "sample string 21", "serial_number": "sample string 22", "barcode": "sample string 23", "date_start_production": "2025-07-15T19:10:22.5491932+00:00", "date_create": "2025-07-15T19:10:22.5491932+00:00", "date_update": "2025-07-15T19:10:22.5491932+00:00", "updated_by_user_id": "9a4629f8-eef5-4e01-99b4-4240a9547b45", "customer_reference": "sample string 28", "warranty_date_until": "2025-07-15T19:10:22.5491932+00:00", "last_standard_result_score_1": "sample string 30", "last_standard_result_score_2": "sample string 31", "target_standard_result_score_1": "sample string 32", "target_standard_result_score_2": "sample string 33", "date_built": "2025-07-15T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-07-15T19:10:22.5491932+00:00", "date_last_job": "2025-07-15T19:10:22.5491932+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-07-15T19:10:22.5491932+00:00", "modified_dateutc": "2025-07-15T19:10:22.5491932+00:00", "is_mobile_installation": true }, "job_type_id": "cabe0eff-3469-46b2-89e7-1a2b865816b6", "job_type_code": "sample string 7", "job_type": { "id": "8fbdcbde-f27a-4749-a7d0-003a20700a94", "name": "sample string 2", "sales_organization_id": "7169756f-9ab6-433e-a165-71a51df6531c", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-07-15T19:10:22.5491932+00:00", "code": "sample string 7" }, "job_priority_id": "ad88063a-9d8a-4833-a940-e05da1d95b9f", "job_priority_code": "sample string 9", "job_priority": { "id": "e24901a1-5d09-416c-9170-dd515c9f6f84", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "54b06bc5-388a-4fa9-9769-9f5af4b7e26d", "sales_organization_code": "sample string 6", "sales_organization": { "id": "5249bc90-e7ba-42e1-8ee5-ffc5c13f128d", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "772322bd-4ccc-47f0-97fe-f71b548b39ed", "db_currency_id": "2166eb6c-3da9-4acc-8110-af8ab02e8314", "db_language_id": "159d1715-e53c-4333-8e76-4f56726accd2", "accountancy_code": "sample string 8", "archived": true, "default_unit_of_measure_system_type": "sample string 10", "street": "sample string 11", "street2": "sample string 12", "street_number": "sample string 13", "zip": "sample string 14", "city": "sample string 15", "email": "sample string 16", "phone": "sample string 17", "fax": "sample string 18", "url": "sample string 19", "vat_reg_code": "sample string 20", "modified_dateutc": "2025-07-15T19:10:22.5335713+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-07-15T19:10:22.5491932+00:00" }, "job_status_id": "b7075e49-b368-434c-997c-ab2f976b698e", "job_status_code": "sample string 11", "db_address_id": "a5c5ea7c-d772-4824-b0ab-d1b1ea7b6128", "contact_id": "5b9605d3-1fd8-4d88-b735-02118c3230e4", "requested_by_company_id": "3b356c81-db2e-42c4-9bbd-0f624d691818", "requested_by_contact_id": "5fccd389-31bb-45c8-aa2a-50de4ce7d8d1", "reference_back_office": "sample string 16", "name": "sample string 17", "description": "sample string 18", "working_sequence": 19, "internal_memo": "sample string 20", "prejob_information": "sample string 21", "estimated_time": 22, "earliest_date_plannable": "2025-07-15T19:10:22.5491932+00:00", "due_date": "2025-07-15T19:10:22.5491932+00:00", "date_create": "2025-07-15T19:10:22.5491932+00:00", "date_update": "2025-07-15T19:10:22.5491932+00:00", "date_closed": "2025-07-15T19:10:22.5491932+00:00", "suggested_user_id": "f2421e93-a301-4eee-9078-74f3f45152ed", "suggested_user_code": "sample string 29", "suggested_user": { "id": "bd2a6190-ac67-410e-8f5d-4776449f4814", "db_language_id": "4a01a1c1-20b2-47f2-9bb4-cfa26fc964fa", "username": "sample string 3", "firstname": "sample string 4", "lastname": "sample string 5", "code": "sample string 6", "archived": true, "disabled": true, "emergency_contact": "sample string 9", "bankaccount": "sample string 10", "social_security": "sample string 11", "place_of_birth": "sample string 12", "nationality": "sample string 13", "functions": "sample string 14", "birthdate": "2025-07-15T19:10:22.5491932+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "dbd6c1a9-21ef-4d57-8f15-0ddcea3e3f20", "sales_organization": { "id": "5249bc90-e7ba-42e1-8ee5-ffc5c13f128d", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "772322bd-4ccc-47f0-97fe-f71b548b39ed", "db_currency_id": "2166eb6c-3da9-4acc-8110-af8ab02e8314", "db_language_id": "159d1715-e53c-4333-8e76-4f56726accd2", "accountancy_code": "sample string 8", "archived": true, "default_unit_of_measure_system_type": "sample string 10", "street": "sample string 11", "street2": "sample string 12", "street_number": "sample string 13", "zip": "sample string 14", "city": "sample string 15", "email": "sample string 16", "phone": "sample string 17", "fax": "sample string 18", "url": "sample string 19", "vat_reg_code": "sample string 20", "modified_dateutc": "2025-07-15T19:10:22.5335713+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "a2094da0-8950-4e0e-903b-8aa032a40a4c", "email": "sample string 22", "phone": "sample string 23", "fax": "sample string 24", "mobile": "sample string 25", "private_email": "sample string 26", "private_phone": "sample string 27", "private_fax": "sample string 28", "private_mobile": "sample string 29", "private_street": "sample string 30", "private_street_number": "sample string 31", "private_city": "sample string 32", "private_zip": "sample string 33", "private_db_country_id": "0805b7d7-e540-44dc-bb6c-f0c8aba79121", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-07-15T19:10:22.5491932+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "c16df2cf-2f7c-4f6f-abbe-528bf37b9236" }, "suggested_date_start": "2025-07-15T19:10:22.5491932+00:00", "skill_id": "1c0be626-2f25-4107-b405-afe00f1994ff", "skill_code": "sample string 32", "skill": { "id": "444496be-2ed7-4195-a2d5-0f55ad68fb12", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "1d39874e-4b9d-458d-84bc-4f1c5d62c34c", "sales_organization_code": "sample string 6", "sales_organization": { "id": "5249bc90-e7ba-42e1-8ee5-ffc5c13f128d", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "772322bd-4ccc-47f0-97fe-f71b548b39ed", "db_currency_id": "2166eb6c-3da9-4acc-8110-af8ab02e8314", "db_language_id": "159d1715-e53c-4333-8e76-4f56726accd2", "accountancy_code": "sample string 8", "archived": true, "default_unit_of_measure_system_type": "sample string 10", "street": "sample string 11", "street2": "sample string 12", "street_number": "sample string 13", "zip": "sample string 14", "city": "sample string 15", "email": "sample string 16", "phone": "sample string 17", "fax": "sample string 18", "url": "sample string 19", "vat_reg_code": "sample string 20", "modified_dateutc": "2025-07-15T19:10:22.5335713+00:00" }, "modified_dateutc": "2025-07-15T19:10:22.5491932+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "d761b370-f745-4b0c-bc16-23b1e4e88d0b", "date_reported_by_company": "2025-07-15T19:10:22.5491932+00:00", "id2": 36, "company_id": "5195ac52-a562-47bb-9501-53fad3afcd2b", "company_code": "sample string 38", "db_address_name": "sample string 39", "db_address_street": "sample string 40", "db_address_street2": "sample string 41", "db_address_street_number": "sample string 42", "db_address_city": "sample string 43", "db_address_zip": "sample string 44", "db_address_db_country_id": "0d154e11-26ad-437c-b6a6-69af139b483f", "db_address_db_country_code": "sample string 46", "db_address_phone": "sample string 47", "db_address_email": "sample string 48", "db_address_latitude_decimal": 49.0, "db_address_longitude_decimal": 50.0, "estimated_quantity_remark": "sample string 51", "modified_dateutc": "2025-07-15T19:10:22.5491932+00:00" }
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.