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": "9c973140-a15c-473a-9fc4-f30bd45603a2", "_parent_id": "6d7adb15-5693-4f22-bc0e-cd4676851d06", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "65f008ab-164a-446e-b46c-0966b14f348b", "project_reference_back_office": "sample string 5", "project": { "id": "2e5149f7-c15d-4125-a28b-c86778e4ed12", "_parent_id": "ae0a2b15-9b56-42f7-95a6-56021737fb59", "root_parent_id": "75967ebb-e469-4787-9e96-b1d3091efab7", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "8ef32927-93a6-465c-94f6-46ae99539e06", "equipment_family_code": "sample string 6", "equipment_family": { "id": "fd6756e3-42f7-4a46-a44f-94a7465f0f1d", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "fbee2296-c762-41fd-9b57-45e804abb691", "_parent_code": "sample string 6", "sales_organization_id": "55c1b1b2-bf75-4ef2-ad7e-2bb6221e8003", "sales_organization_code": "sample string 8", "sales_organization": { "id": "764a98d2-58bf-4348-8f20-0decfab0a336", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "2d575eab-78eb-4551-9e6d-3b0d06a97fb2", "db_currency_id": "78778886-3a2e-4c63-b61f-55c129403cef", "db_language_id": "42bc3030-8430-4947-8f80-4328dd0551d1", "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-07-18T23:47:08.475359+00:00" }, "modified_dateutc": "2025-07-18T23:47:08.475359+00:00" }, "equipment_model_id": "78310e8a-00fd-4368-91bc-2a968646f319", "equipment_model_code": "sample string 8", "equipment_model": { "id": "442ab24f-b829-43bd-a5bc-896896219e51", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "3fe71fbb-3a84-4a2e-8ba2-74fc4836487d", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "68f637fb-2fbf-4b73-bf78-4002e0c0e082", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "e91dd977-bd85-43a3-a097-73e4a9a1fe98", "sales_organization_code": "sample string 5", "sales_organization": { "id": "764a98d2-58bf-4348-8f20-0decfab0a336", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "2d575eab-78eb-4551-9e6d-3b0d06a97fb2", "db_currency_id": "78778886-3a2e-4c63-b61f-55c129403cef", "db_language_id": "42bc3030-8430-4947-8f80-4328dd0551d1", "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-07-18T23:47:08.475359+00:00" }, "modified_dateutc": "2025-07-18T23:47:08.475359+00:00" }, "equipment_family_id": "0051f31f-19dc-4f30-88d6-b27204470103", "equipment_family_code": "sample string 8", "equipment_family": { "id": "fd6756e3-42f7-4a46-a44f-94a7465f0f1d", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "fbee2296-c762-41fd-9b57-45e804abb691", "_parent_code": "sample string 6", "sales_organization_id": "55c1b1b2-bf75-4ef2-ad7e-2bb6221e8003", "sales_organization_code": "sample string 8", "sales_organization": { "id": "764a98d2-58bf-4348-8f20-0decfab0a336", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "2d575eab-78eb-4551-9e6d-3b0d06a97fb2", "db_currency_id": "78778886-3a2e-4c63-b61f-55c129403cef", "db_language_id": "42bc3030-8430-4947-8f80-4328dd0551d1", "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-07-18T23:47:08.475359+00:00" }, "modified_dateutc": "2025-07-18T23:47:08.475359+00:00" }, "date_in_production_since": "2025-07-18T23:47:08.475359+00:00", "date_out_of_production_since": "2025-07-18T23:47:08.475359+00:00", "date_end_support": "2025-07-18T23:47:08.475359+00:00", "sales_organization_id": "7da02257-21bc-440f-be6d-ba760c50366d", "sales_organization_code": "sample string 13", "sales_organization": { "id": "764a98d2-58bf-4348-8f20-0decfab0a336", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "2d575eab-78eb-4551-9e6d-3b0d06a97fb2", "db_currency_id": "78778886-3a2e-4c63-b61f-55c129403cef", "db_language_id": "42bc3030-8430-4947-8f80-4328dd0551d1", "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-07-18T23:47:08.475359+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-07-18T23:47:08.475359+00:00" }, "project_status_id": "2f40860d-205c-452c-9916-d65d37deb88f", "project_status_code": "sample string 10", "project_status": { "id": "b0e5d716-92db-4053-bfbd-a110ec4e6429", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "2cc3ae56-cd6f-4a80-ba40-e6eca99e6e4c", "sales_organization_code": "sample string 6", "sales_organization": { "id": "764a98d2-58bf-4348-8f20-0decfab0a336", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "2d575eab-78eb-4551-9e6d-3b0d06a97fb2", "db_currency_id": "78778886-3a2e-4c63-b61f-55c129403cef", "db_language_id": "42bc3030-8430-4947-8f80-4328dd0551d1", "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-07-18T23:47:08.475359+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-07-18T23:47:08.475359+00:00" }, "company_id": "f589f9f0-c293-4336-8651-6209c86b4de3", "company_code": "sample string 12", "db_address_id": "874f13b5-0480-4a53-8fb7-b8e21027786a", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "3b901c71-2b28-4823-a212-e2bab3938173", "contact_reference_back_office": "sample string 17", "owner_user_id": "35a76755-8bb6-4783-ab06-6e1fa0665681", "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-07-18T23:47:08.475359+00:00", "date_create": "2025-07-18T23:47:08.475359+00:00", "date_update": "2025-07-18T23:47:08.475359+00:00", "updated_by_user_id": "9a92ddf5-5c27-4a22-b39a-f4421c825820", "customer_reference": "sample string 28", "warranty_date_until": "2025-07-18T23:47:08.475359+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-07-18T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-07-18T23:47:08.475359+00:00", "date_last_job": "2025-07-18T23:47:08.475359+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-07-18T23:47:08.475359+00:00", "modified_dateutc": "2025-07-18T23:47:08.475359+00:00", "is_mobile_installation": true }, "job_type_id": "c5158e85-8382-4720-9b9b-753c7426704a", "job_type_code": "sample string 7", "job_type": { "id": "1d1c2306-cdf9-4068-9b96-b35d66191f78", "name": "sample string 2", "sales_organization_id": "fe38f459-a5bd-48a5-8057-153417223b80", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-07-18T23:47:08.475359+00:00", "code": "sample string 7" }, "job_priority_id": "195e1d4b-c782-4e96-b4de-3fe7f64c2514", "job_priority_code": "sample string 9", "job_priority": { "id": "6c1729e4-9d32-43fb-ab78-aa67eeb96ed2", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "ab7c7c86-d186-47a2-8744-982d807ffa78", "sales_organization_code": "sample string 6", "sales_organization": { "id": "764a98d2-58bf-4348-8f20-0decfab0a336", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "2d575eab-78eb-4551-9e6d-3b0d06a97fb2", "db_currency_id": "78778886-3a2e-4c63-b61f-55c129403cef", "db_language_id": "42bc3030-8430-4947-8f80-4328dd0551d1", "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-07-18T23:47:08.475359+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-07-18T23:47:08.475359+00:00" }, "job_status_id": "f96a140c-73da-4589-9665-4cf75c1cf774", "job_status_code": "sample string 11", "db_address_id": "639d5461-0bff-47f6-a00f-b3f2e6b80375", "contact_id": "c72cfdeb-9ee1-4690-923e-61b27bf66503", "requested_by_company_id": "c24901c1-1a33-4017-b878-8d2400a78dc4", "requested_by_contact_id": "809cd4a7-002a-48d2-a15f-aeca33763074", "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-07-18T23:47:08.475359+00:00", "due_date": "2025-07-18T23:47:08.475359+00:00", "date_create": "2025-07-18T23:47:08.475359+00:00", "date_update": "2025-07-18T23:47:08.475359+00:00", "date_closed": "2025-07-18T23:47:08.475359+00:00", "suggested_user_id": "16d2d6ab-58aa-48d7-bacf-d43bd6955c38", "suggested_user_code": "sample string 29", "suggested_user": { "id": "9ed037aa-c4d2-468e-a0a2-3c137012b64d", "db_language_id": "6c341cdc-9a98-495d-a061-30595d8e4b0f", "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-07-18T23:47:08.475359+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "c6ea9a71-1bb6-4d83-bc5d-b9f2696a69c3", "sales_organization": { "id": "764a98d2-58bf-4348-8f20-0decfab0a336", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "2d575eab-78eb-4551-9e6d-3b0d06a97fb2", "db_currency_id": "78778886-3a2e-4c63-b61f-55c129403cef", "db_language_id": "42bc3030-8430-4947-8f80-4328dd0551d1", "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-07-18T23:47:08.475359+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "2b5337b8-48d3-4ab0-9f1f-9fa17164a33d", "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": "c5bbda84-51d0-4fed-a088-c754e4331999", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-07-18T23:47:08.475359+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "45516624-b3aa-4088-a877-6461d6e873ba" }, "suggested_date_start": "2025-07-18T23:47:08.475359+00:00", "skill_id": "ccd827c3-1882-4fda-9a82-5702504ee553", "skill_code": "sample string 32", "skill": { "id": "fe2f2ca4-2fcc-4d2c-91c5-040ba2901292", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "36ce3651-711b-40ef-983d-70e70d04e0f3", "sales_organization_code": "sample string 6", "sales_organization": { "id": "764a98d2-58bf-4348-8f20-0decfab0a336", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "2d575eab-78eb-4551-9e6d-3b0d06a97fb2", "db_currency_id": "78778886-3a2e-4c63-b61f-55c129403cef", "db_language_id": "42bc3030-8430-4947-8f80-4328dd0551d1", "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-07-18T23:47:08.475359+00:00" }, "modified_dateutc": "2025-07-18T23:47:08.475359+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "5760fb67-73e7-4fee-9541-1928b0227b65", "date_reported_by_company": "2025-07-18T23:47:08.475359+00:00", "id2": 36, "company_id": "0d148c85-2a8e-497b-898d-c22be7ccebd1", "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": "025abdeb-5130-4d0b-ae3d-950b6a06977d", "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-07-18T23:47:08.475359+00:00" }
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.