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": "fe502206-59fc-475b-9f46-b6f206721c98", "_parent_id": "2e81ae60-1c4f-4401-bcc2-41758dc91ecf", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "b1300059-b804-4520-8b52-ef6490170292", "project_reference_back_office": "sample string 5", "project": { "id": "9b47578e-ff65-421a-8c0b-e1a0ae067e4f", "_parent_id": "29e61cd0-0041-4668-9bc4-9092b72f9102", "root_parent_id": "1b42993d-89c7-411b-aee5-48037ddb109f", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "943dc7bc-3292-4fd2-8590-071f07b2207c", "equipment_family_code": "sample string 6", "equipment_family": { "id": "6c70f867-1702-4916-9297-8afafe07395b", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "b8723a05-69a6-41cc-98b7-24db607a53d1", "_parent_code": "sample string 6", "sales_organization_id": "944f1751-8ac2-4a02-bf4a-9a77b2810c76", "sales_organization_code": "sample string 8", "sales_organization": { "id": "39025d85-2b7b-41f6-a61c-97e48c68360f", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "5f93bd1e-1320-4fff-90fd-027061d42a5b", "db_currency_id": "ff4d94b3-0fea-4250-b2c6-fc94c6297402", "db_language_id": "1899805a-8d0b-4bf9-b158-014f9b8da413", "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-04-02T01:53:29.8349647+00:00" }, "modified_dateutc": "2025-04-02T01:53:29.8349647+00:00" }, "equipment_model_id": "d1f3af19-a391-41c0-ac07-7572a5043629", "equipment_model_code": "sample string 8", "equipment_model": { "id": "8a6b0988-11f7-4225-89bd-442ecfd3a71a", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "3624e155-11b8-4bc3-b141-bed7e7bf87ff", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "cd48817c-6d06-4362-9b8c-1d0a592c5fb0", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "e8426d25-3f13-4066-8109-16cc660e21ff", "sales_organization_code": "sample string 5", "sales_organization": { "id": "39025d85-2b7b-41f6-a61c-97e48c68360f", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "5f93bd1e-1320-4fff-90fd-027061d42a5b", "db_currency_id": "ff4d94b3-0fea-4250-b2c6-fc94c6297402", "db_language_id": "1899805a-8d0b-4bf9-b158-014f9b8da413", "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-04-02T01:53:29.8349647+00:00" }, "modified_dateutc": "2025-04-02T01:53:29.8349647+00:00" }, "equipment_family_id": "0d4d6d83-8039-49cf-b942-21f367f4add7", "equipment_family_code": "sample string 8", "equipment_family": { "id": "6c70f867-1702-4916-9297-8afafe07395b", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "b8723a05-69a6-41cc-98b7-24db607a53d1", "_parent_code": "sample string 6", "sales_organization_id": "944f1751-8ac2-4a02-bf4a-9a77b2810c76", "sales_organization_code": "sample string 8", "sales_organization": { "id": "39025d85-2b7b-41f6-a61c-97e48c68360f", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "5f93bd1e-1320-4fff-90fd-027061d42a5b", "db_currency_id": "ff4d94b3-0fea-4250-b2c6-fc94c6297402", "db_language_id": "1899805a-8d0b-4bf9-b158-014f9b8da413", "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-04-02T01:53:29.8349647+00:00" }, "modified_dateutc": "2025-04-02T01:53:29.8349647+00:00" }, "date_in_production_since": "2025-04-02T01:53:29.8349647+00:00", "date_out_of_production_since": "2025-04-02T01:53:29.8349647+00:00", "date_end_support": "2025-04-02T01:53:29.8349647+00:00", "sales_organization_id": "42875c1f-b94e-47f2-a138-43a404412fa1", "sales_organization_code": "sample string 13", "sales_organization": { "id": "39025d85-2b7b-41f6-a61c-97e48c68360f", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "5f93bd1e-1320-4fff-90fd-027061d42a5b", "db_currency_id": "ff4d94b3-0fea-4250-b2c6-fc94c6297402", "db_language_id": "1899805a-8d0b-4bf9-b158-014f9b8da413", "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-04-02T01:53:29.8349647+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-04-02T01:53:29.8349647+00:00" }, "project_status_id": "667bf086-80bf-4ae8-a10e-a8afb5e17e98", "project_status_code": "sample string 10", "project_status": { "id": "b9c19579-28a8-42f8-8013-375c1354f4a3", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "0f6b470c-1291-492e-a520-dcf40b9ae7d3", "sales_organization_code": "sample string 6", "sales_organization": { "id": "39025d85-2b7b-41f6-a61c-97e48c68360f", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "5f93bd1e-1320-4fff-90fd-027061d42a5b", "db_currency_id": "ff4d94b3-0fea-4250-b2c6-fc94c6297402", "db_language_id": "1899805a-8d0b-4bf9-b158-014f9b8da413", "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-04-02T01:53:29.8349647+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-04-02T01:53:29.8349647+00:00" }, "company_id": "224d93c4-a80b-4f7d-8743-2dfdbd8f0b94", "company_code": "sample string 12", "db_address_id": "ef09f62d-1129-4778-9aba-5580c3823b66", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "86916c4d-895b-4170-b9c6-77d226cbe1d9", "contact_reference_back_office": "sample string 17", "owner_user_id": "8a5e0329-6e9c-431c-b69c-c91e38931150", "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-04-02T01:53:29.8349647+00:00", "date_create": "2025-04-02T01:53:29.8349647+00:00", "date_update": "2025-04-02T01:53:29.8349647+00:00", "updated_by_user_id": "378b1af4-dfad-4e14-966a-2339ff677765", "customer_reference": "sample string 28", "warranty_date_until": "2025-04-02T01:53:29.8349647+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-04-02T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-04-02T01:53:29.8349647+00:00", "date_last_job": "2025-04-02T01:53:29.8349647+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-04-02T01:53:29.8349647+00:00", "modified_dateutc": "2025-04-02T01:53:29.8349647+00:00", "is_mobile_installation": true }, "job_type_id": "d058db2c-82a3-4cc7-98f4-92929393f4ae", "job_type_code": "sample string 7", "job_type": { "id": "1afd5296-756d-431f-9fd1-a3a3285e0f1a", "name": "sample string 2", "sales_organization_id": "57351bff-3cb1-4082-bfe8-a58eb316a946", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-04-02T01:53:29.8349647+00:00", "code": "sample string 7" }, "job_priority_id": "fc606b4e-d13a-4f06-bc9d-3feb578a7a47", "job_priority_code": "sample string 9", "job_priority": { "id": "106cd9a4-124e-48d0-891b-e57667f50ac4", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "a80ad42b-3e73-4fb9-b4bb-f8491d08f920", "sales_organization_code": "sample string 6", "sales_organization": { "id": "39025d85-2b7b-41f6-a61c-97e48c68360f", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "5f93bd1e-1320-4fff-90fd-027061d42a5b", "db_currency_id": "ff4d94b3-0fea-4250-b2c6-fc94c6297402", "db_language_id": "1899805a-8d0b-4bf9-b158-014f9b8da413", "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-04-02T01:53:29.8349647+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-04-02T01:53:29.8349647+00:00" }, "job_status_id": "2d44b0f4-742f-4882-8b9f-73a126e0b05e", "job_status_code": "sample string 11", "db_address_id": "9639847c-4e4c-4191-be63-70072971ebe8", "contact_id": "263f6406-cc43-4c43-bee0-302fb4ec903e", "requested_by_company_id": "ed50fb3a-8671-4bdb-adaa-9712c1699d27", "requested_by_contact_id": "8e682a82-56c9-4f72-badb-f716716a2464", "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-04-02T01:53:29.8349647+00:00", "due_date": "2025-04-02T01:53:29.8349647+00:00", "date_create": "2025-04-02T01:53:29.8349647+00:00", "date_update": "2025-04-02T01:53:29.8349647+00:00", "date_closed": "2025-04-02T01:53:29.8349647+00:00", "suggested_user_id": "6ba76c7c-0469-4422-94fa-38979d24472e", "suggested_user_code": "sample string 29", "suggested_user": { "id": "17f10cc0-068a-47b8-842e-f6bbd5362923", "db_language_id": "285efaf6-ce37-4e47-b893-a32b6c59e30f", "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-04-02T01:53:29.8349647+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "0ecdaa85-8eb4-4f9b-bee3-738775d99036", "sales_organization": { "id": "39025d85-2b7b-41f6-a61c-97e48c68360f", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "5f93bd1e-1320-4fff-90fd-027061d42a5b", "db_currency_id": "ff4d94b3-0fea-4250-b2c6-fc94c6297402", "db_language_id": "1899805a-8d0b-4bf9-b158-014f9b8da413", "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-04-02T01:53:29.8349647+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "015c200c-09ac-4d14-8f69-64b751917f41", "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": "f42d6043-d6b2-4380-8479-f3a11ea91783", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-04-02T01:53:29.8349647+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "cd32899d-3316-46c3-a91a-8d422fbd6269" }, "suggested_date_start": "2025-04-02T01:53:29.8349647+00:00", "skill_id": "0ed4447a-c4aa-45f3-a041-ba5fc8e64702", "skill_code": "sample string 32", "skill": { "id": "d6f22b4e-35db-475f-bc4c-e71a091623cf", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "64d2f929-78f2-4313-8178-674e901a9aef", "sales_organization_code": "sample string 6", "sales_organization": { "id": "39025d85-2b7b-41f6-a61c-97e48c68360f", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "5f93bd1e-1320-4fff-90fd-027061d42a5b", "db_currency_id": "ff4d94b3-0fea-4250-b2c6-fc94c6297402", "db_language_id": "1899805a-8d0b-4bf9-b158-014f9b8da413", "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-04-02T01:53:29.8349647+00:00" }, "modified_dateutc": "2025-04-02T01:53:29.8349647+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "cf0fb682-eeb7-4674-8e90-a32b4fce3305", "date_reported_by_company": "2025-04-02T01:53:29.8349647+00:00", "id2": 36, "company_id": "bdb5b3b3-e518-4b00-bb36-314f3e3568af", "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": "b705b8c1-5389-442a-a0bc-f5001c1266da", "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-04-02T01:53:29.8349647+00:00" }
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.