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": "fb46177b-92df-4a4a-8810-4195b89d1939", "_parent_id": "e2f7ba92-d7d7-41bb-89c5-bb4ae067941e", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "de9a0a5a-3b30-4892-a819-9bf230e8fa40", "project_reference_back_office": "sample string 5", "project": { "id": "29fc5703-d1fb-4ee7-8eec-70e7e1a29b6d", "_parent_id": "add8e10d-5ccb-4246-9840-b27a7778f0ac", "root_parent_id": "891580b6-441b-4e9c-8bb5-002758e4bc36", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "49e518fe-f6a2-4961-8c41-c71122b33739", "equipment_family_code": "sample string 6", "equipment_family": { "id": "1050fe22-b84d-4583-bbe2-090c88c39c2c", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "458f398e-0fe7-4a00-b33a-2dbfa36a4f11", "_parent_code": "sample string 6", "sales_organization_id": "71a26bed-0df9-4127-b9c9-cf59e4ecd3a4", "sales_organization_code": "sample string 8", "sales_organization": { "id": "a313ee71-4e77-4d58-8018-6e55b555219e", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "d09f80c1-ca8f-439a-a905-75f3f2a13310", "db_currency_id": "761fd03f-a9fa-4109-960a-8f07d2583206", "db_language_id": "18181185-d244-4488-9769-61173b585a5f", "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-02-05T06:37:33.4705785+00:00" }, "modified_dateutc": "2025-02-05T06:37:33.4705785+00:00" }, "equipment_model_id": "3c7c1a6f-7b2a-44ec-aff7-d182cbc65413", "equipment_model_code": "sample string 8", "equipment_model": { "id": "ae475ead-e893-42f9-8290-1aef887ee6a7", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "7aa911db-aaa6-4465-8bd6-0b092eb05385", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "1c170dac-4f46-4a1e-8057-870ea8a28778", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "1a10cc13-8fa5-4b4c-8f0c-c156b5e76cbe", "sales_organization_code": "sample string 5", "sales_organization": { "id": "a313ee71-4e77-4d58-8018-6e55b555219e", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "d09f80c1-ca8f-439a-a905-75f3f2a13310", "db_currency_id": "761fd03f-a9fa-4109-960a-8f07d2583206", "db_language_id": "18181185-d244-4488-9769-61173b585a5f", "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-02-05T06:37:33.4705785+00:00" }, "modified_dateutc": "2025-02-05T06:37:33.4705785+00:00" }, "equipment_family_id": "3dd5a463-3c9b-42eb-b170-8d0c38d7c6ba", "equipment_family_code": "sample string 8", "equipment_family": { "id": "1050fe22-b84d-4583-bbe2-090c88c39c2c", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "458f398e-0fe7-4a00-b33a-2dbfa36a4f11", "_parent_code": "sample string 6", "sales_organization_id": "71a26bed-0df9-4127-b9c9-cf59e4ecd3a4", "sales_organization_code": "sample string 8", "sales_organization": { "id": "a313ee71-4e77-4d58-8018-6e55b555219e", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "d09f80c1-ca8f-439a-a905-75f3f2a13310", "db_currency_id": "761fd03f-a9fa-4109-960a-8f07d2583206", "db_language_id": "18181185-d244-4488-9769-61173b585a5f", "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-02-05T06:37:33.4705785+00:00" }, "modified_dateutc": "2025-02-05T06:37:33.4705785+00:00" }, "date_in_production_since": "2025-02-05T06:37:33.4705785+00:00", "date_out_of_production_since": "2025-02-05T06:37:33.4705785+00:00", "date_end_support": "2025-02-05T06:37:33.4705785+00:00", "sales_organization_id": "6834fc93-6e03-4ea8-b99a-325eae85e257", "sales_organization_code": "sample string 13", "sales_organization": { "id": "a313ee71-4e77-4d58-8018-6e55b555219e", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "d09f80c1-ca8f-439a-a905-75f3f2a13310", "db_currency_id": "761fd03f-a9fa-4109-960a-8f07d2583206", "db_language_id": "18181185-d244-4488-9769-61173b585a5f", "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-02-05T06:37:33.4705785+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-02-05T06:37:33.4705785+00:00" }, "project_status_id": "5d73b3d9-7c7d-4fa6-a356-32e1d1c2eba7", "project_status_code": "sample string 10", "project_status": { "id": "9285cdcf-9da2-44e5-82cf-fd15997a4d17", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "a002d05f-03bd-4ca8-b17a-1004583c3153", "sales_organization_code": "sample string 6", "sales_organization": { "id": "a313ee71-4e77-4d58-8018-6e55b555219e", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "d09f80c1-ca8f-439a-a905-75f3f2a13310", "db_currency_id": "761fd03f-a9fa-4109-960a-8f07d2583206", "db_language_id": "18181185-d244-4488-9769-61173b585a5f", "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-02-05T06:37:33.4705785+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-02-05T06:37:33.4705785+00:00" }, "company_id": "3a0f7647-fcc8-4e00-b322-60393ee411d4", "company_code": "sample string 12", "db_address_id": "c646d6a3-9186-400e-9215-27923b18832f", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "4600c5bc-f35e-473a-9906-94d929b5e0ec", "contact_reference_back_office": "sample string 17", "owner_user_id": "4ee11344-79f7-4761-9565-effa022875c1", "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-02-05T06:37:33.4705785+00:00", "date_create": "2025-02-05T06:37:33.4705785+00:00", "date_update": "2025-02-05T06:37:33.4705785+00:00", "updated_by_user_id": "358bb7ae-5a6a-4ff1-90d4-ab4b83e50021", "customer_reference": "sample string 28", "warranty_date_until": "2025-02-05T06:37:33.4705785+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-02-05T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-02-05T06:37:33.4705785+00:00", "date_last_job": "2025-02-05T06:37:33.4705785+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-02-05T06:37:33.4705785+00:00", "modified_dateutc": "2025-02-05T06:37:33.4705785+00:00", "is_mobile_installation": true }, "job_type_id": "e30eadcc-fa1b-470d-9775-3aed37774fae", "job_type_code": "sample string 7", "job_type": { "id": "70ddf9be-c4d3-420a-b669-405e6872fb9e", "name": "sample string 2", "sales_organization_id": "2db96201-08ae-4938-aaf5-ecef1a51b51d", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-02-05T06:37:33.4705785+00:00", "code": "sample string 7" }, "job_priority_id": "4e47afcf-3777-49aa-a3db-2d3522a11086", "job_priority_code": "sample string 9", "job_priority": { "id": "df6d3d8b-802c-49d1-bd0b-f6f6692a558a", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "a7d2b600-9ea9-48e7-95d1-831142aceb59", "sales_organization_code": "sample string 6", "sales_organization": { "id": "a313ee71-4e77-4d58-8018-6e55b555219e", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "d09f80c1-ca8f-439a-a905-75f3f2a13310", "db_currency_id": "761fd03f-a9fa-4109-960a-8f07d2583206", "db_language_id": "18181185-d244-4488-9769-61173b585a5f", "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-02-05T06:37:33.4705785+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-02-05T06:37:33.4705785+00:00" }, "job_status_id": "8dd7114c-2891-4196-8666-2dd2360cd7d1", "job_status_code": "sample string 11", "db_address_id": "ce992cdc-b58f-4058-9ab7-e26163485a7f", "contact_id": "fd8f48c9-8b29-4247-b0f2-4a611d7336f2", "requested_by_company_id": "86856a10-8db9-4957-aad5-8a1e6223fced", "requested_by_contact_id": "a49ba3b8-15f6-461a-bb24-7fcefb5cc649", "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-02-05T06:37:33.4705785+00:00", "due_date": "2025-02-05T06:37:33.4705785+00:00", "date_create": "2025-02-05T06:37:33.4705785+00:00", "date_update": "2025-02-05T06:37:33.4705785+00:00", "date_closed": "2025-02-05T06:37:33.4705785+00:00", "suggested_user_id": "91231247-c2a7-4772-92f5-aba68001879e", "suggested_user_code": "sample string 29", "suggested_user": { "id": "4209da03-fd02-436a-b2ff-083ee28fe880", "db_language_id": "d7677031-1883-4880-b24d-ed03f5c26ab4", "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-02-05T06:37:33.4705785+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "0c56cb62-cd60-4fa1-b30b-0526d50033d1", "sales_organization": { "id": "a313ee71-4e77-4d58-8018-6e55b555219e", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "d09f80c1-ca8f-439a-a905-75f3f2a13310", "db_currency_id": "761fd03f-a9fa-4109-960a-8f07d2583206", "db_language_id": "18181185-d244-4488-9769-61173b585a5f", "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-02-05T06:37:33.4705785+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "0d1395aa-c147-4829-ad79-912ae71f93fc", "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": "5534ddb9-75f9-4179-b92b-9984ad4ce7a9", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-02-05T06:37:33.4705785+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "29e6e001-66ba-4a8c-a1e9-3614d617534d" }, "suggested_date_start": "2025-02-05T06:37:33.4705785+00:00", "skill_id": "81e6f179-8f95-47a9-aa5a-cdbc81ff6d55", "skill_code": "sample string 32", "skill": { "id": "3c4d45d2-3fa3-4eae-bd48-309c8ac1f365", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "eb32a0b4-b31c-4cd9-8bc5-4ff84b7bb6d9", "sales_organization_code": "sample string 6", "sales_organization": { "id": "a313ee71-4e77-4d58-8018-6e55b555219e", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "d09f80c1-ca8f-439a-a905-75f3f2a13310", "db_currency_id": "761fd03f-a9fa-4109-960a-8f07d2583206", "db_language_id": "18181185-d244-4488-9769-61173b585a5f", "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-02-05T06:37:33.4705785+00:00" }, "modified_dateutc": "2025-02-05T06:37:33.4705785+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "cb57c783-9dce-4fba-a1a7-b77bb1fa6bfb", "date_reported_by_company": "2025-02-05T06:37:33.4705785+00:00", "id2": 36, "company_id": "a5b67766-2cb6-479a-9833-90bef77812fd", "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": "4e228d68-77aa-49ff-a675-0408e71ac4b1", "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-02-05T06:37:33.4705785+00:00" }
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.