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": "176d2766-5f88-4b0a-b158-acc0fd9a8036", "_parent_id": "7ddd3cc3-c000-4ff1-8dac-273a4885ac06", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "b3b31e34-8f00-4877-9400-1a985e6a9aae", "project_reference_back_office": "sample string 5", "project": { "id": "b0a89704-9de2-485f-a4d1-0c012446763e", "_parent_id": "0ae58b0e-2830-4632-a1cc-1bc24d0e538e", "root_parent_id": "849626d7-4060-4d00-b62e-2cf8ce78066b", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "d20c107a-ad08-46d6-b995-6a91463f4224", "equipment_family_code": "sample string 6", "equipment_family": { "id": "4c6efba5-a31d-4d0e-9091-787fde45160f", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "7c173c41-73dd-4409-84e1-2ca80f04fa19", "_parent_code": "sample string 6", "sales_organization_id": "00241018-4a82-4c5c-8c18-6b9dde968b7c", "sales_organization_code": "sample string 8", "sales_organization": { "id": "bd5d7033-17ff-452e-9a4c-0cf947dfd9c1", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "6f493994-d1ae-4777-8d0b-ea6a22cb2940", "db_currency_id": "24c913f0-8b3c-4e70-8aa5-60a555171382", "db_language_id": "44462d04-3ac2-4713-a5af-87823606af18", "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-25T00:33:08.3310892+00:00" }, "modified_dateutc": "2025-04-25T00:33:08.346714+00:00" }, "equipment_model_id": "e4912354-b003-4016-9992-3fb970403cfb", "equipment_model_code": "sample string 8", "equipment_model": { "id": "47a49f42-37d9-4cee-8359-c1e2f9553085", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "c74fa14f-7b36-446e-a879-6e381dc74827", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "472b57e2-c89e-4907-8502-9fc8ff5de839", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "248274de-dce2-4a3e-9842-c4980046c25b", "sales_organization_code": "sample string 5", "sales_organization": { "id": "bd5d7033-17ff-452e-9a4c-0cf947dfd9c1", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "6f493994-d1ae-4777-8d0b-ea6a22cb2940", "db_currency_id": "24c913f0-8b3c-4e70-8aa5-60a555171382", "db_language_id": "44462d04-3ac2-4713-a5af-87823606af18", "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-25T00:33:08.3310892+00:00" }, "modified_dateutc": "2025-04-25T00:33:08.346714+00:00" }, "equipment_family_id": "584518eb-9a13-448a-b946-6b8489217bcc", "equipment_family_code": "sample string 8", "equipment_family": { "id": "4c6efba5-a31d-4d0e-9091-787fde45160f", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "7c173c41-73dd-4409-84e1-2ca80f04fa19", "_parent_code": "sample string 6", "sales_organization_id": "00241018-4a82-4c5c-8c18-6b9dde968b7c", "sales_organization_code": "sample string 8", "sales_organization": { "id": "bd5d7033-17ff-452e-9a4c-0cf947dfd9c1", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "6f493994-d1ae-4777-8d0b-ea6a22cb2940", "db_currency_id": "24c913f0-8b3c-4e70-8aa5-60a555171382", "db_language_id": "44462d04-3ac2-4713-a5af-87823606af18", "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-25T00:33:08.3310892+00:00" }, "modified_dateutc": "2025-04-25T00:33:08.346714+00:00" }, "date_in_production_since": "2025-04-25T00:33:08.346714+00:00", "date_out_of_production_since": "2025-04-25T00:33:08.346714+00:00", "date_end_support": "2025-04-25T00:33:08.346714+00:00", "sales_organization_id": "ffdeeba0-accd-47cd-8c52-a97897cb6ba2", "sales_organization_code": "sample string 13", "sales_organization": { "id": "bd5d7033-17ff-452e-9a4c-0cf947dfd9c1", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "6f493994-d1ae-4777-8d0b-ea6a22cb2940", "db_currency_id": "24c913f0-8b3c-4e70-8aa5-60a555171382", "db_language_id": "44462d04-3ac2-4713-a5af-87823606af18", "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-25T00:33:08.3310892+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-25T00:33:08.346714+00:00" }, "project_status_id": "16d7fd63-e4c1-43bd-93b4-8ad50d294c08", "project_status_code": "sample string 10", "project_status": { "id": "ada129fa-ce98-4d85-b92d-99f7ef4a7476", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "65ee8c77-4194-4dbb-876d-1dee813825ad", "sales_organization_code": "sample string 6", "sales_organization": { "id": "bd5d7033-17ff-452e-9a4c-0cf947dfd9c1", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "6f493994-d1ae-4777-8d0b-ea6a22cb2940", "db_currency_id": "24c913f0-8b3c-4e70-8aa5-60a555171382", "db_language_id": "44462d04-3ac2-4713-a5af-87823606af18", "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-25T00:33:08.3310892+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-04-25T00:33:08.346714+00:00" }, "company_id": "34b16492-2390-4b43-b0ad-97ffe028fb27", "company_code": "sample string 12", "db_address_id": "14b2d8ee-3b8a-4196-920f-90946812bf20", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "b8a87f53-ee15-4670-b087-dcf34fb3d4a2", "contact_reference_back_office": "sample string 17", "owner_user_id": "bc85008b-f56c-4794-9e54-85d541f8e5e4", "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-25T00:33:08.346714+00:00", "date_create": "2025-04-25T00:33:08.346714+00:00", "date_update": "2025-04-25T00:33:08.346714+00:00", "updated_by_user_id": "91b467da-2687-4ddc-92d5-e2e6bde38065", "customer_reference": "sample string 28", "warranty_date_until": "2025-04-25T00:33:08.346714+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-25T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-04-25T00:33:08.346714+00:00", "date_last_job": "2025-04-25T00:33:08.346714+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-04-25T00:33:08.346714+00:00", "modified_dateutc": "2025-04-25T00:33:08.346714+00:00", "is_mobile_installation": true }, "job_type_id": "dab11c91-1caf-49f1-b851-5312feb3235b", "job_type_code": "sample string 7", "job_type": { "id": "99dcd865-ce2b-4bd8-b3b2-a8aa88503ccf", "name": "sample string 2", "sales_organization_id": "1ae461cb-29cd-4232-ab7d-4d92b53dc0ce", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-04-25T00:33:08.346714+00:00", "code": "sample string 7" }, "job_priority_id": "f7a1fc3d-0ce2-480b-b652-e5e8aafd355b", "job_priority_code": "sample string 9", "job_priority": { "id": "f3994671-caf6-4439-8de3-dc188cc6ba70", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "8705d054-f398-43a4-a893-7740b0565e06", "sales_organization_code": "sample string 6", "sales_organization": { "id": "bd5d7033-17ff-452e-9a4c-0cf947dfd9c1", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "6f493994-d1ae-4777-8d0b-ea6a22cb2940", "db_currency_id": "24c913f0-8b3c-4e70-8aa5-60a555171382", "db_language_id": "44462d04-3ac2-4713-a5af-87823606af18", "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-25T00:33:08.3310892+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-04-25T00:33:08.346714+00:00" }, "job_status_id": "b79d6b1c-9493-4f9c-aec7-d5de06c1557d", "job_status_code": "sample string 11", "db_address_id": "6f70bb44-2345-480c-b558-82c89b5d6e0e", "contact_id": "c81a71dc-10da-47f7-a15a-61dd2463da65", "requested_by_company_id": "48a70c3c-0237-44c2-8543-05df30f943a5", "requested_by_contact_id": "7c746399-f927-4f16-9556-b68ef10ec3f3", "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-25T00:33:08.346714+00:00", "due_date": "2025-04-25T00:33:08.346714+00:00", "date_create": "2025-04-25T00:33:08.346714+00:00", "date_update": "2025-04-25T00:33:08.346714+00:00", "date_closed": "2025-04-25T00:33:08.346714+00:00", "suggested_user_id": "c8095d97-8aed-420b-bee6-b660df57743f", "suggested_user_code": "sample string 29", "suggested_user": { "id": "23b81718-37e0-4703-9a96-7118a938c8ca", "db_language_id": "57426915-44d3-424c-bdc5-549d7996d115", "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-25T00:33:08.346714+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "e97383d4-daeb-4e59-9790-33edcd420572", "sales_organization": { "id": "bd5d7033-17ff-452e-9a4c-0cf947dfd9c1", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "6f493994-d1ae-4777-8d0b-ea6a22cb2940", "db_currency_id": "24c913f0-8b3c-4e70-8aa5-60a555171382", "db_language_id": "44462d04-3ac2-4713-a5af-87823606af18", "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-25T00:33:08.3310892+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "f65b8bc1-f400-45a6-a57e-510f32751a9b", "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": "075733d7-fe2c-472e-b46d-bb72c903523c", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-04-25T00:33:08.346714+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "704b87bb-ade1-4eec-b83a-d3fb6c03d974" }, "suggested_date_start": "2025-04-25T00:33:08.346714+00:00", "skill_id": "d4048ac1-f005-4cb3-b4f7-530f872a0b7d", "skill_code": "sample string 32", "skill": { "id": "34332b76-419b-4ea2-be3f-d85ca00eb24c", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "ae11d21f-79e2-479d-927c-f7c858846b81", "sales_organization_code": "sample string 6", "sales_organization": { "id": "bd5d7033-17ff-452e-9a4c-0cf947dfd9c1", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "6f493994-d1ae-4777-8d0b-ea6a22cb2940", "db_currency_id": "24c913f0-8b3c-4e70-8aa5-60a555171382", "db_language_id": "44462d04-3ac2-4713-a5af-87823606af18", "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-25T00:33:08.3310892+00:00" }, "modified_dateutc": "2025-04-25T00:33:08.346714+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "713edf45-568d-4e04-9d6c-3e40971dce10", "date_reported_by_company": "2025-04-25T00:33:08.346714+00:00", "id2": 36, "company_id": "d2c3b88b-6f2c-4e37-b92d-961a7e16393b", "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": "4008872c-6f77-43be-a4c0-6ff3376968c1", "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-25T00:33:08.346714+00:00" }
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.