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": "2f1c788a-1e25-4fd0-8556-6790e843513c", "_parent_id": "09a325d6-698c-458b-b0ef-82aca4f1c7a4", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "f2d357c6-e588-4eb4-bc7c-77717440680d", "project_reference_back_office": "sample string 5", "project": { "id": "9037f82d-328c-4092-8696-9a4fdd590dd0", "_parent_id": "12e0a31c-b9bc-4eb0-9f03-c96451336381", "root_parent_id": "9972d6f8-1d16-411d-a5c7-d6509cea6f76", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "dc60b9fa-09a1-46a1-8660-9ab8db9c202f", "equipment_family_code": "sample string 6", "equipment_family": { "id": "19f23945-bf02-4d26-a3fb-716955b183c9", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "bfb60bbc-0d04-4aae-b8e9-b2bc83bf9b59", "_parent_code": "sample string 6", "sales_organization_id": "5c217a06-9b06-4622-b406-ff4c982b8f36", "sales_organization_code": "sample string 8", "sales_organization": { "id": "d718ce26-ae96-4962-bc8f-8426f1c16299", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "f8cf6597-ad7b-4f25-bf0e-9e3d3a737aa9", "db_currency_id": "a0512e73-7101-4295-8fa9-d46d1d181ebb", "db_language_id": "82f86515-d0d6-4687-ad2b-95e554d4af6e", "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-28T22:42:46.3200599+00:00" }, "modified_dateutc": "2025-05-28T22:42:46.3200599+00:00" }, "equipment_model_id": "5de3d827-27ba-4372-94f7-bc6b3b3d4205", "equipment_model_code": "sample string 8", "equipment_model": { "id": "efc6e392-cfcd-43ec-ac4f-4ec35fb5da99", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "7cce7cb9-fc8b-46b4-8015-b07ade7aa747", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "9de8c3cd-851d-4fc8-8f24-f9906c1fac7d", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "5ddb9b11-a6c7-4926-b258-48f8ffb4b0b5", "sales_organization_code": "sample string 5", "sales_organization": { "id": "d718ce26-ae96-4962-bc8f-8426f1c16299", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "f8cf6597-ad7b-4f25-bf0e-9e3d3a737aa9", "db_currency_id": "a0512e73-7101-4295-8fa9-d46d1d181ebb", "db_language_id": "82f86515-d0d6-4687-ad2b-95e554d4af6e", "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-28T22:42:46.3200599+00:00" }, "modified_dateutc": "2025-05-28T22:42:46.3200599+00:00" }, "equipment_family_id": "7ebc2af9-6101-493c-bcbe-8a7126e6079c", "equipment_family_code": "sample string 8", "equipment_family": { "id": "19f23945-bf02-4d26-a3fb-716955b183c9", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "bfb60bbc-0d04-4aae-b8e9-b2bc83bf9b59", "_parent_code": "sample string 6", "sales_organization_id": "5c217a06-9b06-4622-b406-ff4c982b8f36", "sales_organization_code": "sample string 8", "sales_organization": { "id": "d718ce26-ae96-4962-bc8f-8426f1c16299", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "f8cf6597-ad7b-4f25-bf0e-9e3d3a737aa9", "db_currency_id": "a0512e73-7101-4295-8fa9-d46d1d181ebb", "db_language_id": "82f86515-d0d6-4687-ad2b-95e554d4af6e", "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-28T22:42:46.3200599+00:00" }, "modified_dateutc": "2025-05-28T22:42:46.3200599+00:00" }, "date_in_production_since": "2025-05-28T22:42:46.3200599+00:00", "date_out_of_production_since": "2025-05-28T22:42:46.3200599+00:00", "date_end_support": "2025-05-28T22:42:46.3200599+00:00", "sales_organization_id": "5a4071f9-f418-4cde-993c-778c4373897b", "sales_organization_code": "sample string 13", "sales_organization": { "id": "d718ce26-ae96-4962-bc8f-8426f1c16299", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "f8cf6597-ad7b-4f25-bf0e-9e3d3a737aa9", "db_currency_id": "a0512e73-7101-4295-8fa9-d46d1d181ebb", "db_language_id": "82f86515-d0d6-4687-ad2b-95e554d4af6e", "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-28T22:42:46.3200599+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-28T22:42:46.3200599+00:00" }, "project_status_id": "e9ef1584-7928-4f46-bf4f-01a1c1cbc001", "project_status_code": "sample string 10", "project_status": { "id": "f7e3b3f4-0e9c-4569-992c-03eee335e112", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "a3755a6c-937e-4ee3-a189-dff44176490c", "sales_organization_code": "sample string 6", "sales_organization": { "id": "d718ce26-ae96-4962-bc8f-8426f1c16299", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "f8cf6597-ad7b-4f25-bf0e-9e3d3a737aa9", "db_currency_id": "a0512e73-7101-4295-8fa9-d46d1d181ebb", "db_language_id": "82f86515-d0d6-4687-ad2b-95e554d4af6e", "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-28T22:42:46.3200599+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-05-28T22:42:46.3200599+00:00" }, "company_id": "bc580e72-b0c5-4df0-8207-0a1d6c2f0013", "company_code": "sample string 12", "db_address_id": "5f787b0d-c1c6-4fc5-ab03-503bc597a703", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "0063e4aa-d8cc-42ba-a0bf-1ddf6844e048", "contact_reference_back_office": "sample string 17", "owner_user_id": "eaf4281b-5359-49e4-89c1-6f74fbec0960", "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-28T22:42:46.3200599+00:00", "date_create": "2025-05-28T22:42:46.3200599+00:00", "date_update": "2025-05-28T22:42:46.3200599+00:00", "updated_by_user_id": "723c7865-173a-4d4b-96ed-badf0e66e629", "customer_reference": "sample string 28", "warranty_date_until": "2025-05-28T22:42:46.3200599+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-28T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-05-28T22:42:46.3200599+00:00", "date_last_job": "2025-05-28T22:42:46.3200599+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-05-28T22:42:46.3200599+00:00", "modified_dateutc": "2025-05-28T22:42:46.3200599+00:00", "is_mobile_installation": true }, "job_type_id": "323c8193-da5e-446c-a0fd-1d69d665e740", "job_type_code": "sample string 7", "job_type": { "id": "f21b478d-5e71-443b-b5bf-d3b693ece42e", "name": "sample string 2", "sales_organization_id": "45fe0cf6-81e4-46b2-8f70-21a1fd1ff418", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-05-28T22:42:46.3200599+00:00", "code": "sample string 7" }, "job_priority_id": "51037daa-68ab-4277-bad0-5ea10e7a3afe", "job_priority_code": "sample string 9", "job_priority": { "id": "a227d765-f9c0-497c-a2cc-69c75ba1bbb1", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "8c14f0ac-86d2-4ff0-848b-cd98f2789693", "sales_organization_code": "sample string 6", "sales_organization": { "id": "d718ce26-ae96-4962-bc8f-8426f1c16299", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "f8cf6597-ad7b-4f25-bf0e-9e3d3a737aa9", "db_currency_id": "a0512e73-7101-4295-8fa9-d46d1d181ebb", "db_language_id": "82f86515-d0d6-4687-ad2b-95e554d4af6e", "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-28T22:42:46.3200599+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-05-28T22:42:46.3200599+00:00" }, "job_status_id": "f6499900-9d18-4922-a569-79974ae8aa38", "job_status_code": "sample string 11", "db_address_id": "1dadf890-1a81-4170-8a7e-a8e47a9a08fb", "contact_id": "60a81712-8e80-4f7f-b8c2-f5014e2aa698", "requested_by_company_id": "5f0923c7-11e0-49d3-b782-c8c9c375a25a", "requested_by_contact_id": "17e3121a-553d-45e4-844e-a21f086f5cd3", "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-28T22:42:46.3200599+00:00", "due_date": "2025-05-28T22:42:46.3200599+00:00", "date_create": "2025-05-28T22:42:46.3200599+00:00", "date_update": "2025-05-28T22:42:46.3200599+00:00", "date_closed": "2025-05-28T22:42:46.3200599+00:00", "suggested_user_id": "14c6b80d-d392-4992-8da3-864839ce714a", "suggested_user_code": "sample string 29", "suggested_user": { "id": "2a57a210-72f7-443a-801c-9330c72216d1", "db_language_id": "50c378c9-076a-4a17-9594-1f471973ba59", "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-28T22:42:46.3200599+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "bd94d587-9903-41ed-a8e3-7f5c102bea17", "sales_organization": { "id": "d718ce26-ae96-4962-bc8f-8426f1c16299", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "f8cf6597-ad7b-4f25-bf0e-9e3d3a737aa9", "db_currency_id": "a0512e73-7101-4295-8fa9-d46d1d181ebb", "db_language_id": "82f86515-d0d6-4687-ad2b-95e554d4af6e", "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-28T22:42:46.3200599+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "0e05bec7-c13d-4434-9e7c-d263179aec91", "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": "c532beeb-7ea3-43c8-a57f-a25d1680e32f", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-05-28T22:42:46.3200599+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "16573a38-c10e-4ac8-9739-30f06dda5627" }, "suggested_date_start": "2025-05-28T22:42:46.3200599+00:00", "skill_id": "441b806b-d6cf-44b3-9a9f-73448be39ed9", "skill_code": "sample string 32", "skill": { "id": "17df01d3-d825-49e6-a5f9-1121c29eb04c", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "88227b37-8015-4660-8eb8-9ed1e35fb844", "sales_organization_code": "sample string 6", "sales_organization": { "id": "d718ce26-ae96-4962-bc8f-8426f1c16299", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "f8cf6597-ad7b-4f25-bf0e-9e3d3a737aa9", "db_currency_id": "a0512e73-7101-4295-8fa9-d46d1d181ebb", "db_language_id": "82f86515-d0d6-4687-ad2b-95e554d4af6e", "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-28T22:42:46.3200599+00:00" }, "modified_dateutc": "2025-05-28T22:42:46.3200599+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "0a4c45b3-f8cf-44dc-8057-ab07e73bed82", "date_reported_by_company": "2025-05-28T22:42:46.3200599+00:00", "id2": 36, "company_id": "30e55b7d-2ac0-42bd-9e86-36865c41680f", "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": "7875a3f2-bc1b-4145-9d79-08046932e2b4", "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-28T22:42:46.3200599+00:00" }
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.