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": "9b690466-5783-40b0-8799-10ec198cda82", "_parent_id": "687a2ed9-7aa2-4df1-a407-df7c4fcc453c", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "189cd422-3c12-456a-be79-296ccc8ef655", "project_reference_back_office": "sample string 5", "project": { "id": "1cdb4559-91d9-452e-831f-6759b7837889", "_parent_id": "8f19c1a7-4d81-465c-adf2-f13f4c491f95", "root_parent_id": "60993a18-6414-470a-af36-da3858f6b4f8", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "5747f5f6-e119-4f33-a596-1ad6ae3898fe", "equipment_family_code": "sample string 6", "equipment_family": { "id": "cfca71cf-a2cd-41b5-80f3-8feebd8d89f1", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "8bb228a5-7ed3-485c-8c03-6b9e2a686802", "_parent_code": "sample string 6", "sales_organization_id": "8d999943-10d7-40d8-8c88-78c85c806136", "sales_organization_code": "sample string 8", "sales_organization": { "id": "f073dff8-b354-44ef-bcf3-b193ee9bd8bc", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "8d9ce380-2b83-457d-a4b0-84c54cc64833", "db_currency_id": "6698d06f-ef29-4602-849a-398ca953f30e", "db_language_id": "e3aee200-a370-445d-ae9e-b9b9d9fe7132", "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-06-26T05:56:32.0100313+00:00" }, "modified_dateutc": "2025-06-26T05:56:32.0100313+00:00" }, "equipment_model_id": "5974a37d-048b-42ca-8036-53e628fc3097", "equipment_model_code": "sample string 8", "equipment_model": { "id": "45f2e4c2-e4b3-474c-beaa-d0fe522db7c5", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "4dc330d2-cc32-4389-b8de-11b32ce5daef", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "e3d8a94c-04e2-4d66-8ada-11058092e8f3", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "bb60489c-80f9-48ae-bf1f-e3661403967f", "sales_organization_code": "sample string 5", "sales_organization": { "id": "f073dff8-b354-44ef-bcf3-b193ee9bd8bc", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "8d9ce380-2b83-457d-a4b0-84c54cc64833", "db_currency_id": "6698d06f-ef29-4602-849a-398ca953f30e", "db_language_id": "e3aee200-a370-445d-ae9e-b9b9d9fe7132", "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-06-26T05:56:32.0100313+00:00" }, "modified_dateutc": "2025-06-26T05:56:32.0100313+00:00" }, "equipment_family_id": "2493b082-d7ba-4760-b8ca-df641fc2dccf", "equipment_family_code": "sample string 8", "equipment_family": { "id": "cfca71cf-a2cd-41b5-80f3-8feebd8d89f1", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "8bb228a5-7ed3-485c-8c03-6b9e2a686802", "_parent_code": "sample string 6", "sales_organization_id": "8d999943-10d7-40d8-8c88-78c85c806136", "sales_organization_code": "sample string 8", "sales_organization": { "id": "f073dff8-b354-44ef-bcf3-b193ee9bd8bc", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "8d9ce380-2b83-457d-a4b0-84c54cc64833", "db_currency_id": "6698d06f-ef29-4602-849a-398ca953f30e", "db_language_id": "e3aee200-a370-445d-ae9e-b9b9d9fe7132", "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-06-26T05:56:32.0100313+00:00" }, "modified_dateutc": "2025-06-26T05:56:32.0100313+00:00" }, "date_in_production_since": "2025-06-26T05:56:32.0100313+00:00", "date_out_of_production_since": "2025-06-26T05:56:32.0100313+00:00", "date_end_support": "2025-06-26T05:56:32.0100313+00:00", "sales_organization_id": "85636558-090f-4c3f-affc-956bb30501ee", "sales_organization_code": "sample string 13", "sales_organization": { "id": "f073dff8-b354-44ef-bcf3-b193ee9bd8bc", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "8d9ce380-2b83-457d-a4b0-84c54cc64833", "db_currency_id": "6698d06f-ef29-4602-849a-398ca953f30e", "db_language_id": "e3aee200-a370-445d-ae9e-b9b9d9fe7132", "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-06-26T05:56:32.0100313+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-06-26T05:56:32.0100313+00:00" }, "project_status_id": "3eb39768-c5c7-44c4-b79e-9fc79cbc682e", "project_status_code": "sample string 10", "project_status": { "id": "6912a2de-d784-463b-859b-0e60cb975b18", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "7033bccc-b63c-4585-a0c1-d3f8889cb9cc", "sales_organization_code": "sample string 6", "sales_organization": { "id": "f073dff8-b354-44ef-bcf3-b193ee9bd8bc", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "8d9ce380-2b83-457d-a4b0-84c54cc64833", "db_currency_id": "6698d06f-ef29-4602-849a-398ca953f30e", "db_language_id": "e3aee200-a370-445d-ae9e-b9b9d9fe7132", "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-06-26T05:56:32.0100313+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-06-26T05:56:32.0100313+00:00" }, "company_id": "0d0caf38-d5c7-4a8d-a45e-38de0334c20d", "company_code": "sample string 12", "db_address_id": "24ed89c5-ba2d-4d43-88aa-ee0f5215222b", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "9d6eb2b0-03ed-4768-bc1f-1cc9c3425e63", "contact_reference_back_office": "sample string 17", "owner_user_id": "9b8aa8cf-9db1-4311-8c53-fd9446f96162", "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-06-26T05:56:32.0100313+00:00", "date_create": "2025-06-26T05:56:32.0100313+00:00", "date_update": "2025-06-26T05:56:32.0100313+00:00", "updated_by_user_id": "df199c23-c851-4eec-bf1e-ff03597dedbc", "customer_reference": "sample string 28", "warranty_date_until": "2025-06-26T05:56:32.0100313+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-06-26T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-06-26T05:56:32.0100313+00:00", "date_last_job": "2025-06-26T05:56:32.0100313+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-06-26T05:56:32.0100313+00:00", "modified_dateutc": "2025-06-26T05:56:32.0100313+00:00", "is_mobile_installation": true }, "job_type_id": "6015b08c-1abe-42c1-8351-016462721ecb", "job_type_code": "sample string 7", "job_type": { "id": "d2ea90fe-73ad-4dd8-8ce6-481447d42c02", "name": "sample string 2", "sales_organization_id": "64c07128-a656-4559-b89d-a28aa901c1d5", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-06-26T05:56:32.0100313+00:00", "code": "sample string 7" }, "job_priority_id": "48359e97-1cd6-4623-901d-f7b41f7d70cc", "job_priority_code": "sample string 9", "job_priority": { "id": "be385a80-8a1b-42c0-b3a1-cd46eee649ea", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "9862f294-d695-447b-a357-e15ccf3d1d68", "sales_organization_code": "sample string 6", "sales_organization": { "id": "f073dff8-b354-44ef-bcf3-b193ee9bd8bc", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "8d9ce380-2b83-457d-a4b0-84c54cc64833", "db_currency_id": "6698d06f-ef29-4602-849a-398ca953f30e", "db_language_id": "e3aee200-a370-445d-ae9e-b9b9d9fe7132", "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-06-26T05:56:32.0100313+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-06-26T05:56:32.0100313+00:00" }, "job_status_id": "07c1665b-e043-4403-ba96-d7f7e74fb700", "job_status_code": "sample string 11", "db_address_id": "c3142a81-ba6f-4c94-aca1-1aacdefe3c3c", "contact_id": "a6ed4a9e-aab3-4888-8787-065c4f7bc3ee", "requested_by_company_id": "52218073-3036-4260-b49a-325cd4dad3ea", "requested_by_contact_id": "d0c93a31-0ee0-4685-acdc-ac7a10b947a1", "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-06-26T05:56:32.0100313+00:00", "due_date": "2025-06-26T05:56:32.0100313+00:00", "date_create": "2025-06-26T05:56:32.0100313+00:00", "date_update": "2025-06-26T05:56:32.0100313+00:00", "date_closed": "2025-06-26T05:56:32.0100313+00:00", "suggested_user_id": "b8374736-d772-4f43-9700-07caec3d6b97", "suggested_user_code": "sample string 29", "suggested_user": { "id": "2832cd6c-505f-4aad-baa1-761026dabca1", "db_language_id": "43ca38af-760f-4e3c-b152-e7e5ee2ad251", "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-06-26T05:56:32.0100313+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "b84d5292-a699-45d7-8027-3e711cd73ec9", "sales_organization": { "id": "f073dff8-b354-44ef-bcf3-b193ee9bd8bc", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "8d9ce380-2b83-457d-a4b0-84c54cc64833", "db_currency_id": "6698d06f-ef29-4602-849a-398ca953f30e", "db_language_id": "e3aee200-a370-445d-ae9e-b9b9d9fe7132", "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-06-26T05:56:32.0100313+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "cd175cf2-7213-484b-a9e8-e04251e8627b", "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": "7cd2526a-a413-46f1-bac2-3490189a0373", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-06-26T05:56:32.0100313+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "a1d3afc5-463e-418c-8de8-1dc7106f43b9" }, "suggested_date_start": "2025-06-26T05:56:32.0256554+00:00", "skill_id": "b35a7fcc-4778-4562-97fc-f508795780f7", "skill_code": "sample string 32", "skill": { "id": "38058060-805b-44d1-b7a6-3c189e93fbbd", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "a13f8815-5a2c-4c8e-83c2-018c00c61261", "sales_organization_code": "sample string 6", "sales_organization": { "id": "f073dff8-b354-44ef-bcf3-b193ee9bd8bc", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "8d9ce380-2b83-457d-a4b0-84c54cc64833", "db_currency_id": "6698d06f-ef29-4602-849a-398ca953f30e", "db_language_id": "e3aee200-a370-445d-ae9e-b9b9d9fe7132", "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-06-26T05:56:32.0100313+00:00" }, "modified_dateutc": "2025-06-26T05:56:32.0256554+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "52b94435-3b2f-40d8-9bd0-46984048d650", "date_reported_by_company": "2025-06-26T05:56:32.0256554+00:00", "id2": 36, "company_id": "e99896cf-29b6-47af-9021-7bcca6ca9a78", "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": "3cf8bfeb-d4a6-447c-a488-d6e699af7a39", "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-06-26T05:56:32.0256554+00:00" }
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.