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": "5687fb38-467f-417c-9992-d6a68f1199df", "_parent_id": "fb770607-43ec-49f6-aef9-69bc4cb6dae2", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "9b9bf6af-75e0-46cd-a8c6-a0e99fe3f05c", "project_reference_back_office": "sample string 5", "project": { "id": "10fbc79d-7972-4abf-bcd0-d40c808c8926", "_parent_id": "0bbddd7e-1cc2-477b-b8f9-95e493d97832", "root_parent_id": "7be6a16d-0103-45e8-8cf6-44f49b165681", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "8d7999f1-7e60-4d50-9098-65eb40591fc0", "equipment_family_code": "sample string 6", "equipment_family": { "id": "b390fb71-39bc-46cc-ba43-e53100a98f82", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "98fce45c-aab3-4570-9b9f-7393a86bb247", "_parent_code": "sample string 6", "sales_organization_id": "cc5885d6-3000-445a-92a7-d2bda5e927c5", "sales_organization_code": "sample string 8", "sales_organization": { "id": "05ed3197-00ca-451d-a7cb-39f7ebef9ddb", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "d21fc523-8e6e-4c2d-a350-81dc083bd078", "db_currency_id": "19b1f2c0-7269-4e1f-9335-e81b5c7c27c8", "db_language_id": "8713fd48-cbf3-48d3-a44f-28a0b3755b39", "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-02T19:56:01.8262618+00:00" }, "modified_dateutc": "2025-10-02T19:56:01.8262618+00:00" }, "equipment_model_id": "93c7ad32-039f-455b-aab6-414d72db9984", "equipment_model_code": "sample string 8", "equipment_model": { "id": "7db21f02-78d4-437c-8b66-58d9576a08de", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "50f18d68-6af6-4c37-945d-7e2c09a51ae9", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "073e5fe5-d7aa-4014-81d2-bb889cc20c19", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "84f40989-32cd-4b3f-95a2-af14041ae819", "sales_organization_code": "sample string 5", "sales_organization": { "id": "05ed3197-00ca-451d-a7cb-39f7ebef9ddb", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "d21fc523-8e6e-4c2d-a350-81dc083bd078", "db_currency_id": "19b1f2c0-7269-4e1f-9335-e81b5c7c27c8", "db_language_id": "8713fd48-cbf3-48d3-a44f-28a0b3755b39", "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-02T19:56:01.8262618+00:00" }, "modified_dateutc": "2025-10-02T19:56:01.8262618+00:00" }, "equipment_family_id": "1f196d46-d09f-4c58-9634-962d39e28a3c", "equipment_family_code": "sample string 8", "equipment_family": { "id": "b390fb71-39bc-46cc-ba43-e53100a98f82", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "98fce45c-aab3-4570-9b9f-7393a86bb247", "_parent_code": "sample string 6", "sales_organization_id": "cc5885d6-3000-445a-92a7-d2bda5e927c5", "sales_organization_code": "sample string 8", "sales_organization": { "id": "05ed3197-00ca-451d-a7cb-39f7ebef9ddb", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "d21fc523-8e6e-4c2d-a350-81dc083bd078", "db_currency_id": "19b1f2c0-7269-4e1f-9335-e81b5c7c27c8", "db_language_id": "8713fd48-cbf3-48d3-a44f-28a0b3755b39", "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-02T19:56:01.8262618+00:00" }, "modified_dateutc": "2025-10-02T19:56:01.8262618+00:00" }, "date_in_production_since": "2025-10-02T19:56:01.8262618+00:00", "date_out_of_production_since": "2025-10-02T19:56:01.8262618+00:00", "date_end_support": "2025-10-02T19:56:01.8262618+00:00", "sales_organization_id": "390bb5c5-a25c-41f3-9b47-0bde488d967e", "sales_organization_code": "sample string 13", "sales_organization": { "id": "05ed3197-00ca-451d-a7cb-39f7ebef9ddb", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "d21fc523-8e6e-4c2d-a350-81dc083bd078", "db_currency_id": "19b1f2c0-7269-4e1f-9335-e81b5c7c27c8", "db_language_id": "8713fd48-cbf3-48d3-a44f-28a0b3755b39", "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-02T19:56:01.8262618+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-02T19:56:01.8262618+00:00" }, "project_status_id": "4f75d23f-54cf-455b-904d-add1fff12733", "project_status_code": "sample string 10", "project_status": { "id": "2e65de45-8558-4856-a8c0-1a2199158f17", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "9accf712-9919-4f73-85df-c39bf054d918", "sales_organization_code": "sample string 6", "sales_organization": { "id": "05ed3197-00ca-451d-a7cb-39f7ebef9ddb", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "d21fc523-8e6e-4c2d-a350-81dc083bd078", "db_currency_id": "19b1f2c0-7269-4e1f-9335-e81b5c7c27c8", "db_language_id": "8713fd48-cbf3-48d3-a44f-28a0b3755b39", "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-02T19:56:01.8262618+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-10-02T19:56:01.8262618+00:00" }, "company_id": "3e2b166d-6646-4cea-bde7-8d92670dbafa", "company_code": "sample string 12", "db_address_id": "c9967920-ba90-4530-8164-1e039a989541", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "9e7684dd-1c4b-4e58-9675-b4ff771378ef", "contact_reference_back_office": "sample string 17", "owner_user_id": "b8246176-051d-4361-b28a-ace652bb530c", "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-02T19:56:01.8262618+00:00", "date_create": "2025-10-02T19:56:01.8262618+00:00", "date_update": "2025-10-02T19:56:01.8262618+00:00", "updated_by_user_id": "789aae3f-a53b-4609-94a9-bc26eeb3c1ea", "customer_reference": "sample string 28", "warranty_date_until": "2025-10-02T19:56:01.8262618+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-02T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-10-02T19:56:01.8262618+00:00", "date_last_job": "2025-10-02T19:56:01.8262618+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-10-02T19:56:01.8262618+00:00", "modified_dateutc": "2025-10-02T19:56:01.8262618+00:00", "is_mobile_installation": true }, "job_type_id": "11277f32-0073-47f1-8583-139652bef3d7", "job_type_code": "sample string 7", "job_type": { "id": "8c2b1f6c-2760-40ec-8b31-390e3b8a804b", "name": "sample string 2", "sales_organization_id": "44106adf-fa9e-4e00-b4b3-5d7b658be2df", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-10-02T19:56:01.8262618+00:00", "code": "sample string 7" }, "job_priority_id": "cf066a29-8837-415b-93d4-e26195c9cdca", "job_priority_code": "sample string 9", "job_priority": { "id": "01205226-9e36-4e20-a9d6-ecdc0d2aa9a5", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "64049752-5912-4416-b50f-0e8fabf8f763", "sales_organization_code": "sample string 6", "sales_organization": { "id": "05ed3197-00ca-451d-a7cb-39f7ebef9ddb", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "d21fc523-8e6e-4c2d-a350-81dc083bd078", "db_currency_id": "19b1f2c0-7269-4e1f-9335-e81b5c7c27c8", "db_language_id": "8713fd48-cbf3-48d3-a44f-28a0b3755b39", "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-02T19:56:01.8262618+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-10-02T19:56:01.8262618+00:00" }, "job_status_id": "1d9e5df5-8963-4508-8353-9288d3001c55", "job_status_code": "sample string 11", "db_address_id": "cfe19946-9623-4339-b36b-561417d4b9af", "contact_id": "cd757616-bf63-4959-83df-6f2990f85b9f", "requested_by_company_id": "b62bf8ab-2d04-46cd-90f3-57f6e0c82cb6", "requested_by_contact_id": "8d67c741-0df7-4f6c-814c-517a1bf475d6", "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-02T19:56:01.8262618+00:00", "due_date": "2025-10-02T19:56:01.8262618+00:00", "date_create": "2025-10-02T19:56:01.8262618+00:00", "date_update": "2025-10-02T19:56:01.8262618+00:00", "date_closed": "2025-10-02T19:56:01.8262618+00:00", "suggested_user_id": "daa557fc-4735-4173-80d7-239eecbfb07b", "suggested_user_code": "sample string 29", "suggested_user": { "id": "8176ee0f-8d92-412d-b59d-e231eb6395f3", "db_language_id": "a5375dc3-e3be-4f9d-997b-3f07f6e5cb30", "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-02T19:56:01.8262618+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "955cfc91-24d7-486e-88b9-cfbb0682a8b6", "sales_organization": { "id": "05ed3197-00ca-451d-a7cb-39f7ebef9ddb", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "d21fc523-8e6e-4c2d-a350-81dc083bd078", "db_currency_id": "19b1f2c0-7269-4e1f-9335-e81b5c7c27c8", "db_language_id": "8713fd48-cbf3-48d3-a44f-28a0b3755b39", "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-02T19:56:01.8262618+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "fb34a46c-c588-4a78-8e0f-6be76a795de3", "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": "9c412d6e-3b00-4a30-acad-c7a1224336ab", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-10-02T19:56:01.8262618+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "37c70912-c882-4e98-b3de-e0105d8cfa2c" }, "suggested_date_start": "2025-10-02T19:56:01.8262618+00:00", "skill_id": "55160b37-d55a-4b8a-a175-252f337457ee", "skill_code": "sample string 32", "skill": { "id": "7f902023-26a2-4669-9a01-9657c6b8fada", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "7afe7023-ebe7-4098-8eae-ab7e7a66910d", "sales_organization_code": "sample string 6", "sales_organization": { "id": "05ed3197-00ca-451d-a7cb-39f7ebef9ddb", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "d21fc523-8e6e-4c2d-a350-81dc083bd078", "db_currency_id": "19b1f2c0-7269-4e1f-9335-e81b5c7c27c8", "db_language_id": "8713fd48-cbf3-48d3-a44f-28a0b3755b39", "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-02T19:56:01.8262618+00:00" }, "modified_dateutc": "2025-10-02T19:56:01.8262618+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "c76d041c-a1ea-4664-a589-add17c5e9acb", "date_reported_by_company": "2025-10-02T19:56:01.8262618+00:00", "id2": 36, "company_id": "8def838f-cf0d-4dd2-9b37-76ccf5e2d5c5", "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": "10c5233c-b69c-49d9-af51-078b57bed9c8", "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-02T19:56:01.8262618+00:00" }
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.