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": "935b840e-8ec5-4275-ad19-eba7bbcd81c6", "_parent_id": "29a20ad0-7b02-42f9-aebb-0506c518d339", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "341d5b4e-9857-4c25-a9df-6a93f196e76e", "project_reference_back_office": "sample string 5", "project": { "id": "cf33be48-54c5-473a-a872-102eb0dda013", "_parent_id": "a84eeaa9-308c-49bb-bf72-94253ce054aa", "root_parent_id": "880b40f5-d84f-48b7-b2c7-17d6b1f93e9e", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "b486085a-a414-4e70-93ad-6f66d9c886d7", "equipment_family_code": "sample string 6", "equipment_family": { "id": "19ae64bf-6c85-4e53-8ea1-f933d4bc1e38", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "6b045877-e07d-4ee0-aebe-b5a3d4ff3406", "_parent_code": "sample string 6", "sales_organization_id": "9a552839-df97-42da-8c36-145c42477daf", "sales_organization_code": "sample string 8", "sales_organization": { "id": "a5f567d1-c427-4ae0-beb8-2fb23bb81c12", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "55e3b519-d126-4db8-8d64-278cbdbdf93b", "db_currency_id": "5f551dea-6a9b-4bf4-9c9f-8567ecdfd86a", "db_language_id": "73722404-7f16-4fa7-8b31-dd8b6ff936fe", "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-10-08T19:54:20.7463269+00:00" }, "modified_dateutc": "2025-10-08T19:54:20.7463269+00:00" }, "equipment_model_id": "e72348ff-f39a-40b2-a82a-40c49e6e4cab", "equipment_model_code": "sample string 8", "equipment_model": { "id": "a52cb3b9-1436-473b-89ce-ef8d8e992de3", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "a5ab312d-a09d-40f3-ab4c-ac288750e8c4", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "1bdb1449-d6f2-4676-9581-090a606dc1f5", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "9259981d-aa18-48a2-923e-6a1d39a28687", "sales_organization_code": "sample string 5", "sales_organization": { "id": "a5f567d1-c427-4ae0-beb8-2fb23bb81c12", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "55e3b519-d126-4db8-8d64-278cbdbdf93b", "db_currency_id": "5f551dea-6a9b-4bf4-9c9f-8567ecdfd86a", "db_language_id": "73722404-7f16-4fa7-8b31-dd8b6ff936fe", "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-10-08T19:54:20.7463269+00:00" }, "modified_dateutc": "2025-10-08T19:54:20.7463269+00:00" }, "equipment_family_id": "ac51bef5-cb1d-443c-a751-9e3709b5b29e", "equipment_family_code": "sample string 8", "equipment_family": { "id": "19ae64bf-6c85-4e53-8ea1-f933d4bc1e38", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "6b045877-e07d-4ee0-aebe-b5a3d4ff3406", "_parent_code": "sample string 6", "sales_organization_id": "9a552839-df97-42da-8c36-145c42477daf", "sales_organization_code": "sample string 8", "sales_organization": { "id": "a5f567d1-c427-4ae0-beb8-2fb23bb81c12", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "55e3b519-d126-4db8-8d64-278cbdbdf93b", "db_currency_id": "5f551dea-6a9b-4bf4-9c9f-8567ecdfd86a", "db_language_id": "73722404-7f16-4fa7-8b31-dd8b6ff936fe", "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-10-08T19:54:20.7463269+00:00" }, "modified_dateutc": "2025-10-08T19:54:20.7463269+00:00" }, "date_in_production_since": "2025-10-08T19:54:20.7463269+00:00", "date_out_of_production_since": "2025-10-08T19:54:20.7463269+00:00", "date_end_support": "2025-10-08T19:54:20.7463269+00:00", "sales_organization_id": "28f09c65-bd26-4062-9e6d-38e86432c169", "sales_organization_code": "sample string 13", "sales_organization": { "id": "a5f567d1-c427-4ae0-beb8-2fb23bb81c12", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "55e3b519-d126-4db8-8d64-278cbdbdf93b", "db_currency_id": "5f551dea-6a9b-4bf4-9c9f-8567ecdfd86a", "db_language_id": "73722404-7f16-4fa7-8b31-dd8b6ff936fe", "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-10-08T19:54:20.7463269+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-10-08T19:54:20.7463269+00:00" }, "project_status_id": "61b1a6ae-c843-4d86-9707-aa2282bfe6dd", "project_status_code": "sample string 10", "project_status": { "id": "006b12c1-4401-483c-b5d7-1780a4352290", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "0ec6d034-f3d4-4f4b-b4c9-7d1f80ed589f", "sales_organization_code": "sample string 6", "sales_organization": { "id": "a5f567d1-c427-4ae0-beb8-2fb23bb81c12", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "55e3b519-d126-4db8-8d64-278cbdbdf93b", "db_currency_id": "5f551dea-6a9b-4bf4-9c9f-8567ecdfd86a", "db_language_id": "73722404-7f16-4fa7-8b31-dd8b6ff936fe", "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-10-08T19:54:20.7463269+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-10-08T19:54:20.7463269+00:00" }, "company_id": "a2ffe840-ebe8-4e13-8182-deb3c381ff86", "company_code": "sample string 12", "db_address_id": "2f45e364-fe6b-4380-91c6-2e9496a1db94", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "aae98717-0c82-454a-a632-b7f1b6750019", "contact_reference_back_office": "sample string 17", "owner_user_id": "bfea6930-748b-4ce7-832e-d084a32db642", "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-10-08T19:54:20.7463269+00:00", "date_create": "2025-10-08T19:54:20.7463269+00:00", "date_update": "2025-10-08T19:54:20.7463269+00:00", "updated_by_user_id": "438e91f4-1ce5-4073-b310-df1d4ace27ee", "customer_reference": "sample string 28", "warranty_date_until": "2025-10-08T19:54:20.7463269+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-10-08T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-10-08T19:54:20.7463269+00:00", "date_last_job": "2025-10-08T19:54:20.7463269+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-10-08T19:54:20.7463269+00:00", "modified_dateutc": "2025-10-08T19:54:20.7463269+00:00", "is_mobile_installation": true }, "job_type_id": "2eace076-e8d6-4a0c-a4cd-6fd09cbfdc77", "job_type_code": "sample string 7", "job_type": { "id": "4d595fe8-7364-4b0d-a151-682ba5773dfe", "name": "sample string 2", "sales_organization_id": "52143cb3-51c3-4205-b7f5-dab15a45eed4", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-10-08T19:54:20.7463269+00:00", "code": "sample string 7" }, "job_priority_id": "39ec3a0c-f1e6-462e-b6dd-cf9559aa0b71", "job_priority_code": "sample string 9", "job_priority": { "id": "9011cb6c-b423-421d-be1e-1cf48bd7bd2b", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "8d11b425-f7cb-4ba8-b6e0-8839ec8a43b1", "sales_organization_code": "sample string 6", "sales_organization": { "id": "a5f567d1-c427-4ae0-beb8-2fb23bb81c12", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "55e3b519-d126-4db8-8d64-278cbdbdf93b", "db_currency_id": "5f551dea-6a9b-4bf4-9c9f-8567ecdfd86a", "db_language_id": "73722404-7f16-4fa7-8b31-dd8b6ff936fe", "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-10-08T19:54:20.7463269+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-10-08T19:54:20.7463269+00:00" }, "job_status_id": "35eb6726-79e8-4177-a8e6-c5baa40bd292", "job_status_code": "sample string 11", "db_address_id": "d4d44331-b0ac-474f-b972-184db6687109", "contact_id": "703b4971-7b30-4454-b6ab-073a795fdb97", "requested_by_company_id": "f3b37e7d-0ed4-4d88-86a1-aeb20bd6d7cb", "requested_by_contact_id": "98706eae-1f0e-4d72-b6c7-e1f7f556f2f1", "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-10-08T19:54:20.7463269+00:00", "due_date": "2025-10-08T19:54:20.7463269+00:00", "date_create": "2025-10-08T19:54:20.7463269+00:00", "date_update": "2025-10-08T19:54:20.7463269+00:00", "date_closed": "2025-10-08T19:54:20.7463269+00:00", "suggested_user_id": "b920414f-521c-4447-a4ee-fbd627054642", "suggested_user_code": "sample string 29", "suggested_user": { "id": "526a9e83-a2a0-41a9-8070-ccb3bbdca707", "db_language_id": "fde15449-293a-4544-aa86-d7f368c86f53", "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-10-08T19:54:20.7463269+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "329db673-4ff4-47d0-9592-4a36557df0d8", "sales_organization": { "id": "a5f567d1-c427-4ae0-beb8-2fb23bb81c12", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "55e3b519-d126-4db8-8d64-278cbdbdf93b", "db_currency_id": "5f551dea-6a9b-4bf4-9c9f-8567ecdfd86a", "db_language_id": "73722404-7f16-4fa7-8b31-dd8b6ff936fe", "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-10-08T19:54:20.7463269+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "2b3b0e7e-7c19-43bc-b8b4-b0635f236f1d", "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": "ad7d4872-8111-4518-9403-12449df82593", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-10-08T19:54:20.7463269+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "7aff6a18-3b00-4714-accc-1767183a81f7" }, "suggested_date_start": "2025-10-08T19:54:20.7463269+00:00", "skill_id": "eb9e534f-8464-4cc4-bec4-1d4692abe327", "skill_code": "sample string 32", "skill": { "id": "1ad8c8cf-fe0f-4fad-a944-18288d279b6e", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "cf40cf3a-0895-4f11-a3af-12f1fa25b367", "sales_organization_code": "sample string 6", "sales_organization": { "id": "a5f567d1-c427-4ae0-beb8-2fb23bb81c12", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "55e3b519-d126-4db8-8d64-278cbdbdf93b", "db_currency_id": "5f551dea-6a9b-4bf4-9c9f-8567ecdfd86a", "db_language_id": "73722404-7f16-4fa7-8b31-dd8b6ff936fe", "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-10-08T19:54:20.7463269+00:00" }, "modified_dateutc": "2025-10-08T19:54:20.7463269+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "fa4bb0fe-4ac7-4b6f-bdaf-d2bdedfd7c3e", "date_reported_by_company": "2025-10-08T19:54:20.7463269+00:00", "id2": 36, "company_id": "5fc4d200-68f2-47c4-b80d-b1783bf936bf", "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": "e159aa6d-5d3f-47d9-b915-fd21e66272ba", "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-10-08T19:54:20.7463269+00:00" }
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.