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": "e3187510-b9f4-49d8-b43a-9f0ffcb542c7", "_parent_id": "9bb6c01b-9792-4c6d-a0c3-59078957b6be", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "dc734184-c3b5-4fb9-9e5a-54fc49452e07", "project_reference_back_office": "sample string 5", "project": { "id": "39fb4b28-6f46-4152-b917-8a3472414d01", "_parent_id": "e4858470-32f4-42f8-a1e0-10c4d905b893", "root_parent_id": "5ccabe60-650a-4475-a150-5f5138c07142", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "b3da109c-8d76-443c-b2f1-437986cb85a4", "equipment_family_code": "sample string 6", "equipment_family": { "id": "3549d7f9-facf-46ef-8cd4-ca5371a13cc6", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "bebdc565-c0a3-420a-bddf-dd9834430f1b", "_parent_code": "sample string 6", "sales_organization_id": "874a718b-d070-4a2d-bf1d-39915488258b", "sales_organization_code": "sample string 8", "sales_organization": { "id": "4d9271dc-5c17-4f53-98db-d554c8c5a516", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "7579f548-497a-4d74-a2c8-94b9a822a597", "db_currency_id": "9b3093b7-97e6-4b18-86f0-91ca575e7f30", "db_language_id": "f46a2ab8-c9b3-41ec-9426-f724ff9f2727", "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": "2023-11-04T08:17:17.4641165+00:00" }, "modified_dateutc": "2023-11-04T08:17:17.4641165+00:00" }, "equipment_model_id": "7c717aca-e76f-43c2-a93f-4bd1ee8e5a2e", "equipment_model_code": "sample string 8", "equipment_model": { "id": "2fa5bf8e-7b92-4895-9481-c93c337bad37", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "1735ead1-930c-41b2-8831-47cce9b461a2", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "5a71b61d-1952-465e-bb11-c1a8d15de552", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "62beff4c-c19d-4dfb-9c69-b28e752ebd97", "sales_organization_code": "sample string 5", "sales_organization": { "id": "4d9271dc-5c17-4f53-98db-d554c8c5a516", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "7579f548-497a-4d74-a2c8-94b9a822a597", "db_currency_id": "9b3093b7-97e6-4b18-86f0-91ca575e7f30", "db_language_id": "f46a2ab8-c9b3-41ec-9426-f724ff9f2727", "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": "2023-11-04T08:17:17.4641165+00:00" }, "modified_dateutc": "2023-11-04T08:17:17.4641165+00:00" }, "equipment_family_id": "e7c283cd-69bc-4bbc-9603-5479f7eff8fc", "equipment_family_code": "sample string 8", "equipment_family": { "id": "3549d7f9-facf-46ef-8cd4-ca5371a13cc6", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "bebdc565-c0a3-420a-bddf-dd9834430f1b", "_parent_code": "sample string 6", "sales_organization_id": "874a718b-d070-4a2d-bf1d-39915488258b", "sales_organization_code": "sample string 8", "sales_organization": { "id": "4d9271dc-5c17-4f53-98db-d554c8c5a516", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "7579f548-497a-4d74-a2c8-94b9a822a597", "db_currency_id": "9b3093b7-97e6-4b18-86f0-91ca575e7f30", "db_language_id": "f46a2ab8-c9b3-41ec-9426-f724ff9f2727", "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": "2023-11-04T08:17:17.4641165+00:00" }, "modified_dateutc": "2023-11-04T08:17:17.4641165+00:00" }, "date_in_production_since": "2023-11-04T08:17:17.4641165+00:00", "date_out_of_production_since": "2023-11-04T08:17:17.4641165+00:00", "date_end_support": "2023-11-04T08:17:17.4641165+00:00", "sales_organization_id": "a1d3a9c4-59a7-4e41-8c85-39f6e1813de6", "sales_organization_code": "sample string 13", "sales_organization": { "id": "4d9271dc-5c17-4f53-98db-d554c8c5a516", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "7579f548-497a-4d74-a2c8-94b9a822a597", "db_currency_id": "9b3093b7-97e6-4b18-86f0-91ca575e7f30", "db_language_id": "f46a2ab8-c9b3-41ec-9426-f724ff9f2727", "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": "2023-11-04T08:17:17.4641165+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": "2023-11-04T08:17:17.4641165+00:00" }, "project_status_id": "6dc70c2d-b68d-4b09-a5c0-286ef7481715", "project_status_code": "sample string 10", "project_status": { "id": "9e12e1ee-da96-4ac9-b75e-7c7b81357d3e", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "2ab5b45c-c89f-425e-bcbd-682a20ca86e1", "sales_organization_code": "sample string 6", "sales_organization": { "id": "4d9271dc-5c17-4f53-98db-d554c8c5a516", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "7579f548-497a-4d74-a2c8-94b9a822a597", "db_currency_id": "9b3093b7-97e6-4b18-86f0-91ca575e7f30", "db_language_id": "f46a2ab8-c9b3-41ec-9426-f724ff9f2727", "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": "2023-11-04T08:17:17.4641165+00:00" }, "code": "sample string 7", "modified_dateutc": "2023-11-04T08:17:17.4641165+00:00" }, "company_id": "b74ec9a3-2dab-4523-887a-39e5bacdd4ff", "company_code": "sample string 12", "db_address_id": "06765004-1176-474a-8988-46465c305fd7", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "50c88637-68f5-4f8f-a15c-c48b29a4d87e", "contact_reference_back_office": "sample string 17", "owner_user_id": "fda7b440-d675-47ed-9381-9b3f4fe8a8a7", "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": "2023-11-04T08:17:17.4641165+00:00", "date_create": "2023-11-04T08:17:17.4641165+00:00", "date_update": "2023-11-04T08:17:17.4641165+00:00", "updated_by_user_id": "3f75cd4f-e4ee-465e-9dc4-2daf603a0a5f", "customer_reference": "sample string 28", "warranty_date_until": "2023-11-04T08:17:17.4641165+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": "2023-11-04T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2023-11-04T08:17:17.4641165+00:00", "date_last_job": "2023-11-04T08:17:17.4641165+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2023-11-04T08:17:17.4641165+00:00", "modified_dateutc": "2023-11-04T08:17:17.4641165+00:00", "is_mobile_installation": true }, "job_type_id": "704505fa-4e8f-463c-9c85-e14482efd4ba", "job_type_code": "sample string 7", "job_type": { "id": "c167dcad-a97a-4e35-ab52-f68d2bb0e7ab", "name": "sample string 2", "sales_organization_id": "95c9da93-e8ef-4d49-8c6e-178acd5a5e3a", "description": "sample string 4", "is_default": true, "modified_dateutc": "2023-11-04T08:17:17.4641165+00:00", "code": "sample string 7" }, "job_priority_id": "3dfbf8bf-59ea-411e-8b2b-742efb4f0e2b", "job_priority_code": "sample string 9", "job_priority": { "id": "ad59edc8-536e-4da1-8c2b-9b3dc5104a0d", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "064f579c-531f-404f-b5de-d6f156dd388c", "sales_organization_code": "sample string 6", "sales_organization": { "id": "4d9271dc-5c17-4f53-98db-d554c8c5a516", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "7579f548-497a-4d74-a2c8-94b9a822a597", "db_currency_id": "9b3093b7-97e6-4b18-86f0-91ca575e7f30", "db_language_id": "f46a2ab8-c9b3-41ec-9426-f724ff9f2727", "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": "2023-11-04T08:17:17.4641165+00:00" }, "code": "sample string 7", "modified_dateutc": "2023-11-04T08:17:17.4641165+00:00" }, "job_status_id": "5041fb18-5293-4468-9a1b-53947df59807", "job_status_code": "sample string 11", "db_address_id": "241e17d0-bfda-4367-9cd2-ec365ba2f330", "contact_id": "2cf10384-9e1d-4e6c-9c6e-cf87a5cd46ac", "requested_by_company_id": "2df1b2fb-8a2f-4036-b144-eae3f7ddc9cf", "requested_by_contact_id": "4734093f-ab51-4d44-a91a-b90a21269fb2", "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": "2023-11-04T08:17:17.4641165+00:00", "due_date": "2023-11-04T08:17:17.4641165+00:00", "date_create": "2023-11-04T08:17:17.4641165+00:00", "date_update": "2023-11-04T08:17:17.4641165+00:00", "date_closed": "2023-11-04T08:17:17.4641165+00:00", "suggested_user_id": "4083347c-36e7-43db-bd14-446eeea67366", "suggested_user_code": "sample string 29", "suggested_user": { "id": "7a995b4e-a645-4bd5-8e4e-58d389961526", "db_language_id": "0dbdf8cb-e653-412f-b5a6-973ec81eb589", "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": "2023-11-04T08:17:17.4641165+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "f16f0620-3bc7-4557-86f4-656709198368", "sales_organization": { "id": "4d9271dc-5c17-4f53-98db-d554c8c5a516", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "7579f548-497a-4d74-a2c8-94b9a822a597", "db_currency_id": "9b3093b7-97e6-4b18-86f0-91ca575e7f30", "db_language_id": "f46a2ab8-c9b3-41ec-9426-f724ff9f2727", "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": "2023-11-04T08:17:17.4641165+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "5dd24c2e-6152-411d-a508-11102de0286a", "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": "9d01664b-aa7d-45bb-a4e8-0fca20a9c225", "private_db_country_code": "sample string 35", "modified_dateutc": "2023-11-04T08:17:17.4641165+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "1de799f3-4e48-4f31-9023-63f26d762d0e" }, "suggested_date_start": "2023-11-04T08:17:17.4641165+00:00", "skill_id": "728ecd96-5fd8-44b3-8f92-63391536db1a", "skill_code": "sample string 32", "skill": { "id": "713ec41d-35b7-4298-8f7a-391e81d0f1f5", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "0a1feaba-0bf1-419a-ae4c-d357d12978c2", "sales_organization_code": "sample string 6", "sales_organization": { "id": "4d9271dc-5c17-4f53-98db-d554c8c5a516", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "7579f548-497a-4d74-a2c8-94b9a822a597", "db_currency_id": "9b3093b7-97e6-4b18-86f0-91ca575e7f30", "db_language_id": "f46a2ab8-c9b3-41ec-9426-f724ff9f2727", "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": "2023-11-04T08:17:17.4641165+00:00" }, "modified_dateutc": "2023-11-04T08:17:17.4641165+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "9187798e-5c99-447d-9ee9-cfb23e6095f9", "date_reported_by_company": "2023-11-04T08:17:17.4641165+00:00", "id2": 36, "company_id": "de8531cc-703c-466f-918d-5d6049689ed9", "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": "789ae640-5137-4ab2-98e1-3ee167730e83", "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": "2023-11-04T08:17:17.4641165+00:00" }
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.