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": "338b7995-d15d-47a1-abb8-72cf0d46273f", "_parent_id": "f25ae483-1933-41f9-87c1-eb67db573183", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "d46d38c1-577d-4e69-b15e-22758368df6e", "project_reference_back_office": "sample string 5", "project": { "id": "b79e6a6c-8d69-400b-a782-248006c96d4f", "_parent_id": "f5c0e012-9e1c-48c5-82ce-a5e99c0ac7ee", "root_parent_id": "fecfe9dc-d61a-46fc-a8f2-bdc2fa513370", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "1f0553c0-b0d5-4e92-9c1f-ebc8df3142a2", "equipment_family_code": "sample string 6", "equipment_family": { "id": "8d0f49d6-1b11-48da-9a4e-9df57f4f3786", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "ca8dcf5e-8bff-40ab-b82d-ed138c1d5437", "_parent_code": "sample string 6", "sales_organization_id": "99a2b45c-33c9-403a-ac22-5b1218638e88", "sales_organization_code": "sample string 8", "sales_organization": { "id": "68b88f5c-9698-4ff2-b06f-76bab4a233a7", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "e9e8b16a-49ee-4e40-b629-d5d2012f7c5a", "db_currency_id": "e97c972d-65ba-47f7-8dfc-c7c1fa649469", "db_language_id": "8d32c509-f1de-4162-9b02-71833d5ec534", "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": "2024-04-16T19:17:26.5995649+00:00" }, "modified_dateutc": "2024-04-16T19:17:26.5995649+00:00" }, "equipment_model_id": "c04a9836-4ed2-4047-b14a-49b2159ad26b", "equipment_model_code": "sample string 8", "equipment_model": { "id": "899d164e-080a-45d3-816d-9cbe7e73b05a", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "f015d7c6-4ede-4497-a3c5-066c7f4ee236", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "802bdd79-9adb-407f-8acf-11701c33cc39", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "1796491f-d296-4d6e-8f28-baadb907b3c1", "sales_organization_code": "sample string 5", "sales_organization": { "id": "68b88f5c-9698-4ff2-b06f-76bab4a233a7", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "e9e8b16a-49ee-4e40-b629-d5d2012f7c5a", "db_currency_id": "e97c972d-65ba-47f7-8dfc-c7c1fa649469", "db_language_id": "8d32c509-f1de-4162-9b02-71833d5ec534", "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": "2024-04-16T19:17:26.5995649+00:00" }, "modified_dateutc": "2024-04-16T19:17:26.5995649+00:00" }, "equipment_family_id": "c583329e-47e1-4aa0-864f-590cb1888ffa", "equipment_family_code": "sample string 8", "equipment_family": { "id": "8d0f49d6-1b11-48da-9a4e-9df57f4f3786", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "ca8dcf5e-8bff-40ab-b82d-ed138c1d5437", "_parent_code": "sample string 6", "sales_organization_id": "99a2b45c-33c9-403a-ac22-5b1218638e88", "sales_organization_code": "sample string 8", "sales_organization": { "id": "68b88f5c-9698-4ff2-b06f-76bab4a233a7", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "e9e8b16a-49ee-4e40-b629-d5d2012f7c5a", "db_currency_id": "e97c972d-65ba-47f7-8dfc-c7c1fa649469", "db_language_id": "8d32c509-f1de-4162-9b02-71833d5ec534", "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": "2024-04-16T19:17:26.5995649+00:00" }, "modified_dateutc": "2024-04-16T19:17:26.5995649+00:00" }, "date_in_production_since": "2024-04-16T19:17:26.5995649+00:00", "date_out_of_production_since": "2024-04-16T19:17:26.5995649+00:00", "date_end_support": "2024-04-16T19:17:26.5995649+00:00", "sales_organization_id": "1a724a9f-dd72-47c9-9cb0-d6946770530b", "sales_organization_code": "sample string 13", "sales_organization": { "id": "68b88f5c-9698-4ff2-b06f-76bab4a233a7", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "e9e8b16a-49ee-4e40-b629-d5d2012f7c5a", "db_currency_id": "e97c972d-65ba-47f7-8dfc-c7c1fa649469", "db_language_id": "8d32c509-f1de-4162-9b02-71833d5ec534", "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": "2024-04-16T19:17:26.5995649+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": "2024-04-16T19:17:26.5995649+00:00" }, "project_status_id": "a2c94911-502d-4839-bedc-7f6315f9cd62", "project_status_code": "sample string 10", "project_status": { "id": "7e5587eb-b1ec-4214-a54a-d5b5463e741e", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "a4677ce8-24f3-4e46-a25a-67aa41a7a9a8", "sales_organization_code": "sample string 6", "sales_organization": { "id": "68b88f5c-9698-4ff2-b06f-76bab4a233a7", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "e9e8b16a-49ee-4e40-b629-d5d2012f7c5a", "db_currency_id": "e97c972d-65ba-47f7-8dfc-c7c1fa649469", "db_language_id": "8d32c509-f1de-4162-9b02-71833d5ec534", "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": "2024-04-16T19:17:26.5995649+00:00" }, "code": "sample string 7", "modified_dateutc": "2024-04-16T19:17:26.5995649+00:00" }, "company_id": "41476369-cab0-43e0-8fb3-5ac2bc2101f8", "company_code": "sample string 12", "db_address_id": "e58e51fb-2c88-415a-aef6-b044f1f925d0", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "7fc08325-7cc7-4d15-92f3-343dc4029d47", "contact_reference_back_office": "sample string 17", "owner_user_id": "9e966026-4746-4f4b-981a-dbbfd26cdfea", "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": "2024-04-16T19:17:26.5995649+00:00", "date_create": "2024-04-16T19:17:26.5995649+00:00", "date_update": "2024-04-16T19:17:26.5995649+00:00", "updated_by_user_id": "9e0bc5cd-e410-4b1c-8745-8da3586d8490", "customer_reference": "sample string 28", "warranty_date_until": "2024-04-16T19:17:26.5995649+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": "2024-04-16T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2024-04-16T19:17:26.5995649+00:00", "date_last_job": "2024-04-16T19:17:26.5995649+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2024-04-16T19:17:26.5995649+00:00", "modified_dateutc": "2024-04-16T19:17:26.5995649+00:00", "is_mobile_installation": true }, "job_type_id": "fc075770-bfba-45eb-b13d-b1df2d47cd9d", "job_type_code": "sample string 7", "job_type": { "id": "a2e2cf7b-304b-4192-a4fe-967a0ada7c23", "name": "sample string 2", "sales_organization_id": "efa7ee23-d9b2-45cc-8ece-06ae850e16b6", "description": "sample string 4", "is_default": true, "modified_dateutc": "2024-04-16T19:17:26.5995649+00:00", "code": "sample string 7" }, "job_priority_id": "e6acef1e-0ee2-46ef-be3f-734f7a756d2d", "job_priority_code": "sample string 9", "job_priority": { "id": "5a4010e9-b81e-440d-a7b4-d07809e61f5e", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "aa8b1ed0-acfd-4150-a210-c49a7b201bfa", "sales_organization_code": "sample string 6", "sales_organization": { "id": "68b88f5c-9698-4ff2-b06f-76bab4a233a7", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "e9e8b16a-49ee-4e40-b629-d5d2012f7c5a", "db_currency_id": "e97c972d-65ba-47f7-8dfc-c7c1fa649469", "db_language_id": "8d32c509-f1de-4162-9b02-71833d5ec534", "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": "2024-04-16T19:17:26.5995649+00:00" }, "code": "sample string 7", "modified_dateutc": "2024-04-16T19:17:26.5995649+00:00" }, "job_status_id": "b0c0b9f4-a0af-4fe8-94a5-6fe0dd735881", "job_status_code": "sample string 11", "db_address_id": "add0af84-6c4c-46dc-a36e-b545720cb0ab", "contact_id": "a486ada9-7899-469f-b38a-3e5989a523ed", "requested_by_company_id": "d87070e7-34c3-4b87-9cda-a00eb0c71e97", "requested_by_contact_id": "eb53031d-e824-4021-aa7b-1b4dbc311126", "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": "2024-04-16T19:17:26.5995649+00:00", "due_date": "2024-04-16T19:17:26.5995649+00:00", "date_create": "2024-04-16T19:17:26.5995649+00:00", "date_update": "2024-04-16T19:17:26.5995649+00:00", "date_closed": "2024-04-16T19:17:26.5995649+00:00", "suggested_user_id": "b8ab9f75-c83f-47c6-bc8a-5db7a0389c08", "suggested_user_code": "sample string 29", "suggested_user": { "id": "4f279d48-0407-4f4d-bdb3-fbecb9bfb7af", "db_language_id": "b425d930-5915-4fe0-b160-1d821121e963", "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": "2024-04-16T19:17:26.5995649+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "c4be8c30-9aec-46e2-a550-6b7463c5db2f", "sales_organization": { "id": "68b88f5c-9698-4ff2-b06f-76bab4a233a7", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "e9e8b16a-49ee-4e40-b629-d5d2012f7c5a", "db_currency_id": "e97c972d-65ba-47f7-8dfc-c7c1fa649469", "db_language_id": "8d32c509-f1de-4162-9b02-71833d5ec534", "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": "2024-04-16T19:17:26.5995649+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "30c5f589-9a9d-4792-99cd-59a13d5277ad", "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": "2297e98a-4cd6-4d12-b51b-553db3488372", "private_db_country_code": "sample string 35", "modified_dateutc": "2024-04-16T19:17:26.5995649+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "11fed015-b110-46fb-9d15-cd09538ab2a0" }, "suggested_date_start": "2024-04-16T19:17:26.5995649+00:00", "skill_id": "5659863d-6898-415f-af8b-6e9116f6a77c", "skill_code": "sample string 32", "skill": { "id": "f8bee371-c97d-406d-a3b4-4d6cdf3e8dda", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "63a38634-f027-470a-b674-a7e05fd14ffc", "sales_organization_code": "sample string 6", "sales_organization": { "id": "68b88f5c-9698-4ff2-b06f-76bab4a233a7", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "e9e8b16a-49ee-4e40-b629-d5d2012f7c5a", "db_currency_id": "e97c972d-65ba-47f7-8dfc-c7c1fa649469", "db_language_id": "8d32c509-f1de-4162-9b02-71833d5ec534", "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": "2024-04-16T19:17:26.5995649+00:00" }, "modified_dateutc": "2024-04-16T19:17:26.5995649+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "c8710da0-8081-4ccc-b5ec-6e8f8d1f1408", "date_reported_by_company": "2024-04-16T19:17:26.5995649+00:00", "id2": 36, "company_id": "f359b7db-d024-4258-afb6-e604e1079dfb", "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": "59e8e105-0c38-4419-8165-22a209d46ae8", "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": "2024-04-16T19:17:26.5995649+00:00" }
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.