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": "306b4485-cda4-4e73-8ea9-fd67b8640b21", "_parent_id": "aa219977-30d9-4ae6-80e6-ba79b1818ac7", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "7706c11f-3466-4b0c-ab50-3e6d59cd4eb8", "project_reference_back_office": "sample string 5", "project": { "id": "2d705885-aa20-48af-8710-172c3d630ed2", "_parent_id": "33cf3307-40f4-46cb-a75f-5a8947c07a42", "root_parent_id": "4f998edc-978f-476a-9ce9-c6d3c1a1385c", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "53b76c8c-0d56-45ad-ada8-517883706196", "equipment_family_code": "sample string 6", "equipment_family": { "id": "fac3488d-6597-45a7-ba5a-c583483f508b", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "24ee7391-6e94-4279-9bd8-15334a59d338", "_parent_code": "sample string 6", "sales_organization_id": "63424dcb-4efd-4b22-a5dc-a0989b37e5de", "sales_organization_code": "sample string 8", "sales_organization": { "id": "25931155-8cf3-4d15-a301-18e430a05b6c", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "eabdff78-b9e1-4425-9d4d-6b7e68d7a31c", "db_currency_id": "53e8b084-812f-4910-b141-d4f4f575b6a3", "db_language_id": "60535454-057b-4ec4-af58-e5da5b08a64b", "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-06-07T23:54:52.6131844+00:00" }, "modified_dateutc": "2025-06-07T23:54:52.6131844+00:00" }, "equipment_model_id": "0ce64f17-b5f2-4fb9-a3c9-b4e771b7c2aa", "equipment_model_code": "sample string 8", "equipment_model": { "id": "54802704-b5b6-49c9-aad7-8adf80818e72", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "6a93c548-f813-40d2-8a2a-13b7ee431ef8", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "dcfbdf98-639f-4977-9c09-d41de153acfa", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "153b3b48-d365-47fc-8594-9c13e8453888", "sales_organization_code": "sample string 5", "sales_organization": { "id": "25931155-8cf3-4d15-a301-18e430a05b6c", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "eabdff78-b9e1-4425-9d4d-6b7e68d7a31c", "db_currency_id": "53e8b084-812f-4910-b141-d4f4f575b6a3", "db_language_id": "60535454-057b-4ec4-af58-e5da5b08a64b", "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-06-07T23:54:52.6131844+00:00" }, "modified_dateutc": "2025-06-07T23:54:52.6131844+00:00" }, "equipment_family_id": "24727dca-cadc-48bf-9eeb-a1b4afe71799", "equipment_family_code": "sample string 8", "equipment_family": { "id": "fac3488d-6597-45a7-ba5a-c583483f508b", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "24ee7391-6e94-4279-9bd8-15334a59d338", "_parent_code": "sample string 6", "sales_organization_id": "63424dcb-4efd-4b22-a5dc-a0989b37e5de", "sales_organization_code": "sample string 8", "sales_organization": { "id": "25931155-8cf3-4d15-a301-18e430a05b6c", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "eabdff78-b9e1-4425-9d4d-6b7e68d7a31c", "db_currency_id": "53e8b084-812f-4910-b141-d4f4f575b6a3", "db_language_id": "60535454-057b-4ec4-af58-e5da5b08a64b", "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-06-07T23:54:52.6131844+00:00" }, "modified_dateutc": "2025-06-07T23:54:52.6131844+00:00" }, "date_in_production_since": "2025-06-07T23:54:52.6131844+00:00", "date_out_of_production_since": "2025-06-07T23:54:52.6131844+00:00", "date_end_support": "2025-06-07T23:54:52.6131844+00:00", "sales_organization_id": "40afea20-9cfb-4ff5-803f-6c6599ecd0ae", "sales_organization_code": "sample string 13", "sales_organization": { "id": "25931155-8cf3-4d15-a301-18e430a05b6c", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "eabdff78-b9e1-4425-9d4d-6b7e68d7a31c", "db_currency_id": "53e8b084-812f-4910-b141-d4f4f575b6a3", "db_language_id": "60535454-057b-4ec4-af58-e5da5b08a64b", "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-06-07T23:54:52.6131844+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-06-07T23:54:52.6131844+00:00" }, "project_status_id": "309b440b-fe9c-4a28-8a42-dde9e3ce848a", "project_status_code": "sample string 10", "project_status": { "id": "7650deb1-7274-44a4-b42b-1b684f96c445", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "2ed57366-0503-4b9d-9d72-a27e547293bd", "sales_organization_code": "sample string 6", "sales_organization": { "id": "25931155-8cf3-4d15-a301-18e430a05b6c", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "eabdff78-b9e1-4425-9d4d-6b7e68d7a31c", "db_currency_id": "53e8b084-812f-4910-b141-d4f4f575b6a3", "db_language_id": "60535454-057b-4ec4-af58-e5da5b08a64b", "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-06-07T23:54:52.6131844+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-06-07T23:54:52.6131844+00:00" }, "company_id": "60373594-7d32-4800-be39-6c25dd23da4b", "company_code": "sample string 12", "db_address_id": "97f0953b-31cb-41d1-805a-a4ccd5a8f517", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "e73e0701-4406-4dd5-9a66-d01e7c327a2d", "contact_reference_back_office": "sample string 17", "owner_user_id": "c8949aa3-371b-41dd-b725-28d7b984eb43", "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-06-07T23:54:52.6131844+00:00", "date_create": "2025-06-07T23:54:52.6131844+00:00", "date_update": "2025-06-07T23:54:52.6131844+00:00", "updated_by_user_id": "ed3ea766-d470-492f-ae25-13b2b8f176c4", "customer_reference": "sample string 28", "warranty_date_until": "2025-06-07T23:54:52.6131844+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-06-07T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-06-07T23:54:52.6131844+00:00", "date_last_job": "2025-06-07T23:54:52.6131844+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-06-07T23:54:52.6131844+00:00", "modified_dateutc": "2025-06-07T23:54:52.6131844+00:00", "is_mobile_installation": true }, "job_type_id": "64e019a5-1faa-4a94-b312-074360db6afe", "job_type_code": "sample string 7", "job_type": { "id": "2a5eec43-159c-4783-9dd2-02df5aef2c80", "name": "sample string 2", "sales_organization_id": "669328b7-7ea5-434c-b648-656dd32fb7e5", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-06-07T23:54:52.6131844+00:00", "code": "sample string 7" }, "job_priority_id": "5af40170-4199-4f07-befe-cc888842418f", "job_priority_code": "sample string 9", "job_priority": { "id": "ae374fe2-0de3-427a-bb4a-4ee348bd88fc", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "e11ee563-071c-49c9-abac-d90dd5f7d107", "sales_organization_code": "sample string 6", "sales_organization": { "id": "25931155-8cf3-4d15-a301-18e430a05b6c", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "eabdff78-b9e1-4425-9d4d-6b7e68d7a31c", "db_currency_id": "53e8b084-812f-4910-b141-d4f4f575b6a3", "db_language_id": "60535454-057b-4ec4-af58-e5da5b08a64b", "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-06-07T23:54:52.6131844+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-06-07T23:54:52.6131844+00:00" }, "job_status_id": "eb551700-7e8b-4c5c-bdba-f862f1ba3ce9", "job_status_code": "sample string 11", "db_address_id": "b3d013ab-9d54-4a23-bae0-7e7c75acfbed", "contact_id": "d40be594-4004-4a2b-82a6-fe1486ac6b9d", "requested_by_company_id": "13572a13-0264-423c-8b29-e3c1a72f22c4", "requested_by_contact_id": "f3a95a25-e992-43b0-b445-84061afeef2c", "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-06-07T23:54:52.6131844+00:00", "due_date": "2025-06-07T23:54:52.6131844+00:00", "date_create": "2025-06-07T23:54:52.6131844+00:00", "date_update": "2025-06-07T23:54:52.6131844+00:00", "date_closed": "2025-06-07T23:54:52.6131844+00:00", "suggested_user_id": "aa79fe2e-d2cf-4df4-a627-a7a4ac24c23e", "suggested_user_code": "sample string 29", "suggested_user": { "id": "52a2b08c-3a86-4bea-98de-8c821f545dcb", "db_language_id": "c3aae524-2413-4cba-befc-dbb9c355fa18", "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-06-07T23:54:52.6131844+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "b29f2e8d-8eab-4c8a-b3b5-0befc7a98675", "sales_organization": { "id": "25931155-8cf3-4d15-a301-18e430a05b6c", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "eabdff78-b9e1-4425-9d4d-6b7e68d7a31c", "db_currency_id": "53e8b084-812f-4910-b141-d4f4f575b6a3", "db_language_id": "60535454-057b-4ec4-af58-e5da5b08a64b", "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-06-07T23:54:52.6131844+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "c4935120-0df0-4278-ac85-1800c3021568", "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": "41a21ba5-ae6d-4db0-a542-a47736fec818", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-06-07T23:54:52.6131844+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "2e2cd3c8-b917-4e60-8931-f72e1b3ab5b6" }, "suggested_date_start": "2025-06-07T23:54:52.6131844+00:00", "skill_id": "415cd729-901c-415c-b01c-18619dd6bd82", "skill_code": "sample string 32", "skill": { "id": "701a3769-dcd7-4abf-b8fd-bb5b8c48d5ed", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "b9315608-3def-476f-8053-81c445a7fb0c", "sales_organization_code": "sample string 6", "sales_organization": { "id": "25931155-8cf3-4d15-a301-18e430a05b6c", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "eabdff78-b9e1-4425-9d4d-6b7e68d7a31c", "db_currency_id": "53e8b084-812f-4910-b141-d4f4f575b6a3", "db_language_id": "60535454-057b-4ec4-af58-e5da5b08a64b", "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-06-07T23:54:52.6131844+00:00" }, "modified_dateutc": "2025-06-07T23:54:52.6131844+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "b8c9f44b-6dac-4fa8-8437-d20e6e7232d2", "date_reported_by_company": "2025-06-07T23:54:52.6131844+00:00", "id2": 36, "company_id": "d60a0d88-ae26-41b9-a33a-559efcd02b00", "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": "06356625-557f-43f7-b1d3-ab036467c662", "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-06-07T23:54:52.6131844+00:00" }
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.