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": "1a35a2ab-dcf0-47fa-8a0b-2c775c7b2e53", "_parent_id": "5c26575e-d24d-4078-97af-59ce62946888", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "c417c83b-9d63-4060-ba1c-5a02f67663b0", "project_reference_back_office": "sample string 5", "project": { "id": "1b4b621d-1b75-404a-8c0a-ecb542b09492", "_parent_id": "09d207f8-9149-4091-a05a-dcb35910a20b", "root_parent_id": "85d9428a-c6cc-4040-97d4-4980ac7cd371", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "d3cc539e-0bad-47c1-9451-cff915018d5a", "equipment_family_code": "sample string 6", "equipment_family": { "id": "4aa368fa-5d9b-46b6-ba8e-3ff41a0616fd", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "1bce7f74-a1a6-4265-8e0f-b1c9f9fb3f89", "_parent_code": "sample string 6", "sales_organization_id": "fc68a5dd-80c1-4f65-afcd-630917741b4c", "sales_organization_code": "sample string 8", "sales_organization": { "id": "7130e3b3-21c6-43b0-ab4a-c79f92eacc9c", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "4264c231-7b57-41b6-8242-7b5d0dfad097", "db_currency_id": "f5bfa1ba-f433-4509-80d0-79750d7ed337", "db_language_id": "373f5fcf-7694-4a52-8aab-037df9fe4faa", "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-05-18T02:07:23.2014389+00:00" }, "modified_dateutc": "2025-05-18T02:07:23.2014389+00:00" }, "equipment_model_id": "aea37a64-4e16-4b11-8ce8-c52c80d5fe6b", "equipment_model_code": "sample string 8", "equipment_model": { "id": "36231184-9878-490f-abbe-d32003abbdff", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "630c2510-6a7e-4c3e-a076-bc5e858c09e9", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "4350f151-17be-4385-8619-a7a9ff0e4480", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "6dbcc690-98e6-45f7-b49f-7be995688a7b", "sales_organization_code": "sample string 5", "sales_organization": { "id": "7130e3b3-21c6-43b0-ab4a-c79f92eacc9c", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "4264c231-7b57-41b6-8242-7b5d0dfad097", "db_currency_id": "f5bfa1ba-f433-4509-80d0-79750d7ed337", "db_language_id": "373f5fcf-7694-4a52-8aab-037df9fe4faa", "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-05-18T02:07:23.2014389+00:00" }, "modified_dateutc": "2025-05-18T02:07:23.2014389+00:00" }, "equipment_family_id": "b51436f6-2135-4735-96a1-19c5f93d0e20", "equipment_family_code": "sample string 8", "equipment_family": { "id": "4aa368fa-5d9b-46b6-ba8e-3ff41a0616fd", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "1bce7f74-a1a6-4265-8e0f-b1c9f9fb3f89", "_parent_code": "sample string 6", "sales_organization_id": "fc68a5dd-80c1-4f65-afcd-630917741b4c", "sales_organization_code": "sample string 8", "sales_organization": { "id": "7130e3b3-21c6-43b0-ab4a-c79f92eacc9c", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "4264c231-7b57-41b6-8242-7b5d0dfad097", "db_currency_id": "f5bfa1ba-f433-4509-80d0-79750d7ed337", "db_language_id": "373f5fcf-7694-4a52-8aab-037df9fe4faa", "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-05-18T02:07:23.2014389+00:00" }, "modified_dateutc": "2025-05-18T02:07:23.2014389+00:00" }, "date_in_production_since": "2025-05-18T02:07:23.2014389+00:00", "date_out_of_production_since": "2025-05-18T02:07:23.2014389+00:00", "date_end_support": "2025-05-18T02:07:23.2014389+00:00", "sales_organization_id": "39279f68-69be-4011-935e-7961a0cc9436", "sales_organization_code": "sample string 13", "sales_organization": { "id": "7130e3b3-21c6-43b0-ab4a-c79f92eacc9c", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "4264c231-7b57-41b6-8242-7b5d0dfad097", "db_currency_id": "f5bfa1ba-f433-4509-80d0-79750d7ed337", "db_language_id": "373f5fcf-7694-4a52-8aab-037df9fe4faa", "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-05-18T02:07:23.2014389+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-05-18T02:07:23.217063+00:00" }, "project_status_id": "dfc75dd9-fd7b-4270-bb15-4ec018ed7dc9", "project_status_code": "sample string 10", "project_status": { "id": "393b0089-57ca-4be0-9fa6-fd2df4180c01", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "a9aa4560-8f82-4a3d-9dd2-ce43e02c611e", "sales_organization_code": "sample string 6", "sales_organization": { "id": "7130e3b3-21c6-43b0-ab4a-c79f92eacc9c", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "4264c231-7b57-41b6-8242-7b5d0dfad097", "db_currency_id": "f5bfa1ba-f433-4509-80d0-79750d7ed337", "db_language_id": "373f5fcf-7694-4a52-8aab-037df9fe4faa", "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-05-18T02:07:23.2014389+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-05-18T02:07:23.217063+00:00" }, "company_id": "da1dc714-d507-43b3-b7bb-80b545e8eec3", "company_code": "sample string 12", "db_address_id": "d27342a8-cdfc-4219-a4e4-7a29b6c6d523", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "df131a17-0420-4895-a684-ff81d0316af3", "contact_reference_back_office": "sample string 17", "owner_user_id": "12054afe-e689-4354-9c48-7ce5432d11ea", "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-05-18T02:07:23.217063+00:00", "date_create": "2025-05-18T02:07:23.217063+00:00", "date_update": "2025-05-18T02:07:23.217063+00:00", "updated_by_user_id": "99c6509c-658a-4395-a26d-04394319158f", "customer_reference": "sample string 28", "warranty_date_until": "2025-05-18T02:07:23.217063+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-05-18T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-05-18T02:07:23.217063+00:00", "date_last_job": "2025-05-18T02:07:23.217063+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-05-18T02:07:23.217063+00:00", "modified_dateutc": "2025-05-18T02:07:23.217063+00:00", "is_mobile_installation": true }, "job_type_id": "1d7ca6db-8f17-4285-841e-5d396558b352", "job_type_code": "sample string 7", "job_type": { "id": "7a41651e-b77b-43a8-85f2-1ff9cabe1862", "name": "sample string 2", "sales_organization_id": "cb8d4cb6-028c-40e6-b79b-6c194cc61feb", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-05-18T02:07:23.217063+00:00", "code": "sample string 7" }, "job_priority_id": "8fcc91a8-6c80-4f8a-b01e-7cdffcc74053", "job_priority_code": "sample string 9", "job_priority": { "id": "bcf54138-9209-42bf-bc06-bdf16b95e969", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "8acd10ee-13f7-4a2f-af47-2fc0d9eed721", "sales_organization_code": "sample string 6", "sales_organization": { "id": "7130e3b3-21c6-43b0-ab4a-c79f92eacc9c", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "4264c231-7b57-41b6-8242-7b5d0dfad097", "db_currency_id": "f5bfa1ba-f433-4509-80d0-79750d7ed337", "db_language_id": "373f5fcf-7694-4a52-8aab-037df9fe4faa", "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-05-18T02:07:23.2014389+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-05-18T02:07:23.217063+00:00" }, "job_status_id": "05f86adb-a36d-45ac-a7b6-84df5b2288e3", "job_status_code": "sample string 11", "db_address_id": "aa2ebbc0-fdbe-43a1-8e4b-8ce86cd0effd", "contact_id": "a6103801-4491-4d17-85c3-2e615c9b22f5", "requested_by_company_id": "0a0d4908-91b4-414b-b406-a350cef7eaa3", "requested_by_contact_id": "c82607cb-f61b-4e3f-a83b-11584f38a216", "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-05-18T02:07:23.2326848+00:00", "due_date": "2025-05-18T02:07:23.2326848+00:00", "date_create": "2025-05-18T02:07:23.2326848+00:00", "date_update": "2025-05-18T02:07:23.2326848+00:00", "date_closed": "2025-05-18T02:07:23.2326848+00:00", "suggested_user_id": "48a00822-b411-4071-9e63-04dff146657a", "suggested_user_code": "sample string 29", "suggested_user": { "id": "0f43a290-c17e-49fa-8081-a9051e6454ba", "db_language_id": "71dd92b5-feab-49b7-b7ae-24812e6d1c76", "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-05-18T02:07:23.2326848+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "32cf5146-3de3-4e4c-ba66-47ac007644d0", "sales_organization": { "id": "7130e3b3-21c6-43b0-ab4a-c79f92eacc9c", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "4264c231-7b57-41b6-8242-7b5d0dfad097", "db_currency_id": "f5bfa1ba-f433-4509-80d0-79750d7ed337", "db_language_id": "373f5fcf-7694-4a52-8aab-037df9fe4faa", "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-05-18T02:07:23.2014389+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "32f4a59a-3e08-4fb8-b436-47f9bc95434a", "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": "0b7e30d6-5e92-4502-874c-d7aafa6a75f5", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-05-18T02:07:23.2326848+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "fc240e5f-8bc6-4979-8684-af8175f07a25" }, "suggested_date_start": "2025-05-18T02:07:23.2326848+00:00", "skill_id": "7801a043-592e-41b9-83ae-33f9772b1f35", "skill_code": "sample string 32", "skill": { "id": "d4b7966e-b5a3-4918-92d4-8931ace2c712", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "e4650332-614f-43d2-b192-925da15ae9f4", "sales_organization_code": "sample string 6", "sales_organization": { "id": "7130e3b3-21c6-43b0-ab4a-c79f92eacc9c", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "4264c231-7b57-41b6-8242-7b5d0dfad097", "db_currency_id": "f5bfa1ba-f433-4509-80d0-79750d7ed337", "db_language_id": "373f5fcf-7694-4a52-8aab-037df9fe4faa", "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-05-18T02:07:23.2014389+00:00" }, "modified_dateutc": "2025-05-18T02:07:23.2326848+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "8b9afc16-9f30-4f56-8915-b6c77ae5c085", "date_reported_by_company": "2025-05-18T02:07:23.2326848+00:00", "id2": 36, "company_id": "479ac5e4-a0d0-4457-bd08-8d445f08f2ba", "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": "b7e3a058-dfad-4059-8cfa-d8e02a2dfecc", "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-05-18T02:07:23.2326848+00:00" }
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.