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": "8dbb5a33-46bf-434c-8c6b-0f00dfa1616f", "_parent_id": "22757f07-1973-4129-8eaf-494b9f6b28a2", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "204f2150-ca51-4cab-a5b9-829995ced055", "project_reference_back_office": "sample string 5", "project": { "id": "f9d78865-d50e-4225-9e15-251497b02daf", "_parent_id": "8a39cae3-5c42-4eac-a6f4-7501eb7351c4", "root_parent_id": "6bb73959-f0a5-4832-93c9-7a0c3f61e93a", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "1488cd59-adfd-4c03-940f-d4a8492cdf60", "equipment_family_code": "sample string 6", "equipment_family": { "id": "7a2abe74-c2c1-4666-a85f-b1209d7a2c9e", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "21374353-d413-421c-a89f-fe21e5ae7d9e", "_parent_code": "sample string 6", "sales_organization_id": "7031785e-071d-40d2-93ab-3c6a655ee9b6", "sales_organization_code": "sample string 8", "sales_organization": { "id": "56083d33-f066-4b9d-b3cb-0ca89ffbf6af", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "2e2e4457-c32f-4494-980f-ef166a8663e8", "db_currency_id": "96112ff6-380c-42d5-9b3a-853d6f4d0c05", "db_language_id": "5dcd7526-03c1-423d-a496-8db6107997fd", "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-12-27T16:23:18.7578406+00:00" }, "modified_dateutc": "2024-12-27T16:23:18.7578406+00:00" }, "equipment_model_id": "1701b025-7d83-447f-937a-7fda5b190589", "equipment_model_code": "sample string 8", "equipment_model": { "id": "905c6985-b4a3-4609-8480-3a5a9d990e38", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "c7b9a682-463d-4157-9637-50d7d3334f41", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "2d38b9ae-e867-4d50-a8ed-fb34940caea8", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "2c5b8215-22d6-4a46-917b-d0a46b27e541", "sales_organization_code": "sample string 5", "sales_organization": { "id": "56083d33-f066-4b9d-b3cb-0ca89ffbf6af", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "2e2e4457-c32f-4494-980f-ef166a8663e8", "db_currency_id": "96112ff6-380c-42d5-9b3a-853d6f4d0c05", "db_language_id": "5dcd7526-03c1-423d-a496-8db6107997fd", "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-12-27T16:23:18.7578406+00:00" }, "modified_dateutc": "2024-12-27T16:23:18.7578406+00:00" }, "equipment_family_id": "ab6f27bc-fb6c-44c2-819b-cfa5103b4b88", "equipment_family_code": "sample string 8", "equipment_family": { "id": "7a2abe74-c2c1-4666-a85f-b1209d7a2c9e", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "21374353-d413-421c-a89f-fe21e5ae7d9e", "_parent_code": "sample string 6", "sales_organization_id": "7031785e-071d-40d2-93ab-3c6a655ee9b6", "sales_organization_code": "sample string 8", "sales_organization": { "id": "56083d33-f066-4b9d-b3cb-0ca89ffbf6af", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "2e2e4457-c32f-4494-980f-ef166a8663e8", "db_currency_id": "96112ff6-380c-42d5-9b3a-853d6f4d0c05", "db_language_id": "5dcd7526-03c1-423d-a496-8db6107997fd", "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-12-27T16:23:18.7578406+00:00" }, "modified_dateutc": "2024-12-27T16:23:18.7578406+00:00" }, "date_in_production_since": "2024-12-27T16:23:18.7578406+00:00", "date_out_of_production_since": "2024-12-27T16:23:18.7578406+00:00", "date_end_support": "2024-12-27T16:23:18.7578406+00:00", "sales_organization_id": "c4530764-0e3d-497b-b73b-b05ee0921243", "sales_organization_code": "sample string 13", "sales_organization": { "id": "56083d33-f066-4b9d-b3cb-0ca89ffbf6af", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "2e2e4457-c32f-4494-980f-ef166a8663e8", "db_currency_id": "96112ff6-380c-42d5-9b3a-853d6f4d0c05", "db_language_id": "5dcd7526-03c1-423d-a496-8db6107997fd", "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-12-27T16:23:18.7578406+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-12-27T16:23:18.7578406+00:00" }, "project_status_id": "9fca40d7-3c88-40b8-9848-ddde9be88830", "project_status_code": "sample string 10", "project_status": { "id": "6bdbd714-d79a-4895-afa9-2e514ecb2bbe", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "ec0fe102-85a7-4d8d-b70e-6514c3c645ef", "sales_organization_code": "sample string 6", "sales_organization": { "id": "56083d33-f066-4b9d-b3cb-0ca89ffbf6af", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "2e2e4457-c32f-4494-980f-ef166a8663e8", "db_currency_id": "96112ff6-380c-42d5-9b3a-853d6f4d0c05", "db_language_id": "5dcd7526-03c1-423d-a496-8db6107997fd", "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-12-27T16:23:18.7578406+00:00" }, "code": "sample string 7", "modified_dateutc": "2024-12-27T16:23:18.7578406+00:00" }, "company_id": "12ebca16-9503-452a-bf9a-7a05fea7d24a", "company_code": "sample string 12", "db_address_id": "694e7e23-a3e6-4970-9c3a-19a74ad5a66e", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "bcf37bbf-bd56-46f1-9b31-d7a835428a22", "contact_reference_back_office": "sample string 17", "owner_user_id": "2007c8ab-a4d6-4210-9493-0567a961d793", "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-12-27T16:23:18.7578406+00:00", "date_create": "2024-12-27T16:23:18.7578406+00:00", "date_update": "2024-12-27T16:23:18.7578406+00:00", "updated_by_user_id": "45390740-25c2-47e1-a77d-22c0d572fcc4", "customer_reference": "sample string 28", "warranty_date_until": "2024-12-27T16:23:18.7578406+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-12-27T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2024-12-27T16:23:18.7578406+00:00", "date_last_job": "2024-12-27T16:23:18.7578406+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2024-12-27T16:23:18.7578406+00:00", "modified_dateutc": "2024-12-27T16:23:18.7578406+00:00", "is_mobile_installation": true }, "job_type_id": "ee1d3528-ff1b-488e-9cbe-779ea41648f5", "job_type_code": "sample string 7", "job_type": { "id": "650bba9d-a099-4635-a9b4-f86ea42dc13e", "name": "sample string 2", "sales_organization_id": "304c7997-2887-4ef2-8c0e-ef4a9ba80006", "description": "sample string 4", "is_default": true, "modified_dateutc": "2024-12-27T16:23:18.7578406+00:00", "code": "sample string 7" }, "job_priority_id": "4e10c338-43b2-48a2-bc26-e9394b4fa2b1", "job_priority_code": "sample string 9", "job_priority": { "id": "fe95ea70-e1eb-4bb1-827a-030dff3ba148", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "99c75d8d-9e76-4974-ad01-364a953743b9", "sales_organization_code": "sample string 6", "sales_organization": { "id": "56083d33-f066-4b9d-b3cb-0ca89ffbf6af", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "2e2e4457-c32f-4494-980f-ef166a8663e8", "db_currency_id": "96112ff6-380c-42d5-9b3a-853d6f4d0c05", "db_language_id": "5dcd7526-03c1-423d-a496-8db6107997fd", "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-12-27T16:23:18.7578406+00:00" }, "code": "sample string 7", "modified_dateutc": "2024-12-27T16:23:18.7578406+00:00" }, "job_status_id": "d4ded6d4-8399-44ca-9a6e-2ef2daa52592", "job_status_code": "sample string 11", "db_address_id": "720ec83b-638e-4bd9-ab09-cab1ed188541", "contact_id": "3ddc3500-cadb-4fb4-8dd5-c99f08f8f9a3", "requested_by_company_id": "d899ca8e-8a2f-40f4-b070-243974c1e827", "requested_by_contact_id": "0a3c9938-f588-4ebf-8db8-6ad63d4d6262", "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-12-27T16:23:18.7578406+00:00", "due_date": "2024-12-27T16:23:18.7578406+00:00", "date_create": "2024-12-27T16:23:18.7578406+00:00", "date_update": "2024-12-27T16:23:18.7578406+00:00", "date_closed": "2024-12-27T16:23:18.7578406+00:00", "suggested_user_id": "fba63ca3-34b3-49f3-9669-2234ba909d6f", "suggested_user_code": "sample string 29", "suggested_user": { "id": "f5f94774-55a0-402f-a7c3-81375c6fd6ff", "db_language_id": "3bb50dff-1266-48af-a6a8-69f604040ec5", "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-12-27T16:23:18.7578406+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "e81732eb-ba89-4d04-aec4-8d8cb39907c0", "sales_organization": { "id": "56083d33-f066-4b9d-b3cb-0ca89ffbf6af", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "2e2e4457-c32f-4494-980f-ef166a8663e8", "db_currency_id": "96112ff6-380c-42d5-9b3a-853d6f4d0c05", "db_language_id": "5dcd7526-03c1-423d-a496-8db6107997fd", "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-12-27T16:23:18.7578406+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "77f6f641-74d6-419e-94b4-34a18974f316", "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": "0f0a8560-3812-46a9-9919-e088ecb52c9d", "private_db_country_code": "sample string 35", "modified_dateutc": "2024-12-27T16:23:18.7578406+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "b1b1e0ca-f0a0-4af9-9cab-d67f4fec24bb" }, "suggested_date_start": "2024-12-27T16:23:18.7578406+00:00", "skill_id": "1e79aa39-9c8a-4a39-87d4-4d0e5be47e18", "skill_code": "sample string 32", "skill": { "id": "7d74ec0c-e90d-41eb-8e81-0a65143ccfc3", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "166b4374-afb7-4774-9934-e083207cf27f", "sales_organization_code": "sample string 6", "sales_organization": { "id": "56083d33-f066-4b9d-b3cb-0ca89ffbf6af", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "2e2e4457-c32f-4494-980f-ef166a8663e8", "db_currency_id": "96112ff6-380c-42d5-9b3a-853d6f4d0c05", "db_language_id": "5dcd7526-03c1-423d-a496-8db6107997fd", "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-12-27T16:23:18.7578406+00:00" }, "modified_dateutc": "2024-12-27T16:23:18.7578406+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "4fe5476f-2a79-4f18-98a9-3bb57537174f", "date_reported_by_company": "2024-12-27T16:23:18.7578406+00:00", "id2": 36, "company_id": "a014a741-3fdd-4df7-acec-efb62e17e972", "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": "1fddf48f-f426-46f1-831e-6ab2fa8f2a5d", "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-12-27T16:23:18.7578406+00:00" }
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.