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": "8aaebceb-5bd9-4f79-b333-230c01d739fd", "_parent_id": "cd783a41-b407-4257-900c-2f827a20529d", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "6a5c1f6d-b362-48f3-b121-dfc4ebd03b8a", "project_reference_back_office": "sample string 5", "project": { "id": "ad0782a6-3fab-4dcd-8395-8fe45c8e4b7f", "_parent_id": "615f9a7f-5b3d-425c-aa11-6bd614424759", "root_parent_id": "9674e6ff-09c8-4e2c-9ce6-db769eddb499", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "cd175623-1d40-4911-bc12-e96c48abe66b", "equipment_family_code": "sample string 6", "equipment_family": { "id": "f6db79ac-dd7a-471c-bac0-ec306401d8c1", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "928b9101-8b2c-42f2-b31e-c44942cd2687", "_parent_code": "sample string 6", "sales_organization_id": "07ef0947-f54d-406f-b1c9-abe76b76bbe7", "sales_organization_code": "sample string 8", "sales_organization": { "id": "6984de75-e84a-4382-809c-54620cda0342", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "95f48b1b-7bb8-402b-92f5-d2999527c1ff", "db_currency_id": "2551a193-e275-4e3e-881f-15eab2a6cdb0", "db_language_id": "031a34ea-9eb7-4a8e-9923-0cb596ce6fcf", "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-25T15:56:27.8648489+00:00" }, "modified_dateutc": "2025-04-25T15:56:27.8648489+00:00" }, "equipment_model_id": "2ff27e88-c88c-4279-ad46-0760c2c005a5", "equipment_model_code": "sample string 8", "equipment_model": { "id": "5115e68f-dc8f-4757-8025-fcd2ca0ebec6", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "c4d6932a-e5fe-456d-abf0-1c4e06ac6d87", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "83dfe952-c3a0-46e6-9e37-58e996f84ee2", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "f17ca1eb-07fe-484a-90a5-2a0cd5299b0d", "sales_organization_code": "sample string 5", "sales_organization": { "id": "6984de75-e84a-4382-809c-54620cda0342", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "95f48b1b-7bb8-402b-92f5-d2999527c1ff", "db_currency_id": "2551a193-e275-4e3e-881f-15eab2a6cdb0", "db_language_id": "031a34ea-9eb7-4a8e-9923-0cb596ce6fcf", "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-25T15:56:27.8648489+00:00" }, "modified_dateutc": "2025-04-25T15:56:27.8648489+00:00" }, "equipment_family_id": "f591b7c6-5e63-4381-b4c3-5741cc8ffb77", "equipment_family_code": "sample string 8", "equipment_family": { "id": "f6db79ac-dd7a-471c-bac0-ec306401d8c1", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "928b9101-8b2c-42f2-b31e-c44942cd2687", "_parent_code": "sample string 6", "sales_organization_id": "07ef0947-f54d-406f-b1c9-abe76b76bbe7", "sales_organization_code": "sample string 8", "sales_organization": { "id": "6984de75-e84a-4382-809c-54620cda0342", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "95f48b1b-7bb8-402b-92f5-d2999527c1ff", "db_currency_id": "2551a193-e275-4e3e-881f-15eab2a6cdb0", "db_language_id": "031a34ea-9eb7-4a8e-9923-0cb596ce6fcf", "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-25T15:56:27.8648489+00:00" }, "modified_dateutc": "2025-04-25T15:56:27.8648489+00:00" }, "date_in_production_since": "2025-04-25T15:56:27.8648489+00:00", "date_out_of_production_since": "2025-04-25T15:56:27.8648489+00:00", "date_end_support": "2025-04-25T15:56:27.8648489+00:00", "sales_organization_id": "29c02c0a-dab6-4543-8373-582b27e2f688", "sales_organization_code": "sample string 13", "sales_organization": { "id": "6984de75-e84a-4382-809c-54620cda0342", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "95f48b1b-7bb8-402b-92f5-d2999527c1ff", "db_currency_id": "2551a193-e275-4e3e-881f-15eab2a6cdb0", "db_language_id": "031a34ea-9eb7-4a8e-9923-0cb596ce6fcf", "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-25T15:56:27.8648489+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-25T15:56:27.8648489+00:00" }, "project_status_id": "2e4fbe1b-5e6d-40bd-a93e-aa4330b4e6ef", "project_status_code": "sample string 10", "project_status": { "id": "e8fea055-9947-4561-830c-8b60ec794274", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "03e7d131-6a04-4b76-bde4-17d16204e3f8", "sales_organization_code": "sample string 6", "sales_organization": { "id": "6984de75-e84a-4382-809c-54620cda0342", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "95f48b1b-7bb8-402b-92f5-d2999527c1ff", "db_currency_id": "2551a193-e275-4e3e-881f-15eab2a6cdb0", "db_language_id": "031a34ea-9eb7-4a8e-9923-0cb596ce6fcf", "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-25T15:56:27.8648489+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-04-25T15:56:27.8648489+00:00" }, "company_id": "02f78145-1c46-4878-9ea1-5b51ba8b667e", "company_code": "sample string 12", "db_address_id": "9669da77-3f3e-4db0-96b1-45bfe9c50bc7", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "6de2d4cc-4606-4b70-8d12-d7f41d4cc496", "contact_reference_back_office": "sample string 17", "owner_user_id": "8de84f67-9bfa-4a58-bb06-ef31f8c112f9", "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-25T15:56:27.8648489+00:00", "date_create": "2025-04-25T15:56:27.8648489+00:00", "date_update": "2025-04-25T15:56:27.8648489+00:00", "updated_by_user_id": "0596704b-5bad-4557-b084-b9586fbda046", "customer_reference": "sample string 28", "warranty_date_until": "2025-04-25T15:56:27.8648489+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-25T15:56:27.8648489+00:00", "date_last_job": "2025-04-25T15:56:27.8648489+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-04-25T15:56:27.8648489+00:00", "modified_dateutc": "2025-04-25T15:56:27.8648489+00:00", "is_mobile_installation": true }, "job_type_id": "3cbb9b4c-4fd3-4ea7-bc96-35295cb311eb", "job_type_code": "sample string 7", "job_type": { "id": "9388c73e-d4e6-4873-9b75-c715ba71236a", "name": "sample string 2", "sales_organization_id": "f012fdba-bdc7-4fa9-b20f-928e6eebec71", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-04-25T15:56:27.8648489+00:00", "code": "sample string 7" }, "job_priority_id": "68835b62-ea89-46bb-90a1-b6ec9b664dcb", "job_priority_code": "sample string 9", "job_priority": { "id": "69bb2454-bca3-44bb-8c34-01ec65c0d991", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "88e5fb53-6526-4030-9dba-0f717ed93fea", "sales_organization_code": "sample string 6", "sales_organization": { "id": "6984de75-e84a-4382-809c-54620cda0342", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "95f48b1b-7bb8-402b-92f5-d2999527c1ff", "db_currency_id": "2551a193-e275-4e3e-881f-15eab2a6cdb0", "db_language_id": "031a34ea-9eb7-4a8e-9923-0cb596ce6fcf", "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-25T15:56:27.8648489+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-04-25T15:56:27.8648489+00:00" }, "job_status_id": "f62480ee-763c-4660-8eee-f9ec18e1b237", "job_status_code": "sample string 11", "db_address_id": "fbdbe3b4-8dbc-4387-ad24-8567dfccff71", "contact_id": "b9934bb0-e58b-4166-bbe2-f29c59507d08", "requested_by_company_id": "15e18c80-9dc7-4ed1-8ae6-4f8f89c1c193", "requested_by_contact_id": "a0554a59-f53d-4f56-8232-89cf8aa4fda8", "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-25T15:56:27.8648489+00:00", "due_date": "2025-04-25T15:56:27.8648489+00:00", "date_create": "2025-04-25T15:56:27.8648489+00:00", "date_update": "2025-04-25T15:56:27.8648489+00:00", "date_closed": "2025-04-25T15:56:27.8648489+00:00", "suggested_user_id": "cb06c44a-4794-43fd-aa53-1c2e7c16032a", "suggested_user_code": "sample string 29", "suggested_user": { "id": "36e2d8e0-ef84-4ac3-b7e6-cb1bd9271328", "db_language_id": "f49e6744-f63b-4df0-93d9-c00a710e38c1", "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-25T15:56:27.8648489+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "67670041-d780-4960-93c5-cddab5cb8d24", "sales_organization": { "id": "6984de75-e84a-4382-809c-54620cda0342", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "95f48b1b-7bb8-402b-92f5-d2999527c1ff", "db_currency_id": "2551a193-e275-4e3e-881f-15eab2a6cdb0", "db_language_id": "031a34ea-9eb7-4a8e-9923-0cb596ce6fcf", "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-25T15:56:27.8648489+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "bedf8785-f786-4740-9450-10575cff7670", "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": "d247783c-61d3-4f73-9653-2479fce74508", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-04-25T15:56:27.8648489+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "f7aadff9-f013-46cb-850d-30cf1d48c3ff" }, "suggested_date_start": "2025-04-25T15:56:27.8648489+00:00", "skill_id": "00da9c00-fd81-4ba7-a4a1-961cefff2917", "skill_code": "sample string 32", "skill": { "id": "fe808680-1898-4db8-b8ea-c15b682b0639", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "42a2ea1f-aa63-4a36-83ef-9be350f954e3", "sales_organization_code": "sample string 6", "sales_organization": { "id": "6984de75-e84a-4382-809c-54620cda0342", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "95f48b1b-7bb8-402b-92f5-d2999527c1ff", "db_currency_id": "2551a193-e275-4e3e-881f-15eab2a6cdb0", "db_language_id": "031a34ea-9eb7-4a8e-9923-0cb596ce6fcf", "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-25T15:56:27.8648489+00:00" }, "modified_dateutc": "2025-04-25T15:56:27.8648489+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "c5cb2e69-05c4-48f6-a41b-14c500944941", "date_reported_by_company": "2025-04-25T15:56:27.8648489+00:00", "id2": 36, "company_id": "9758964b-85e5-4062-8fff-77ebd5f1803c", "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": "0659d33f-8189-46f3-9a92-8c5115ef1121", "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-25T15:56:27.8648489+00:00" }
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.