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": "1c4e3e3a-6373-4817-a8ca-69163e247ad9", "_parent_id": "e424d6c9-d48d-420f-918d-e405b3364675", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "f9ca0b2d-ae0f-4ff5-9fe4-69bf376bef76", "project_reference_back_office": "sample string 5", "project": { "id": "461981f0-b88c-47a1-b869-2e1462c199b8", "_parent_id": "48f9421f-e3da-4961-ab77-345d229f591d", "root_parent_id": "2b36b89e-3e8e-455e-8ffb-236b27d794c4", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "ee4eca7b-09af-4593-894b-255925aab5da", "equipment_family_code": "sample string 6", "equipment_family": { "id": "5da1caf3-719a-437a-b866-9473e62db060", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "241947c3-e897-4429-bfb7-2b71e92a66bc", "_parent_code": "sample string 6", "sales_organization_id": "bf71a0db-c471-45ed-8dbb-e2b4a1e0c811", "sales_organization_code": "sample string 8", "sales_organization": { "id": "993ecba4-8376-4110-af9e-a62c187fad21", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "60dca30a-9a68-446c-a98d-e08dc33eea26", "db_currency_id": "50799874-516d-486c-96cb-021a3daaee36", "db_language_id": "a5a6e29c-1a4a-422f-bfe6-6c1eba5437bb", "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-07-11T02:58:03.2106188+00:00" }, "modified_dateutc": "2025-07-11T02:58:03.2106188+00:00" }, "equipment_model_id": "4b862f91-e161-4e1e-b024-7851884bcccd", "equipment_model_code": "sample string 8", "equipment_model": { "id": "b575107a-a04d-4126-be5f-433580ed9179", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "8211fe6c-036c-40e2-9d7f-2abf012ba7b8", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "fb36ecdc-8797-4395-8632-4c87ab1a0da1", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "da5b9c17-eae2-402f-81f0-c891e29a6139", "sales_organization_code": "sample string 5", "sales_organization": { "id": "993ecba4-8376-4110-af9e-a62c187fad21", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "60dca30a-9a68-446c-a98d-e08dc33eea26", "db_currency_id": "50799874-516d-486c-96cb-021a3daaee36", "db_language_id": "a5a6e29c-1a4a-422f-bfe6-6c1eba5437bb", "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-07-11T02:58:03.2106188+00:00" }, "modified_dateutc": "2025-07-11T02:58:03.2106188+00:00" }, "equipment_family_id": "f32a38b2-6717-4904-b170-0186b862b96b", "equipment_family_code": "sample string 8", "equipment_family": { "id": "5da1caf3-719a-437a-b866-9473e62db060", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "241947c3-e897-4429-bfb7-2b71e92a66bc", "_parent_code": "sample string 6", "sales_organization_id": "bf71a0db-c471-45ed-8dbb-e2b4a1e0c811", "sales_organization_code": "sample string 8", "sales_organization": { "id": "993ecba4-8376-4110-af9e-a62c187fad21", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "60dca30a-9a68-446c-a98d-e08dc33eea26", "db_currency_id": "50799874-516d-486c-96cb-021a3daaee36", "db_language_id": "a5a6e29c-1a4a-422f-bfe6-6c1eba5437bb", "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-07-11T02:58:03.2106188+00:00" }, "modified_dateutc": "2025-07-11T02:58:03.2106188+00:00" }, "date_in_production_since": "2025-07-11T02:58:03.2106188+00:00", "date_out_of_production_since": "2025-07-11T02:58:03.2106188+00:00", "date_end_support": "2025-07-11T02:58:03.2106188+00:00", "sales_organization_id": "33cc543e-ca52-4548-9b1d-0cc9f1850b6c", "sales_organization_code": "sample string 13", "sales_organization": { "id": "993ecba4-8376-4110-af9e-a62c187fad21", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "60dca30a-9a68-446c-a98d-e08dc33eea26", "db_currency_id": "50799874-516d-486c-96cb-021a3daaee36", "db_language_id": "a5a6e29c-1a4a-422f-bfe6-6c1eba5437bb", "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-07-11T02:58:03.2106188+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-07-11T02:58:03.2106188+00:00" }, "project_status_id": "0865de23-e860-4040-9968-2e5a169aedcb", "project_status_code": "sample string 10", "project_status": { "id": "603b673d-5a67-49c6-9e0f-3ac243fc2c51", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "4f8b066a-842d-4d5e-87bb-32b8d0e8a17a", "sales_organization_code": "sample string 6", "sales_organization": { "id": "993ecba4-8376-4110-af9e-a62c187fad21", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "60dca30a-9a68-446c-a98d-e08dc33eea26", "db_currency_id": "50799874-516d-486c-96cb-021a3daaee36", "db_language_id": "a5a6e29c-1a4a-422f-bfe6-6c1eba5437bb", "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-07-11T02:58:03.2106188+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-07-11T02:58:03.2106188+00:00" }, "company_id": "e1c41a83-e329-4bd4-8e6e-abfdd46a6240", "company_code": "sample string 12", "db_address_id": "ab96fd3c-8dff-4787-a0ab-bfd90d36c0d8", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "553a0f2d-0fc4-48c7-8670-e8d1accd656a", "contact_reference_back_office": "sample string 17", "owner_user_id": "5c6c8bd7-2db4-40ce-9871-d9d75d3d13fb", "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-07-11T02:58:03.2106188+00:00", "date_create": "2025-07-11T02:58:03.2106188+00:00", "date_update": "2025-07-11T02:58:03.2106188+00:00", "updated_by_user_id": "d22a79e9-4f3a-44fb-88fe-591966d94cd5", "customer_reference": "sample string 28", "warranty_date_until": "2025-07-11T02:58:03.2106188+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-07-11T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-07-11T02:58:03.2106188+00:00", "date_last_job": "2025-07-11T02:58:03.2106188+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-07-11T02:58:03.2106188+00:00", "modified_dateutc": "2025-07-11T02:58:03.2106188+00:00", "is_mobile_installation": true }, "job_type_id": "30cbdaa0-ea31-40d8-a517-e833ac0e3dac", "job_type_code": "sample string 7", "job_type": { "id": "1dbe35b7-38ea-49d3-9065-4750dc2b6933", "name": "sample string 2", "sales_organization_id": "3fb70238-9ea0-4fad-989a-2de743c0dd3c", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-07-11T02:58:03.2106188+00:00", "code": "sample string 7" }, "job_priority_id": "c10ecb8b-6400-4932-82e7-8a8ff3891f5e", "job_priority_code": "sample string 9", "job_priority": { "id": "369a99aa-4fc0-4b54-be34-550822be942e", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "a1375e75-f445-4a2c-97b8-40f16ba7152b", "sales_organization_code": "sample string 6", "sales_organization": { "id": "993ecba4-8376-4110-af9e-a62c187fad21", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "60dca30a-9a68-446c-a98d-e08dc33eea26", "db_currency_id": "50799874-516d-486c-96cb-021a3daaee36", "db_language_id": "a5a6e29c-1a4a-422f-bfe6-6c1eba5437bb", "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-07-11T02:58:03.2106188+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-07-11T02:58:03.2106188+00:00" }, "job_status_id": "15a227db-cc92-4a90-8ecc-ee99365a2edf", "job_status_code": "sample string 11", "db_address_id": "d114eec5-880f-4fb3-9336-239eb7d86a68", "contact_id": "2a6bb1ac-547b-4e86-bc5a-492757ade42a", "requested_by_company_id": "730ab9f0-c456-41d1-8d83-4d8074031f49", "requested_by_contact_id": "777377b8-ed61-4e9b-9162-72cc863528e2", "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-07-11T02:58:03.2106188+00:00", "due_date": "2025-07-11T02:58:03.2106188+00:00", "date_create": "2025-07-11T02:58:03.2106188+00:00", "date_update": "2025-07-11T02:58:03.2106188+00:00", "date_closed": "2025-07-11T02:58:03.2106188+00:00", "suggested_user_id": "7ea7b26f-d252-4896-ac21-50ef355af49b", "suggested_user_code": "sample string 29", "suggested_user": { "id": "8fd4c11c-b7d8-461d-a623-207e1cabda26", "db_language_id": "03d264eb-358c-42a0-9214-967f675c0f28", "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-07-11T02:58:03.2106188+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "b316d9c7-3c0a-47ed-a9ea-73f3b494a9b5", "sales_organization": { "id": "993ecba4-8376-4110-af9e-a62c187fad21", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "60dca30a-9a68-446c-a98d-e08dc33eea26", "db_currency_id": "50799874-516d-486c-96cb-021a3daaee36", "db_language_id": "a5a6e29c-1a4a-422f-bfe6-6c1eba5437bb", "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-07-11T02:58:03.2106188+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "479a078c-5497-4a99-9c83-db9ed721f090", "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": "b91f1f16-e211-40a7-a1df-0391b1afdc71", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-07-11T02:58:03.226292+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "e4e6b92e-1dcc-4523-bba3-dd660cdfe144" }, "suggested_date_start": "2025-07-11T02:58:03.226292+00:00", "skill_id": "f69bc876-a31e-485d-a5f7-31ac683411c9", "skill_code": "sample string 32", "skill": { "id": "fef2b56f-9fe5-4e51-96c8-226046d29684", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "cff6c17e-a62e-46e0-9f4f-5f9bb0dcb785", "sales_organization_code": "sample string 6", "sales_organization": { "id": "993ecba4-8376-4110-af9e-a62c187fad21", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "60dca30a-9a68-446c-a98d-e08dc33eea26", "db_currency_id": "50799874-516d-486c-96cb-021a3daaee36", "db_language_id": "a5a6e29c-1a4a-422f-bfe6-6c1eba5437bb", "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-07-11T02:58:03.2106188+00:00" }, "modified_dateutc": "2025-07-11T02:58:03.226292+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "0ec337db-5977-4b60-8e52-61e485785a2c", "date_reported_by_company": "2025-07-11T02:58:03.226292+00:00", "id2": 36, "company_id": "d2110c71-9e17-41ed-b396-7b2d0c44e08c", "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": "d6e55491-f464-4fa0-aa6a-e5ec8a6d8b33", "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-07-11T02:58:03.226292+00:00" }
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.