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": "8b0b9802-d4a1-4102-adfa-c1580dcf3558", "_parent_id": "47c66143-0090-41fe-96bd-2088c415f9bf", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "232adc13-8d36-4d3f-aaa3-bb66070b5e2b", "project_reference_back_office": "sample string 5", "project": { "id": "c087bae9-4f72-4bcb-bb1e-7f11235916f1", "_parent_id": "eec83c6c-74f0-442e-9e3b-dd943f03c0ee", "root_parent_id": "994a55c7-8078-4697-9e50-a07fc2efd5f0", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "70ba27bf-bb93-46ef-bcf3-e46e3e7ac025", "equipment_family_code": "sample string 6", "equipment_family": { "id": "dd751bc4-7ba8-4c57-9cd5-03fed314ac46", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "a54c9acb-fa1c-41de-b609-1502cec684ea", "_parent_code": "sample string 6", "sales_organization_id": "597151ef-fb6e-47a3-880c-52aa86a03bea", "sales_organization_code": "sample string 8", "sales_organization": { "id": "61b9aa22-0034-4cc3-b75f-afaaeb109351", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "3fd6a1eb-5fac-4f4d-89a1-c9180e5454df", "db_currency_id": "6fe8fe44-55c2-44f7-8535-70c742da879f", "db_language_id": "43db067b-1c48-49a7-8524-6d7d2bdf930b", "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-09-17T06:20:29.3892528+00:00" }, "modified_dateutc": "2025-09-17T06:20:29.3892528+00:00" }, "equipment_model_id": "b728e873-0618-4a86-bd4b-015e864f874d", "equipment_model_code": "sample string 8", "equipment_model": { "id": "fb808c14-0703-4c34-8912-43f9004872be", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "cf3de3e5-3a01-4723-812c-36983682c6ad", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "cc5e4b50-07e6-405c-806e-ae073d03b0fb", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "1081f5b7-e528-473a-bd71-56a98c389744", "sales_organization_code": "sample string 5", "sales_organization": { "id": "61b9aa22-0034-4cc3-b75f-afaaeb109351", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "3fd6a1eb-5fac-4f4d-89a1-c9180e5454df", "db_currency_id": "6fe8fe44-55c2-44f7-8535-70c742da879f", "db_language_id": "43db067b-1c48-49a7-8524-6d7d2bdf930b", "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-09-17T06:20:29.3892528+00:00" }, "modified_dateutc": "2025-09-17T06:20:29.4043797+00:00" }, "equipment_family_id": "d1ce75aa-0153-4357-a4d1-ced1aae2bae7", "equipment_family_code": "sample string 8", "equipment_family": { "id": "dd751bc4-7ba8-4c57-9cd5-03fed314ac46", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "a54c9acb-fa1c-41de-b609-1502cec684ea", "_parent_code": "sample string 6", "sales_organization_id": "597151ef-fb6e-47a3-880c-52aa86a03bea", "sales_organization_code": "sample string 8", "sales_organization": { "id": "61b9aa22-0034-4cc3-b75f-afaaeb109351", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "3fd6a1eb-5fac-4f4d-89a1-c9180e5454df", "db_currency_id": "6fe8fe44-55c2-44f7-8535-70c742da879f", "db_language_id": "43db067b-1c48-49a7-8524-6d7d2bdf930b", "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-09-17T06:20:29.3892528+00:00" }, "modified_dateutc": "2025-09-17T06:20:29.3892528+00:00" }, "date_in_production_since": "2025-09-17T06:20:29.4043797+00:00", "date_out_of_production_since": "2025-09-17T06:20:29.4043797+00:00", "date_end_support": "2025-09-17T06:20:29.4043797+00:00", "sales_organization_id": "c25c8933-657d-44bb-a977-0c1ed892f341", "sales_organization_code": "sample string 13", "sales_organization": { "id": "61b9aa22-0034-4cc3-b75f-afaaeb109351", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "3fd6a1eb-5fac-4f4d-89a1-c9180e5454df", "db_currency_id": "6fe8fe44-55c2-44f7-8535-70c742da879f", "db_language_id": "43db067b-1c48-49a7-8524-6d7d2bdf930b", "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-09-17T06:20:29.3892528+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-09-17T06:20:29.4043797+00:00" }, "project_status_id": "678e62b3-6d35-4bf4-9b4d-a237d095a384", "project_status_code": "sample string 10", "project_status": { "id": "ad479a61-9ddc-4266-b574-c7d3d2452909", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "00b8a6fb-fdc4-4f51-9c6e-3dbdf656efdf", "sales_organization_code": "sample string 6", "sales_organization": { "id": "61b9aa22-0034-4cc3-b75f-afaaeb109351", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "3fd6a1eb-5fac-4f4d-89a1-c9180e5454df", "db_currency_id": "6fe8fe44-55c2-44f7-8535-70c742da879f", "db_language_id": "43db067b-1c48-49a7-8524-6d7d2bdf930b", "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-09-17T06:20:29.3892528+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-09-17T06:20:29.4043797+00:00" }, "company_id": "3620ff05-6b13-40a1-b0f1-4e1c6a9bad3c", "company_code": "sample string 12", "db_address_id": "e87eaf42-23e8-4b09-ab48-92f7eee68278", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "2223c364-e036-43ad-b2b9-d633eedacf78", "contact_reference_back_office": "sample string 17", "owner_user_id": "75472b7e-d121-429f-a6dc-4d375daf1e7c", "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-09-17T06:20:29.4043797+00:00", "date_create": "2025-09-17T06:20:29.4043797+00:00", "date_update": "2025-09-17T06:20:29.4043797+00:00", "updated_by_user_id": "8f188152-b193-4bf8-80bd-a04f0d8fb775", "customer_reference": "sample string 28", "warranty_date_until": "2025-09-17T06:20:29.4043797+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-09-17T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-09-17T06:20:29.4043797+00:00", "date_last_job": "2025-09-17T06:20:29.4043797+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-09-17T06:20:29.4043797+00:00", "modified_dateutc": "2025-09-17T06:20:29.4043797+00:00", "is_mobile_installation": true }, "job_type_id": "d773c05d-6fb8-4dac-9eb0-c688f414416a", "job_type_code": "sample string 7", "job_type": { "id": "a30fbc15-3963-4479-84d9-cbb8bbf65332", "name": "sample string 2", "sales_organization_id": "89b60fab-f3ba-4ca5-ab23-5fab491e92c4", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-09-17T06:20:29.4043797+00:00", "code": "sample string 7" }, "job_priority_id": "0dbc3552-8532-41cf-9d55-483e3b8075c8", "job_priority_code": "sample string 9", "job_priority": { "id": "d30a8e4c-1797-4e91-8a73-bda0252d2f8b", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "e6628f9a-fcbc-40cf-9355-bf272e73cb8a", "sales_organization_code": "sample string 6", "sales_organization": { "id": "61b9aa22-0034-4cc3-b75f-afaaeb109351", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "3fd6a1eb-5fac-4f4d-89a1-c9180e5454df", "db_currency_id": "6fe8fe44-55c2-44f7-8535-70c742da879f", "db_language_id": "43db067b-1c48-49a7-8524-6d7d2bdf930b", "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-09-17T06:20:29.3892528+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-09-17T06:20:29.4043797+00:00" }, "job_status_id": "9375d7a4-22af-488b-aea6-fdecd5f4a311", "job_status_code": "sample string 11", "db_address_id": "4289c139-cb6a-43df-aa95-dafd5377e9dd", "contact_id": "decde6af-5f3e-41f5-a539-ee7a3bc0e390", "requested_by_company_id": "27133476-c260-40d2-b6cd-64d552e01c70", "requested_by_contact_id": "a45efe3e-5fb9-4d39-a16d-1d6d607abeb0", "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-09-17T06:20:29.4043797+00:00", "due_date": "2025-09-17T06:20:29.4043797+00:00", "date_create": "2025-09-17T06:20:29.4043797+00:00", "date_update": "2025-09-17T06:20:29.4043797+00:00", "date_closed": "2025-09-17T06:20:29.4043797+00:00", "suggested_user_id": "62867d3b-5b6a-4402-9278-ce83e4bb5336", "suggested_user_code": "sample string 29", "suggested_user": { "id": "ea8d107e-b999-4fd6-bc09-29983911cac1", "db_language_id": "ca1712de-44d6-415b-a9bc-fc0330bb2f05", "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-09-17T06:20:29.4043797+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "a36bfaac-50ac-4011-8a23-27ceb822cbab", "sales_organization": { "id": "61b9aa22-0034-4cc3-b75f-afaaeb109351", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "3fd6a1eb-5fac-4f4d-89a1-c9180e5454df", "db_currency_id": "6fe8fe44-55c2-44f7-8535-70c742da879f", "db_language_id": "43db067b-1c48-49a7-8524-6d7d2bdf930b", "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-09-17T06:20:29.3892528+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "21b06807-b89c-4c14-b31d-81e9dc604d36", "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": "635b0a98-d22a-41c8-ba9e-0f00af192d72", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-09-17T06:20:29.4043797+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "1dfe9c4f-1943-4de5-8551-312dac23fde0" }, "suggested_date_start": "2025-09-17T06:20:29.4043797+00:00", "skill_id": "46b40a72-3d77-427d-af1a-6799467bc8e1", "skill_code": "sample string 32", "skill": { "id": "fb980ef3-45d3-492c-88bb-79f63a7b7c72", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "e60ce309-d49d-4f42-a626-6b214fe84faa", "sales_organization_code": "sample string 6", "sales_organization": { "id": "61b9aa22-0034-4cc3-b75f-afaaeb109351", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "3fd6a1eb-5fac-4f4d-89a1-c9180e5454df", "db_currency_id": "6fe8fe44-55c2-44f7-8535-70c742da879f", "db_language_id": "43db067b-1c48-49a7-8524-6d7d2bdf930b", "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-09-17T06:20:29.3892528+00:00" }, "modified_dateutc": "2025-09-17T06:20:29.4043797+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "4f12f133-59a9-4377-8a6e-86575dbfb0b3", "date_reported_by_company": "2025-09-17T06:20:29.4043797+00:00", "id2": 36, "company_id": "d2e7a6ae-4f8a-451c-a6e1-5123235a74ec", "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": "dda0c35d-ef4f-4801-b32e-61236dfc5970", "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-09-17T06:20:29.4043797+00:00" }
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.