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": "b28a50fc-1aab-4e85-956b-53cfd11387a9", "_parent_id": "63ab85fc-63a5-4934-82aa-4d0d5ca5c7ca", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "3e2ded4c-f02c-4508-baa9-7af092fdefb0", "project_reference_back_office": "sample string 5", "project": { "id": "1dc88f74-af08-4e32-a033-d340dbd8c0a6", "_parent_id": "844550cd-95fe-4252-91fb-9b1fd5a3a784", "root_parent_id": "d61597ff-bba4-429d-b9f4-e46c77460558", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "a2f858ea-9dfd-4325-b9c3-b38f896b4cfc", "equipment_family_code": "sample string 6", "equipment_family": { "id": "6e47e536-293f-49b2-8dd2-c73e0f034dd9", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "001c4f40-35dc-4c7f-87e1-853868e7bf3c", "_parent_code": "sample string 6", "sales_organization_id": "9196e852-0a5c-4223-b615-e6e3e2a027cd", "sales_organization_code": "sample string 8", "sales_organization": { "id": "537a910e-20df-4efc-a3fb-afac9223b891", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "cb00e7f3-f7d6-4692-a0e6-a699ab1eadd6", "db_currency_id": "1e4d6223-2518-48dd-8d92-942d5bbe5a47", "db_language_id": "b29da489-4c12-4cd8-a95a-9bc2f749e22b", "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-10T20:54:27.1452629+00:00" }, "modified_dateutc": "2025-07-10T20:54:27.1452629+00:00" }, "equipment_model_id": "79a27720-6c01-4a62-ac9f-1bd0a2911145", "equipment_model_code": "sample string 8", "equipment_model": { "id": "9ff28f5b-e3b3-4fbb-87c3-eb1f76587918", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "b323be0b-e288-4300-94cf-4d8a25fad0ca", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "2f61e32a-acc5-498d-a6f6-e7b2b4211327", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "11b3076e-c8dc-4adb-8bf4-afe0ec107482", "sales_organization_code": "sample string 5", "sales_organization": { "id": "537a910e-20df-4efc-a3fb-afac9223b891", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "cb00e7f3-f7d6-4692-a0e6-a699ab1eadd6", "db_currency_id": "1e4d6223-2518-48dd-8d92-942d5bbe5a47", "db_language_id": "b29da489-4c12-4cd8-a95a-9bc2f749e22b", "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-10T20:54:27.1452629+00:00" }, "modified_dateutc": "2025-07-10T20:54:27.1452629+00:00" }, "equipment_family_id": "22f2591a-cb4c-476f-9654-1d00d9865679", "equipment_family_code": "sample string 8", "equipment_family": { "id": "6e47e536-293f-49b2-8dd2-c73e0f034dd9", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "001c4f40-35dc-4c7f-87e1-853868e7bf3c", "_parent_code": "sample string 6", "sales_organization_id": "9196e852-0a5c-4223-b615-e6e3e2a027cd", "sales_organization_code": "sample string 8", "sales_organization": { "id": "537a910e-20df-4efc-a3fb-afac9223b891", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "cb00e7f3-f7d6-4692-a0e6-a699ab1eadd6", "db_currency_id": "1e4d6223-2518-48dd-8d92-942d5bbe5a47", "db_language_id": "b29da489-4c12-4cd8-a95a-9bc2f749e22b", "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-10T20:54:27.1452629+00:00" }, "modified_dateutc": "2025-07-10T20:54:27.1452629+00:00" }, "date_in_production_since": "2025-07-10T20:54:27.1452629+00:00", "date_out_of_production_since": "2025-07-10T20:54:27.1452629+00:00", "date_end_support": "2025-07-10T20:54:27.1452629+00:00", "sales_organization_id": "b8a8859b-a79d-4a00-a24e-0b9f2518770e", "sales_organization_code": "sample string 13", "sales_organization": { "id": "537a910e-20df-4efc-a3fb-afac9223b891", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "cb00e7f3-f7d6-4692-a0e6-a699ab1eadd6", "db_currency_id": "1e4d6223-2518-48dd-8d92-942d5bbe5a47", "db_language_id": "b29da489-4c12-4cd8-a95a-9bc2f749e22b", "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-10T20:54:27.1452629+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-10T20:54:27.1452629+00:00" }, "project_status_id": "fdbc6cc5-55aa-4748-ba39-502d08224cab", "project_status_code": "sample string 10", "project_status": { "id": "1c37432b-80ce-4810-b221-04b8d45080e8", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "d82758a6-0b3d-4cc6-a48f-ca15a71ba9a6", "sales_organization_code": "sample string 6", "sales_organization": { "id": "537a910e-20df-4efc-a3fb-afac9223b891", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "cb00e7f3-f7d6-4692-a0e6-a699ab1eadd6", "db_currency_id": "1e4d6223-2518-48dd-8d92-942d5bbe5a47", "db_language_id": "b29da489-4c12-4cd8-a95a-9bc2f749e22b", "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-10T20:54:27.1452629+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-07-10T20:54:27.1452629+00:00" }, "company_id": "be687479-bb61-4e19-a653-2a6bc8633c3e", "company_code": "sample string 12", "db_address_id": "39360ab2-0b44-4aba-a8f2-6e687105928b", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "e7645806-7daf-41de-ac31-b14c42ec04f6", "contact_reference_back_office": "sample string 17", "owner_user_id": "a72cbc87-b58b-45c0-bea8-9b631f54ec2b", "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-10T20:54:27.1452629+00:00", "date_create": "2025-07-10T20:54:27.1452629+00:00", "date_update": "2025-07-10T20:54:27.1452629+00:00", "updated_by_user_id": "b59c3514-50f9-403e-b393-050402d6450b", "customer_reference": "sample string 28", "warranty_date_until": "2025-07-10T20:54:27.1452629+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-10T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-07-10T20:54:27.1452629+00:00", "date_last_job": "2025-07-10T20:54:27.1452629+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-07-10T20:54:27.1452629+00:00", "modified_dateutc": "2025-07-10T20:54:27.1452629+00:00", "is_mobile_installation": true }, "job_type_id": "471bebb1-59e7-4bf4-a664-69feb1d1588a", "job_type_code": "sample string 7", "job_type": { "id": "dc1b5700-ce4f-4f61-937f-ea4331507914", "name": "sample string 2", "sales_organization_id": "e7d41487-4387-4a41-909a-1467e5d7e430", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-07-10T20:54:27.1452629+00:00", "code": "sample string 7" }, "job_priority_id": "16d0052d-47f1-44b2-b587-d5ad356c1798", "job_priority_code": "sample string 9", "job_priority": { "id": "3f8d6ebb-0706-4a1f-83c4-b9ace1746957", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "09efba22-901a-4ca5-ad92-a08c06a2f2fa", "sales_organization_code": "sample string 6", "sales_organization": { "id": "537a910e-20df-4efc-a3fb-afac9223b891", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "cb00e7f3-f7d6-4692-a0e6-a699ab1eadd6", "db_currency_id": "1e4d6223-2518-48dd-8d92-942d5bbe5a47", "db_language_id": "b29da489-4c12-4cd8-a95a-9bc2f749e22b", "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-10T20:54:27.1452629+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-07-10T20:54:27.1452629+00:00" }, "job_status_id": "a3a673ec-a9c0-4147-a467-315aaa5d3f22", "job_status_code": "sample string 11", "db_address_id": "51d48a96-cd34-4a12-ae08-c832097b0f11", "contact_id": "58005fe8-ac4c-4dbd-a563-2a49cc6c7807", "requested_by_company_id": "27a87fd2-e6d8-4f56-8a69-caf2c97ced4d", "requested_by_contact_id": "dfa57c4e-c882-4a8f-80fb-47df5c850cb7", "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-10T20:54:27.1452629+00:00", "due_date": "2025-07-10T20:54:27.1452629+00:00", "date_create": "2025-07-10T20:54:27.1452629+00:00", "date_update": "2025-07-10T20:54:27.1452629+00:00", "date_closed": "2025-07-10T20:54:27.1452629+00:00", "suggested_user_id": "bcfe5533-3c85-4d26-90fa-79db3a461069", "suggested_user_code": "sample string 29", "suggested_user": { "id": "00a7b2ac-49fb-44ae-a4d1-e80404bdd60a", "db_language_id": "e4743128-52f8-4ae8-9d7d-68a8f255686e", "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-10T20:54:27.1452629+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "7d7000d9-1886-4a8e-a195-c4d08d3de4ba", "sales_organization": { "id": "537a910e-20df-4efc-a3fb-afac9223b891", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "cb00e7f3-f7d6-4692-a0e6-a699ab1eadd6", "db_currency_id": "1e4d6223-2518-48dd-8d92-942d5bbe5a47", "db_language_id": "b29da489-4c12-4cd8-a95a-9bc2f749e22b", "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-10T20:54:27.1452629+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "3b82e87d-fa57-429d-8fa1-c2dcda87ba96", "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": "5d76f9fb-c494-4949-bbd2-8952baf9f102", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-07-10T20:54:27.1452629+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "01ae443e-780c-4e14-ab55-84f40e156d11" }, "suggested_date_start": "2025-07-10T20:54:27.1452629+00:00", "skill_id": "e03a0759-ac2b-4b2b-b449-d57a07d621a3", "skill_code": "sample string 32", "skill": { "id": "afe76bbd-8320-4540-a193-9b85dc182471", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "e916088b-25b3-4ff0-a553-d26de8567563", "sales_organization_code": "sample string 6", "sales_organization": { "id": "537a910e-20df-4efc-a3fb-afac9223b891", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "cb00e7f3-f7d6-4692-a0e6-a699ab1eadd6", "db_currency_id": "1e4d6223-2518-48dd-8d92-942d5bbe5a47", "db_language_id": "b29da489-4c12-4cd8-a95a-9bc2f749e22b", "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-10T20:54:27.1452629+00:00" }, "modified_dateutc": "2025-07-10T20:54:27.1452629+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "8ded6a3a-7cd1-4cb6-87f0-6ca1e8b96b49", "date_reported_by_company": "2025-07-10T20:54:27.1452629+00:00", "id2": 36, "company_id": "c8ea78e4-fade-4438-b03e-77ae5272f308", "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": "7b624211-7851-443f-bd8e-3064cb1e068b", "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-10T20:54:27.1452629+00:00" }
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.