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": "e748b1b1-aa15-4063-922d-5295b4f7f649", "_parent_id": "52536b33-1637-44e1-9743-f323e64f22bb", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "3ee7ea16-9693-406c-ae50-77c912d3c7d8", "project_reference_back_office": "sample string 5", "project": { "id": "ac421eec-3033-465d-98d6-9cc53cf984bb", "_parent_id": "4d12960e-296e-47d4-be39-0ff9f1430dc3", "root_parent_id": "14057cbc-ff64-4f6f-88ca-53971ff8cbf5", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "2ce87e38-98a8-4537-ae13-da3538dcf657", "equipment_family_code": "sample string 6", "equipment_family": { "id": "89ca39c9-65d4-45e9-a06e-6e91bad2aa82", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "39c79b78-f9d1-4a23-b925-3c7cda42d1d7", "_parent_code": "sample string 6", "sales_organization_id": "321164a1-19eb-4737-be0b-19c67dd6f7b0", "sales_organization_code": "sample string 8", "sales_organization": { "id": "0e31c45c-ba96-420f-8122-e88bf8d11f87", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "2c719569-d73f-4d5a-b032-582401ac367a", "db_currency_id": "045bf9b4-bea1-4cf2-ad64-00a6399e804d", "db_language_id": "70102d17-32bd-4289-9655-700fc307e55a", "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-05-16T16:52:16.7778032+00:00" }, "modified_dateutc": "2025-05-16T16:52:16.7778032+00:00" }, "equipment_model_id": "789e3172-47ad-4036-b641-1836ae317fcb", "equipment_model_code": "sample string 8", "equipment_model": { "id": "7376ee07-7148-4e25-aa7d-8e101e93c912", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "aa31ee7b-0464-413f-93a8-4eb499115eb0", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "afeccb7d-9d7e-489d-8700-204ebe9b0ac2", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "f184bfb1-dcc7-4c66-a74f-533f1d074b46", "sales_organization_code": "sample string 5", "sales_organization": { "id": "0e31c45c-ba96-420f-8122-e88bf8d11f87", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "2c719569-d73f-4d5a-b032-582401ac367a", "db_currency_id": "045bf9b4-bea1-4cf2-ad64-00a6399e804d", "db_language_id": "70102d17-32bd-4289-9655-700fc307e55a", "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-05-16T16:52:16.7778032+00:00" }, "modified_dateutc": "2025-05-16T16:52:16.7778032+00:00" }, "equipment_family_id": "3e4f053d-61bb-4cf5-bfee-f7fa08ccf073", "equipment_family_code": "sample string 8", "equipment_family": { "id": "89ca39c9-65d4-45e9-a06e-6e91bad2aa82", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "39c79b78-f9d1-4a23-b925-3c7cda42d1d7", "_parent_code": "sample string 6", "sales_organization_id": "321164a1-19eb-4737-be0b-19c67dd6f7b0", "sales_organization_code": "sample string 8", "sales_organization": { "id": "0e31c45c-ba96-420f-8122-e88bf8d11f87", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "2c719569-d73f-4d5a-b032-582401ac367a", "db_currency_id": "045bf9b4-bea1-4cf2-ad64-00a6399e804d", "db_language_id": "70102d17-32bd-4289-9655-700fc307e55a", "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-05-16T16:52:16.7778032+00:00" }, "modified_dateutc": "2025-05-16T16:52:16.7778032+00:00" }, "date_in_production_since": "2025-05-16T16:52:16.7778032+00:00", "date_out_of_production_since": "2025-05-16T16:52:16.7778032+00:00", "date_end_support": "2025-05-16T16:52:16.7778032+00:00", "sales_organization_id": "88fef3c7-68e9-4e0e-8112-e74e0f9385de", "sales_organization_code": "sample string 13", "sales_organization": { "id": "0e31c45c-ba96-420f-8122-e88bf8d11f87", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "2c719569-d73f-4d5a-b032-582401ac367a", "db_currency_id": "045bf9b4-bea1-4cf2-ad64-00a6399e804d", "db_language_id": "70102d17-32bd-4289-9655-700fc307e55a", "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-05-16T16:52:16.7778032+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-05-16T16:52:16.7778032+00:00" }, "project_status_id": "313b6e69-d712-4292-9ec9-061ced7d9451", "project_status_code": "sample string 10", "project_status": { "id": "bc5f8f9c-642d-4af8-9140-559952801ccc", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "4ef01246-6c07-4205-abe4-c30d57cde91e", "sales_organization_code": "sample string 6", "sales_organization": { "id": "0e31c45c-ba96-420f-8122-e88bf8d11f87", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "2c719569-d73f-4d5a-b032-582401ac367a", "db_currency_id": "045bf9b4-bea1-4cf2-ad64-00a6399e804d", "db_language_id": "70102d17-32bd-4289-9655-700fc307e55a", "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-05-16T16:52:16.7778032+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-05-16T16:52:16.7778032+00:00" }, "company_id": "6aecc148-dec2-441c-9d7e-c5aac81fd6d4", "company_code": "sample string 12", "db_address_id": "03445e16-3a79-49bf-b8be-4fafb20c3fb0", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "fd8b461d-c1ef-48a2-aa79-f2dffd5be4b5", "contact_reference_back_office": "sample string 17", "owner_user_id": "54a5d1bd-d7f0-4376-a88a-429387e9d1c3", "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-05-16T16:52:16.7778032+00:00", "date_create": "2025-05-16T16:52:16.7778032+00:00", "date_update": "2025-05-16T16:52:16.7778032+00:00", "updated_by_user_id": "80641df0-8038-468f-ba05-16604da22630", "customer_reference": "sample string 28", "warranty_date_until": "2025-05-16T16:52:16.7778032+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-05-16T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-05-16T16:52:16.7778032+00:00", "date_last_job": "2025-05-16T16:52:16.7778032+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-05-16T16:52:16.7778032+00:00", "modified_dateutc": "2025-05-16T16:52:16.7778032+00:00", "is_mobile_installation": true }, "job_type_id": "a41f3b7f-25e9-454a-abd9-79869a12815c", "job_type_code": "sample string 7", "job_type": { "id": "6d103537-7abf-456a-b42d-fac716dd3c23", "name": "sample string 2", "sales_organization_id": "a1b275d4-8472-4aac-9094-c8248694959e", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-05-16T16:52:16.7778032+00:00", "code": "sample string 7" }, "job_priority_id": "301c03d7-af34-4289-9498-110299bd85fe", "job_priority_code": "sample string 9", "job_priority": { "id": "28f54591-63b3-466a-9a66-f3a4bb493377", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "26dbbd79-e2bb-4a1b-9125-d78877165fbc", "sales_organization_code": "sample string 6", "sales_organization": { "id": "0e31c45c-ba96-420f-8122-e88bf8d11f87", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "2c719569-d73f-4d5a-b032-582401ac367a", "db_currency_id": "045bf9b4-bea1-4cf2-ad64-00a6399e804d", "db_language_id": "70102d17-32bd-4289-9655-700fc307e55a", "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-05-16T16:52:16.7778032+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-05-16T16:52:16.7778032+00:00" }, "job_status_id": "2942f30b-b3c2-4325-98ab-6efcb34a01b1", "job_status_code": "sample string 11", "db_address_id": "2abaa9e0-8307-42de-a63b-6ebac8432b18", "contact_id": "c33e4772-f0a2-4a71-b3e7-3f81fe229dd7", "requested_by_company_id": "a864f479-12fa-49b7-9868-71dcf3d87a47", "requested_by_contact_id": "35844869-ffb9-46da-b8c0-214dbf8e4e56", "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-05-16T16:52:16.7778032+00:00", "due_date": "2025-05-16T16:52:16.7778032+00:00", "date_create": "2025-05-16T16:52:16.7778032+00:00", "date_update": "2025-05-16T16:52:16.7778032+00:00", "date_closed": "2025-05-16T16:52:16.7778032+00:00", "suggested_user_id": "8ed782a5-5ac2-4186-9321-f77cc492dce7", "suggested_user_code": "sample string 29", "suggested_user": { "id": "b01de7fc-c662-4c29-acd1-3ce249a36175", "db_language_id": "92517705-f78f-4be3-98d2-7d6b65c82a58", "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-05-16T16:52:16.7778032+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "170efcdb-136c-4101-8182-0a99cefe4eb0", "sales_organization": { "id": "0e31c45c-ba96-420f-8122-e88bf8d11f87", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "2c719569-d73f-4d5a-b032-582401ac367a", "db_currency_id": "045bf9b4-bea1-4cf2-ad64-00a6399e804d", "db_language_id": "70102d17-32bd-4289-9655-700fc307e55a", "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-05-16T16:52:16.7778032+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "a1ebccab-521b-4723-8c27-0eb35de6e39d", "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": "977683c9-5d6c-448d-ad47-622178aba3a9", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-05-16T16:52:16.7778032+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "a53da80d-38e9-4a74-8145-a47d8e3043da" }, "suggested_date_start": "2025-05-16T16:52:16.7778032+00:00", "skill_id": "07341bc0-962c-4759-98d1-d0fda4ff8bb2", "skill_code": "sample string 32", "skill": { "id": "a63c4f9f-cb4b-40f4-b947-eb65a1922d5e", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "e23479e7-f35c-4792-83c5-a1bd43a76d69", "sales_organization_code": "sample string 6", "sales_organization": { "id": "0e31c45c-ba96-420f-8122-e88bf8d11f87", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "2c719569-d73f-4d5a-b032-582401ac367a", "db_currency_id": "045bf9b4-bea1-4cf2-ad64-00a6399e804d", "db_language_id": "70102d17-32bd-4289-9655-700fc307e55a", "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-05-16T16:52:16.7778032+00:00" }, "modified_dateutc": "2025-05-16T16:52:16.7778032+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "32cd5f7a-f962-40f5-8bde-0b418cf1e2f8", "date_reported_by_company": "2025-05-16T16:52:16.7778032+00:00", "id2": 36, "company_id": "ad1c0a19-05af-4853-a9f6-4707eec38719", "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": "be992687-1ad9-4e37-a395-780234484414", "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-05-16T16:52:16.7778032+00:00" }
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.