Updates the work order with the specified key
Request Information
URI Parameters :
Name | Description | Type | Additional information |
---|---|---|---|
id | globally unique identifier |
Required |
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": "34731b5b-69bc-41ca-9fec-052c6d6358bc", "_parent_id": "12801bad-8d3c-482a-ad88-995e6cbb28cd", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "0bbd4b61-19ad-411a-87bd-4754b6e7cc06", "project_reference_back_office": "sample string 5", "project": { "id": "59451baa-aa88-41da-a48c-6b1e90d020ab", "_parent_id": "b7654645-15f7-4ee2-a1ef-db49aa52b14c", "root_parent_id": "f981ebdf-52b8-4106-9ec8-28120cedcd54", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "c8018168-24aa-4e84-9f1e-6fcb28d8eba9", "equipment_family_code": "sample string 6", "equipment_family": { "id": "8071fbcd-7120-423b-8291-e01428225c9b", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "34db21b7-0fe0-40f6-8b70-bccceed1356a", "_parent_code": "sample string 6", "sales_organization_id": "35e997e5-2a9c-430a-81cf-9b04622a5b5a", "sales_organization_code": "sample string 8", "sales_organization": { "id": "211e9d78-1e7f-4024-a389-ef2c46bc4b2a", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "a90ec9e5-a77d-4efc-a19f-28dd080c58f7", "db_currency_id": "a193cee0-caf6-4040-b045-9aacd6e9a318", "db_language_id": "3d63000f-32c5-41a6-8f39-193f6bfc84ae", "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-05T06:52:33.7977295+00:00" }, "modified_dateutc": "2025-10-05T06:52:33.7977295+00:00" }, "equipment_model_id": "1e584f96-a1d9-4cc1-9297-ce5b060861b0", "equipment_model_code": "sample string 8", "equipment_model": { "id": "0249e158-db71-4221-8b1d-510635b3fd3c", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "9ac5d5ef-4ab0-4b1c-ab8c-374fbfbb8055", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "04060042-068d-4190-b62e-f32ba5d84c5a", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "ea125055-2dc0-4457-b921-0b5670759db1", "sales_organization_code": "sample string 5", "sales_organization": { "id": "211e9d78-1e7f-4024-a389-ef2c46bc4b2a", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "a90ec9e5-a77d-4efc-a19f-28dd080c58f7", "db_currency_id": "a193cee0-caf6-4040-b045-9aacd6e9a318", "db_language_id": "3d63000f-32c5-41a6-8f39-193f6bfc84ae", "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-05T06:52:33.7977295+00:00" }, "modified_dateutc": "2025-10-05T06:52:33.7977295+00:00" }, "equipment_family_id": "141f5a79-c98e-4f96-bae5-f664e702820d", "equipment_family_code": "sample string 8", "equipment_family": { "id": "8071fbcd-7120-423b-8291-e01428225c9b", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "34db21b7-0fe0-40f6-8b70-bccceed1356a", "_parent_code": "sample string 6", "sales_organization_id": "35e997e5-2a9c-430a-81cf-9b04622a5b5a", "sales_organization_code": "sample string 8", "sales_organization": { "id": "211e9d78-1e7f-4024-a389-ef2c46bc4b2a", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "a90ec9e5-a77d-4efc-a19f-28dd080c58f7", "db_currency_id": "a193cee0-caf6-4040-b045-9aacd6e9a318", "db_language_id": "3d63000f-32c5-41a6-8f39-193f6bfc84ae", "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-05T06:52:33.7977295+00:00" }, "modified_dateutc": "2025-10-05T06:52:33.7977295+00:00" }, "date_in_production_since": "2025-10-05T06:52:33.7977295+00:00", "date_out_of_production_since": "2025-10-05T06:52:33.7977295+00:00", "date_end_support": "2025-10-05T06:52:33.7977295+00:00", "sales_organization_id": "5406f96e-47ab-4868-a47e-0c381924efe3", "sales_organization_code": "sample string 13", "sales_organization": { "id": "211e9d78-1e7f-4024-a389-ef2c46bc4b2a", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "a90ec9e5-a77d-4efc-a19f-28dd080c58f7", "db_currency_id": "a193cee0-caf6-4040-b045-9aacd6e9a318", "db_language_id": "3d63000f-32c5-41a6-8f39-193f6bfc84ae", "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-05T06:52:33.7977295+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-05T06:52:33.7977295+00:00" }, "project_status_id": "14126ea2-0d32-4170-93a8-935eee1703b7", "project_status_code": "sample string 10", "project_status": { "id": "e47fd39e-13ff-48c8-b537-9cb10b67bf5a", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "04ed6150-ff63-457c-9a46-41967cc6c7d6", "sales_organization_code": "sample string 6", "sales_organization": { "id": "211e9d78-1e7f-4024-a389-ef2c46bc4b2a", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "a90ec9e5-a77d-4efc-a19f-28dd080c58f7", "db_currency_id": "a193cee0-caf6-4040-b045-9aacd6e9a318", "db_language_id": "3d63000f-32c5-41a6-8f39-193f6bfc84ae", "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-05T06:52:33.7977295+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-10-05T06:52:33.7977295+00:00" }, "company_id": "5e6318d3-0fa9-436f-a899-b720b4c190d2", "company_code": "sample string 12", "db_address_id": "e478ffea-dc8a-42d7-b52e-1cff4449e17f", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "1df4470b-cf15-4dcf-82f3-766194a406c7", "contact_reference_back_office": "sample string 17", "owner_user_id": "b8272d2a-e900-41b6-82c9-c8e28f15b766", "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-05T06:52:33.7977295+00:00", "date_create": "2025-10-05T06:52:33.7977295+00:00", "date_update": "2025-10-05T06:52:33.7977295+00:00", "updated_by_user_id": "79481f27-627d-4a0c-8c30-6b178e78f9a4", "customer_reference": "sample string 28", "warranty_date_until": "2025-10-05T06:52:33.7977295+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-05T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-10-05T06:52:33.7977295+00:00", "date_last_job": "2025-10-05T06:52:33.7977295+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-10-05T06:52:33.7977295+00:00", "modified_dateutc": "2025-10-05T06:52:33.7977295+00:00", "is_mobile_installation": true }, "job_type_id": "99d38c2a-4c06-4c69-812f-c221a9e4aefd", "job_type_code": "sample string 7", "job_type": { "id": "1fccf3f6-1d3b-490a-8701-ceb21d344126", "name": "sample string 2", "sales_organization_id": "317cbe3c-a58e-4767-9017-2aa7bddd206c", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-10-05T06:52:33.7977295+00:00", "code": "sample string 7" }, "job_priority_id": "1ac8c370-0f4b-433e-9482-1837d3db8364", "job_priority_code": "sample string 9", "job_priority": { "id": "a8952ed8-31e2-4dd2-a009-eff82014f262", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "a64e935e-f5fc-40df-b1ae-c20ab37dd9ce", "sales_organization_code": "sample string 6", "sales_organization": { "id": "211e9d78-1e7f-4024-a389-ef2c46bc4b2a", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "a90ec9e5-a77d-4efc-a19f-28dd080c58f7", "db_currency_id": "a193cee0-caf6-4040-b045-9aacd6e9a318", "db_language_id": "3d63000f-32c5-41a6-8f39-193f6bfc84ae", "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-05T06:52:33.7977295+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-10-05T06:52:33.7977295+00:00" }, "job_status_id": "79658d60-e251-4177-bff9-2faad6eaa790", "job_status_code": "sample string 11", "db_address_id": "8db528f9-5c14-438d-8fd2-e5e884168467", "contact_id": "7832c95c-b97a-44d4-94af-e377e9c39f3d", "requested_by_company_id": "ec21aaf7-8a64-458a-9ba8-392f529fc4c6", "requested_by_contact_id": "d5a9e8ec-66be-4eef-b382-d694acf48a68", "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-05T06:52:33.7977295+00:00", "due_date": "2025-10-05T06:52:33.7977295+00:00", "date_create": "2025-10-05T06:52:33.7977295+00:00", "date_update": "2025-10-05T06:52:33.7977295+00:00", "date_closed": "2025-10-05T06:52:33.7977295+00:00", "suggested_user_id": "364d01fa-c95e-4dba-ae99-50aa2fa0dc3e", "suggested_user_code": "sample string 29", "suggested_user": { "id": "329f15e2-be0b-4310-ae4f-374c1fd900a6", "db_language_id": "cfdd61dd-4a65-4587-be9c-6e2f6b835918", "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-05T06:52:33.7977295+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "780cf6c1-b4b5-4cc4-bce7-7ee77aca15d8", "sales_organization": { "id": "211e9d78-1e7f-4024-a389-ef2c46bc4b2a", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "a90ec9e5-a77d-4efc-a19f-28dd080c58f7", "db_currency_id": "a193cee0-caf6-4040-b045-9aacd6e9a318", "db_language_id": "3d63000f-32c5-41a6-8f39-193f6bfc84ae", "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-05T06:52:33.7977295+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "e9a1ed0a-a245-4812-b5d5-4fecc7ba8ad6", "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": "6155eb72-1dc5-4a99-9c5c-fea3cd094637", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-10-05T06:52:33.7977295+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "2841a37f-3f75-4304-9dc8-9547ada189f4" }, "suggested_date_start": "2025-10-05T06:52:33.7977295+00:00", "skill_id": "7ec743f0-ec24-426b-b3b2-08e45fe7e528", "skill_code": "sample string 32", "skill": { "id": "f58a4a2a-2881-43c3-b675-6031acd7f178", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "7dfca946-e8d5-4769-afae-d1f0ef384bf4", "sales_organization_code": "sample string 6", "sales_organization": { "id": "211e9d78-1e7f-4024-a389-ef2c46bc4b2a", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "a90ec9e5-a77d-4efc-a19f-28dd080c58f7", "db_currency_id": "a193cee0-caf6-4040-b045-9aacd6e9a318", "db_language_id": "3d63000f-32c5-41a6-8f39-193f6bfc84ae", "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-05T06:52:33.7977295+00:00" }, "modified_dateutc": "2025-10-05T06:52:33.7977295+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "747e1a2b-9235-4208-84a5-1dd88c447724", "date_reported_by_company": "2025-10-05T06:52:33.7977295+00:00", "id2": 36, "company_id": "aa5cd2c8-3c2e-44c5-8660-98ee8f1824cd", "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": "edb4c539-e7c0-48ce-bb84-8deb9ed4ac14", "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-05T06:52:33.7977295+00:00" }
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.