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": "465cd9f6-60fc-4b63-8386-9fd2780ae406", "_parent_id": "056751fc-2095-462f-9559-c7fa1cb9b014", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "dfe6fb32-a2c5-424b-a4e1-4d32cfabfb37", "project_reference_back_office": "sample string 5", "project": { "id": "2a8c4348-b609-4cf9-b5f1-24009dc5300a", "_parent_id": "be97f94f-f151-4c08-adcc-4e91a6a5bbe3", "root_parent_id": "4b8a110d-155e-41bd-8d43-a2599beb0de1", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "e8a8334a-dff6-4e41-975e-f5489507ebe6", "equipment_family_code": "sample string 6", "equipment_family": { "id": "6fc1cf63-3e27-4ae7-9097-1d5eff99c91a", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "a7722647-81dc-428d-bd00-c3a94f910d1d", "_parent_code": "sample string 6", "sales_organization_id": "2121e065-726e-4cbe-9ef9-e85132e58ef3", "sales_organization_code": "sample string 8", "sales_organization": { "id": "a67671b8-7311-4d13-844e-1dbf09633c35", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "39fe696c-118f-4f5c-b54d-9d670cc062cf", "db_currency_id": "267d4d68-e4f1-4f08-a45c-6cae61ca5444", "db_language_id": "74bfce39-3301-42a7-a50f-66a9f0f01597", "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-10-08T18:26:51.3485589+00:00" }, "modified_dateutc": "2025-10-08T18:26:51.3485589+00:00" }, "equipment_model_id": "03eaa422-e089-41c5-8704-b0e459ffbfbf", "equipment_model_code": "sample string 8", "equipment_model": { "id": "20e86023-0397-43a4-a255-bbc9eed8a0bc", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "0ba5eb5b-5ea4-4c9f-878f-60d84e5aa640", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "b9ed1b43-0d27-427b-a30d-3809849e8d6a", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "0f852950-b7dd-45ba-9d6a-48c5226ddcb9", "sales_organization_code": "sample string 5", "sales_organization": { "id": "a67671b8-7311-4d13-844e-1dbf09633c35", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "39fe696c-118f-4f5c-b54d-9d670cc062cf", "db_currency_id": "267d4d68-e4f1-4f08-a45c-6cae61ca5444", "db_language_id": "74bfce39-3301-42a7-a50f-66a9f0f01597", "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-10-08T18:26:51.3485589+00:00" }, "modified_dateutc": "2025-10-08T18:26:51.3485589+00:00" }, "equipment_family_id": "ff406502-8dcd-4d12-a677-f82ae934fc82", "equipment_family_code": "sample string 8", "equipment_family": { "id": "6fc1cf63-3e27-4ae7-9097-1d5eff99c91a", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "a7722647-81dc-428d-bd00-c3a94f910d1d", "_parent_code": "sample string 6", "sales_organization_id": "2121e065-726e-4cbe-9ef9-e85132e58ef3", "sales_organization_code": "sample string 8", "sales_organization": { "id": "a67671b8-7311-4d13-844e-1dbf09633c35", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "39fe696c-118f-4f5c-b54d-9d670cc062cf", "db_currency_id": "267d4d68-e4f1-4f08-a45c-6cae61ca5444", "db_language_id": "74bfce39-3301-42a7-a50f-66a9f0f01597", "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-10-08T18:26:51.3485589+00:00" }, "modified_dateutc": "2025-10-08T18:26:51.3485589+00:00" }, "date_in_production_since": "2025-10-08T18:26:51.3485589+00:00", "date_out_of_production_since": "2025-10-08T18:26:51.3485589+00:00", "date_end_support": "2025-10-08T18:26:51.3485589+00:00", "sales_organization_id": "210568c7-1634-4745-afd7-e6522873045e", "sales_organization_code": "sample string 13", "sales_organization": { "id": "a67671b8-7311-4d13-844e-1dbf09633c35", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "39fe696c-118f-4f5c-b54d-9d670cc062cf", "db_currency_id": "267d4d68-e4f1-4f08-a45c-6cae61ca5444", "db_language_id": "74bfce39-3301-42a7-a50f-66a9f0f01597", "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-10-08T18:26:51.3485589+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-10-08T18:26:51.3485589+00:00" }, "project_status_id": "4cd2b5c5-c33c-4dd5-8943-d24c90ecb1d6", "project_status_code": "sample string 10", "project_status": { "id": "a517d1d5-c140-490c-b7d1-248edf8c69d1", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "cb46a1b0-5efe-441e-8882-e339bdefc50e", "sales_organization_code": "sample string 6", "sales_organization": { "id": "a67671b8-7311-4d13-844e-1dbf09633c35", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "39fe696c-118f-4f5c-b54d-9d670cc062cf", "db_currency_id": "267d4d68-e4f1-4f08-a45c-6cae61ca5444", "db_language_id": "74bfce39-3301-42a7-a50f-66a9f0f01597", "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-10-08T18:26:51.3485589+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-10-08T18:26:51.3485589+00:00" }, "company_id": "534d55f9-7e28-4f23-b918-487ad24fc583", "company_code": "sample string 12", "db_address_id": "6b38989e-c26b-4bd1-980e-403e0648716e", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "d0380f6c-1ab6-4ef6-aa83-3701852a1393", "contact_reference_back_office": "sample string 17", "owner_user_id": "9d87feae-acf3-4b56-aef0-f49941279e2b", "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-10-08T18:26:51.3485589+00:00", "date_create": "2025-10-08T18:26:51.3485589+00:00", "date_update": "2025-10-08T18:26:51.3485589+00:00", "updated_by_user_id": "428609d2-fcbf-4c3a-8da8-9e3a4adbc0c1", "customer_reference": "sample string 28", "warranty_date_until": "2025-10-08T18:26:51.3485589+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-10-08T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-10-08T18:26:51.3485589+00:00", "date_last_job": "2025-10-08T18:26:51.3485589+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-10-08T18:26:51.3485589+00:00", "modified_dateutc": "2025-10-08T18:26:51.3485589+00:00", "is_mobile_installation": true }, "job_type_id": "e544b795-8447-46b1-9e2b-c2ff7167cc72", "job_type_code": "sample string 7", "job_type": { "id": "8871f102-fe88-4dd0-b4ea-5f425c382a7a", "name": "sample string 2", "sales_organization_id": "29d346b0-6a0d-4f28-9e26-0e1adeac90f2", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-10-08T18:26:51.3485589+00:00", "code": "sample string 7" }, "job_priority_id": "0d377f68-7ccb-4a62-9ad9-8e241ce4d773", "job_priority_code": "sample string 9", "job_priority": { "id": "910048c5-6c5c-4795-929f-11dfa5e12b07", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "1ff4b72d-f6f7-4073-88c6-21191e86839a", "sales_organization_code": "sample string 6", "sales_organization": { "id": "a67671b8-7311-4d13-844e-1dbf09633c35", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "39fe696c-118f-4f5c-b54d-9d670cc062cf", "db_currency_id": "267d4d68-e4f1-4f08-a45c-6cae61ca5444", "db_language_id": "74bfce39-3301-42a7-a50f-66a9f0f01597", "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-10-08T18:26:51.3485589+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-10-08T18:26:51.3485589+00:00" }, "job_status_id": "ba23a900-2aff-4c48-8622-2fdd5a8552a1", "job_status_code": "sample string 11", "db_address_id": "57916a2a-01ec-4697-b681-f223eb780dcc", "contact_id": "db7ba171-ccd4-419e-abe0-dbfdb189a86e", "requested_by_company_id": "1872de50-495d-4b3a-9663-6de3015d72e0", "requested_by_contact_id": "523d8100-3ea0-4593-ae45-6c3d6b90b6a7", "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-10-08T18:26:51.3485589+00:00", "due_date": "2025-10-08T18:26:51.3485589+00:00", "date_create": "2025-10-08T18:26:51.3485589+00:00", "date_update": "2025-10-08T18:26:51.3485589+00:00", "date_closed": "2025-10-08T18:26:51.3485589+00:00", "suggested_user_id": "5c6b6acd-9f3c-44c6-a724-07998852074a", "suggested_user_code": "sample string 29", "suggested_user": { "id": "647246d0-17b7-4c59-9c71-269b925e4398", "db_language_id": "4a79f511-93d2-4c18-9bcf-b65588c7ac46", "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-10-08T18:26:51.3485589+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "9147a65c-b911-4898-84ea-67c47762cd2a", "sales_organization": { "id": "a67671b8-7311-4d13-844e-1dbf09633c35", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "39fe696c-118f-4f5c-b54d-9d670cc062cf", "db_currency_id": "267d4d68-e4f1-4f08-a45c-6cae61ca5444", "db_language_id": "74bfce39-3301-42a7-a50f-66a9f0f01597", "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-10-08T18:26:51.3485589+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "9bbdbfcc-b9b3-4b1d-b626-97a4100b810a", "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": "506a6764-1f10-49d3-9660-640cd9abfe28", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-10-08T18:26:51.3485589+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "e73a0526-05dc-44a2-bb64-4d6461b8f376" }, "suggested_date_start": "2025-10-08T18:26:51.3485589+00:00", "skill_id": "8924596b-a208-4c06-9aeb-c5a712c779bc", "skill_code": "sample string 32", "skill": { "id": "f188d95c-26f2-4ca9-8358-9ea95e82b196", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "3656b6bb-137a-4a3b-a03f-a43897e1e5a5", "sales_organization_code": "sample string 6", "sales_organization": { "id": "a67671b8-7311-4d13-844e-1dbf09633c35", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "39fe696c-118f-4f5c-b54d-9d670cc062cf", "db_currency_id": "267d4d68-e4f1-4f08-a45c-6cae61ca5444", "db_language_id": "74bfce39-3301-42a7-a50f-66a9f0f01597", "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-10-08T18:26:51.3485589+00:00" }, "modified_dateutc": "2025-10-08T18:26:51.3485589+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "0a7000cd-9314-4e5b-b7d8-3c218008b80c", "date_reported_by_company": "2025-10-08T18:26:51.3485589+00:00", "id2": 36, "company_id": "ed16b4a3-a3fa-4e5a-ae2a-a80f79f0a650", "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": "e1349575-09c1-4724-a0bf-52ab357a40d9", "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-10-08T18:26:51.3485589+00:00" }
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.