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": "de447249-36d3-4c28-b7de-3635af5db910", "_parent_id": "1b628041-a2ec-457d-8159-c5c701bc1f62", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "2adb103a-6fa1-418d-9ca5-71eccbe2ef57", "project_reference_back_office": "sample string 5", "project": { "id": "93cd2e8a-1c70-41b8-bee0-ddf0d8000a46", "_parent_id": "ac16532a-5819-4cd8-b1b2-cb677ffeedb1", "root_parent_id": "db2d3f63-ed18-4878-9b68-96e83de4943e", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "910c3a7d-3e63-4d4e-9c68-6b182893731b", "equipment_family_code": "sample string 6", "equipment_family": { "id": "2dc665ed-a134-4a88-aebc-154130e3379a", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "accd300a-25f2-4b6e-9db7-5f686efdfd7c", "_parent_code": "sample string 6", "sales_organization_id": "8b49748a-a32d-4ccd-ac5d-36c83cc6dfa0", "sales_organization_code": "sample string 8", "sales_organization": { "id": "07d7f137-af80-418a-927e-0721a2ba58ba", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "1d8c1539-627c-4333-a35d-8b2caab6908d", "db_currency_id": "c6cf0131-a908-42da-b4d7-ed1725d85c18", "db_language_id": "e9b8d2da-d303-4530-aca4-59f1d19d7235", "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-06-27T23:13:53.5622132+00:00" }, "modified_dateutc": "2025-06-27T23:13:53.5622132+00:00" }, "equipment_model_id": "b6d569cc-6f63-4dba-9d2c-d893d7528860", "equipment_model_code": "sample string 8", "equipment_model": { "id": "db8ac703-20d3-4367-b140-145fa7efd942", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "52ff0238-934d-4038-9669-07eca7f6a9df", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "801f96f0-a358-4138-99ed-4bcc8f2be50e", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "806ed71d-fbae-4313-a063-cb7aedf7a4b4", "sales_organization_code": "sample string 5", "sales_organization": { "id": "07d7f137-af80-418a-927e-0721a2ba58ba", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "1d8c1539-627c-4333-a35d-8b2caab6908d", "db_currency_id": "c6cf0131-a908-42da-b4d7-ed1725d85c18", "db_language_id": "e9b8d2da-d303-4530-aca4-59f1d19d7235", "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-06-27T23:13:53.5622132+00:00" }, "modified_dateutc": "2025-06-27T23:13:53.5622132+00:00" }, "equipment_family_id": "e1e35b82-652d-4456-a03d-7d3d59cc3df0", "equipment_family_code": "sample string 8", "equipment_family": { "id": "2dc665ed-a134-4a88-aebc-154130e3379a", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "accd300a-25f2-4b6e-9db7-5f686efdfd7c", "_parent_code": "sample string 6", "sales_organization_id": "8b49748a-a32d-4ccd-ac5d-36c83cc6dfa0", "sales_organization_code": "sample string 8", "sales_organization": { "id": "07d7f137-af80-418a-927e-0721a2ba58ba", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "1d8c1539-627c-4333-a35d-8b2caab6908d", "db_currency_id": "c6cf0131-a908-42da-b4d7-ed1725d85c18", "db_language_id": "e9b8d2da-d303-4530-aca4-59f1d19d7235", "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-06-27T23:13:53.5622132+00:00" }, "modified_dateutc": "2025-06-27T23:13:53.5622132+00:00" }, "date_in_production_since": "2025-06-27T23:13:53.5622132+00:00", "date_out_of_production_since": "2025-06-27T23:13:53.5622132+00:00", "date_end_support": "2025-06-27T23:13:53.5622132+00:00", "sales_organization_id": "6848c2ec-c534-4af9-bf78-61e39930da97", "sales_organization_code": "sample string 13", "sales_organization": { "id": "07d7f137-af80-418a-927e-0721a2ba58ba", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "1d8c1539-627c-4333-a35d-8b2caab6908d", "db_currency_id": "c6cf0131-a908-42da-b4d7-ed1725d85c18", "db_language_id": "e9b8d2da-d303-4530-aca4-59f1d19d7235", "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-06-27T23:13:53.5622132+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-06-27T23:13:53.5622132+00:00" }, "project_status_id": "f37d0bb4-d418-4e9c-9a32-5ac4589cf601", "project_status_code": "sample string 10", "project_status": { "id": "3ff84b24-74b6-43d0-a393-a1041721742b", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "421cb4ce-d73f-4f80-bc0e-44338d2a8531", "sales_organization_code": "sample string 6", "sales_organization": { "id": "07d7f137-af80-418a-927e-0721a2ba58ba", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "1d8c1539-627c-4333-a35d-8b2caab6908d", "db_currency_id": "c6cf0131-a908-42da-b4d7-ed1725d85c18", "db_language_id": "e9b8d2da-d303-4530-aca4-59f1d19d7235", "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-06-27T23:13:53.5622132+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-06-27T23:13:53.5622132+00:00" }, "company_id": "59292c25-b3e3-45b2-9e21-e287e7eefaec", "company_code": "sample string 12", "db_address_id": "8cc4ba16-b249-4664-a1c5-0cc931a1d21a", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "03da53ae-e496-4116-a24d-52efe7a321e3", "contact_reference_back_office": "sample string 17", "owner_user_id": "0c4dac41-d7b0-4f4e-8271-b61830c196ee", "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-06-27T23:13:53.5622132+00:00", "date_create": "2025-06-27T23:13:53.5622132+00:00", "date_update": "2025-06-27T23:13:53.5622132+00:00", "updated_by_user_id": "e5334ee2-4f6a-4464-92e3-a7b136beb590", "customer_reference": "sample string 28", "warranty_date_until": "2025-06-27T23:13:53.5622132+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-06-27T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-06-27T23:13:53.5622132+00:00", "date_last_job": "2025-06-27T23:13:53.5622132+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-06-27T23:13:53.5622132+00:00", "modified_dateutc": "2025-06-27T23:13:53.5622132+00:00", "is_mobile_installation": true }, "job_type_id": "cee8962e-ba57-4937-861d-185f78f84547", "job_type_code": "sample string 7", "job_type": { "id": "34ef665f-2764-4522-a07c-c089e13bb0e6", "name": "sample string 2", "sales_organization_id": "3ef3648b-1e3a-4d52-82c4-efbbac1b7eb3", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-06-27T23:13:53.5622132+00:00", "code": "sample string 7" }, "job_priority_id": "9b9cbc1e-6ec6-435f-83b1-9b3e05f32541", "job_priority_code": "sample string 9", "job_priority": { "id": "078cce43-ba67-4392-828e-78640a16430c", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "2c658d3a-6b25-4106-91ba-b51b52afd90a", "sales_organization_code": "sample string 6", "sales_organization": { "id": "07d7f137-af80-418a-927e-0721a2ba58ba", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "1d8c1539-627c-4333-a35d-8b2caab6908d", "db_currency_id": "c6cf0131-a908-42da-b4d7-ed1725d85c18", "db_language_id": "e9b8d2da-d303-4530-aca4-59f1d19d7235", "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-06-27T23:13:53.5622132+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-06-27T23:13:53.5622132+00:00" }, "job_status_id": "45239663-5699-4ca5-8e0d-607eb8efe06a", "job_status_code": "sample string 11", "db_address_id": "37eb4714-d825-4704-83dc-eecdba75f827", "contact_id": "890efeb0-1a65-46df-9389-6a2d72c71272", "requested_by_company_id": "347ef71f-b3b7-433f-99c2-2af78d964784", "requested_by_contact_id": "9b21af4f-a12c-4d0f-ae1e-96c8b8a03097", "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-06-27T23:13:53.5622132+00:00", "due_date": "2025-06-27T23:13:53.5622132+00:00", "date_create": "2025-06-27T23:13:53.5622132+00:00", "date_update": "2025-06-27T23:13:53.5622132+00:00", "date_closed": "2025-06-27T23:13:53.5622132+00:00", "suggested_user_id": "4a331df4-d833-42fb-a4aa-198054b31d7e", "suggested_user_code": "sample string 29", "suggested_user": { "id": "6ce64758-3158-40a1-a479-dbbdec7e8841", "db_language_id": "71642815-0a40-4faf-9460-f74cdfb4f668", "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-06-27T23:13:53.5622132+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "9ebafc62-ca14-462a-a7fa-8e152c2203b2", "sales_organization": { "id": "07d7f137-af80-418a-927e-0721a2ba58ba", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "1d8c1539-627c-4333-a35d-8b2caab6908d", "db_currency_id": "c6cf0131-a908-42da-b4d7-ed1725d85c18", "db_language_id": "e9b8d2da-d303-4530-aca4-59f1d19d7235", "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-06-27T23:13:53.5622132+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "f80f5b82-45b6-41b7-9a97-818a30055d01", "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": "544ec19f-1d1f-4a2f-b80d-b6e422df1f5a", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-06-27T23:13:53.5622132+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "2b4f70d2-4cd4-430b-9448-96e86c0f76c7" }, "suggested_date_start": "2025-06-27T23:13:53.5622132+00:00", "skill_id": "fd85b1c6-00eb-499e-9df7-4f03ab10882b", "skill_code": "sample string 32", "skill": { "id": "a82a625c-4022-45ee-8e72-941a7a05472e", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "675c2cfd-ec2b-437a-86eb-db8ba2664ef7", "sales_organization_code": "sample string 6", "sales_organization": { "id": "07d7f137-af80-418a-927e-0721a2ba58ba", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "1d8c1539-627c-4333-a35d-8b2caab6908d", "db_currency_id": "c6cf0131-a908-42da-b4d7-ed1725d85c18", "db_language_id": "e9b8d2da-d303-4530-aca4-59f1d19d7235", "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-06-27T23:13:53.5622132+00:00" }, "modified_dateutc": "2025-06-27T23:13:53.5622132+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "059ee2d8-2534-4af0-bbbe-51c3e4ee49d3", "date_reported_by_company": "2025-06-27T23:13:53.5622132+00:00", "id2": 36, "company_id": "df053daf-b308-4bc7-946c-d72706f7e5f5", "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": "8c29efbd-3e5a-421c-b16e-3cdb43f01f52", "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-06-27T23:13:53.5622132+00:00" }
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.