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": "9210b343-bf09-45f5-a2cb-50786b422463", "_parent_id": "59e44ad2-974f-45d2-9877-5573981cef19", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "c082fe6a-cc06-4837-915d-63eeb50ca1c9", "project_reference_back_office": "sample string 5", "project": { "id": "24c3cdde-e39b-455f-954d-751de3914fb4", "_parent_id": "a06c0336-598c-4083-996d-e21d4c215a80", "root_parent_id": "7d979d56-d8d6-49c1-aa57-0750e959662c", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "c876e0e8-a799-4235-8c3f-76005537e11f", "equipment_family_code": "sample string 6", "equipment_family": { "id": "ec030916-f33f-4eca-b115-93010210c82c", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "d3f70072-0300-4f6b-b811-2299acc50854", "_parent_code": "sample string 6", "sales_organization_id": "618e9ebe-0c94-4d6a-a9b7-cffeafc21896", "sales_organization_code": "sample string 8", "sales_organization": { "id": "20211773-306f-400a-b54b-55a857febdfb", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "6d2fa41e-c7c3-453f-8e03-b4c2a188995c", "db_currency_id": "796b5bdf-d48a-4dcc-987c-4080554214ca", "db_language_id": "5daa592c-e4c9-47b7-bd40-7034dde8e35c", "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-01-22T01:22:51.1047975+00:00" }, "modified_dateutc": "2025-01-22T01:22:51.1047975+00:00" }, "equipment_model_id": "321d8fda-795f-4a6c-9dba-8fc63677aaeb", "equipment_model_code": "sample string 8", "equipment_model": { "id": "add9d34a-b587-4fb3-b25d-ac2a57ad43ff", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "c986b7ae-0e99-44fe-94ca-0c769251d805", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "cc58c4dd-52d6-4dec-8943-6cbfe6686898", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "6fcc833e-7bb4-44f1-a8a3-c2b092c7ed5c", "sales_organization_code": "sample string 5", "sales_organization": { "id": "20211773-306f-400a-b54b-55a857febdfb", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "6d2fa41e-c7c3-453f-8e03-b4c2a188995c", "db_currency_id": "796b5bdf-d48a-4dcc-987c-4080554214ca", "db_language_id": "5daa592c-e4c9-47b7-bd40-7034dde8e35c", "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-01-22T01:22:51.1047975+00:00" }, "modified_dateutc": "2025-01-22T01:22:51.1047975+00:00" }, "equipment_family_id": "121e7691-a6ef-4730-bdcd-a41691f21d7d", "equipment_family_code": "sample string 8", "equipment_family": { "id": "ec030916-f33f-4eca-b115-93010210c82c", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "d3f70072-0300-4f6b-b811-2299acc50854", "_parent_code": "sample string 6", "sales_organization_id": "618e9ebe-0c94-4d6a-a9b7-cffeafc21896", "sales_organization_code": "sample string 8", "sales_organization": { "id": "20211773-306f-400a-b54b-55a857febdfb", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "6d2fa41e-c7c3-453f-8e03-b4c2a188995c", "db_currency_id": "796b5bdf-d48a-4dcc-987c-4080554214ca", "db_language_id": "5daa592c-e4c9-47b7-bd40-7034dde8e35c", "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-01-22T01:22:51.1047975+00:00" }, "modified_dateutc": "2025-01-22T01:22:51.1047975+00:00" }, "date_in_production_since": "2025-01-22T01:22:51.1047975+00:00", "date_out_of_production_since": "2025-01-22T01:22:51.1047975+00:00", "date_end_support": "2025-01-22T01:22:51.1047975+00:00", "sales_organization_id": "3a4b5c9e-2ddc-4fde-b3c8-a7cda2332c31", "sales_organization_code": "sample string 13", "sales_organization": { "id": "20211773-306f-400a-b54b-55a857febdfb", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "6d2fa41e-c7c3-453f-8e03-b4c2a188995c", "db_currency_id": "796b5bdf-d48a-4dcc-987c-4080554214ca", "db_language_id": "5daa592c-e4c9-47b7-bd40-7034dde8e35c", "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-01-22T01:22:51.1047975+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-01-22T01:22:51.1204261+00:00" }, "project_status_id": "f84a5f55-ac49-4ec2-91bb-1c6d4a744345", "project_status_code": "sample string 10", "project_status": { "id": "78057e94-dd32-4f32-bd0a-ab84ffed1ef7", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "e96b3b7c-71fc-4bdc-9b2b-ce00732d7ed3", "sales_organization_code": "sample string 6", "sales_organization": { "id": "20211773-306f-400a-b54b-55a857febdfb", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "6d2fa41e-c7c3-453f-8e03-b4c2a188995c", "db_currency_id": "796b5bdf-d48a-4dcc-987c-4080554214ca", "db_language_id": "5daa592c-e4c9-47b7-bd40-7034dde8e35c", "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-01-22T01:22:51.1047975+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-01-22T01:22:51.1204261+00:00" }, "company_id": "1148579c-4aa0-4d51-9739-231b0e1e71e5", "company_code": "sample string 12", "db_address_id": "0ea514de-99e6-4634-a046-d219c6a4aaee", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "99a305a8-13b9-45a2-95b9-2014680c09c4", "contact_reference_back_office": "sample string 17", "owner_user_id": "6cd4ff99-17e6-46b6-81e2-fd487728defa", "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-01-22T01:22:51.1204261+00:00", "date_create": "2025-01-22T01:22:51.1204261+00:00", "date_update": "2025-01-22T01:22:51.1204261+00:00", "updated_by_user_id": "14add8f3-661a-4ed2-a445-0d6220472853", "customer_reference": "sample string 28", "warranty_date_until": "2025-01-22T01:22:51.1204261+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-01-22T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-01-22T01:22:51.1204261+00:00", "date_last_job": "2025-01-22T01:22:51.1204261+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-01-22T01:22:51.1204261+00:00", "modified_dateutc": "2025-01-22T01:22:51.1204261+00:00", "is_mobile_installation": true }, "job_type_id": "06422c41-b204-4e6d-8968-74cb9bb57ae3", "job_type_code": "sample string 7", "job_type": { "id": "a150c5ce-46e2-4d78-8f79-cb5d09eb10cc", "name": "sample string 2", "sales_organization_id": "fe4d04bb-8630-46d9-b827-a13e42e17886", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-01-22T01:22:51.1204261+00:00", "code": "sample string 7" }, "job_priority_id": "9a0b9d95-5fae-442a-b38f-4a7802fa26de", "job_priority_code": "sample string 9", "job_priority": { "id": "0c2284ac-217f-40f4-b0df-06f1e4b3223d", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "089c7539-4a32-4cee-8f8c-e267545b0848", "sales_organization_code": "sample string 6", "sales_organization": { "id": "20211773-306f-400a-b54b-55a857febdfb", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "6d2fa41e-c7c3-453f-8e03-b4c2a188995c", "db_currency_id": "796b5bdf-d48a-4dcc-987c-4080554214ca", "db_language_id": "5daa592c-e4c9-47b7-bd40-7034dde8e35c", "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-01-22T01:22:51.1047975+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-01-22T01:22:51.1204261+00:00" }, "job_status_id": "09789655-0746-4598-859c-7ef8ca6848a5", "job_status_code": "sample string 11", "db_address_id": "883acb22-48b5-4b24-a1db-ed7a7e91c8f7", "contact_id": "0e079f76-e660-4901-8939-69aed6db944d", "requested_by_company_id": "769f0d5d-5553-4a95-9b32-dcc5d4cf6cd9", "requested_by_contact_id": "4bb699f7-d897-4290-aba2-b071e70eda3e", "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-01-22T01:22:51.1204261+00:00", "due_date": "2025-01-22T01:22:51.1204261+00:00", "date_create": "2025-01-22T01:22:51.1204261+00:00", "date_update": "2025-01-22T01:22:51.1204261+00:00", "date_closed": "2025-01-22T01:22:51.1204261+00:00", "suggested_user_id": "954f7ec3-758b-423c-9845-d75cdaab3420", "suggested_user_code": "sample string 29", "suggested_user": { "id": "b316c674-628a-4a7d-b7c3-b66ba2db3750", "db_language_id": "213f87f3-28f3-4214-8ec1-fb5863198e83", "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-01-22T01:22:51.1204261+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "27e9bac7-ea98-4147-8132-a2c402da2895", "sales_organization": { "id": "20211773-306f-400a-b54b-55a857febdfb", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "6d2fa41e-c7c3-453f-8e03-b4c2a188995c", "db_currency_id": "796b5bdf-d48a-4dcc-987c-4080554214ca", "db_language_id": "5daa592c-e4c9-47b7-bd40-7034dde8e35c", "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-01-22T01:22:51.1047975+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "189de105-7516-4a70-a97c-fe861614c9e1", "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": "c5186d22-35fa-4610-9eba-5c2111b2bf5d", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-01-22T01:22:51.1204261+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "6237d138-7a84-4489-838b-d46b45120621" }, "suggested_date_start": "2025-01-22T01:22:51.1204261+00:00", "skill_id": "2bf79eb4-fdff-4a7a-86c6-8ff033ff8629", "skill_code": "sample string 32", "skill": { "id": "e8dcdfad-50b2-4e07-8456-b0734a626a25", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "480781fc-6aac-4610-a4ec-b9e9648268ba", "sales_organization_code": "sample string 6", "sales_organization": { "id": "20211773-306f-400a-b54b-55a857febdfb", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "6d2fa41e-c7c3-453f-8e03-b4c2a188995c", "db_currency_id": "796b5bdf-d48a-4dcc-987c-4080554214ca", "db_language_id": "5daa592c-e4c9-47b7-bd40-7034dde8e35c", "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-01-22T01:22:51.1047975+00:00" }, "modified_dateutc": "2025-01-22T01:22:51.1204261+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "508e35f1-9a8f-48b7-a0dd-a382c776393e", "date_reported_by_company": "2025-01-22T01:22:51.1204261+00:00", "id2": 36, "company_id": "a19676fe-529e-4a05-93ba-5dccf2ae891b", "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": "f1818c17-a435-43b4-864d-5c0eeec46719", "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-01-22T01:22:51.1204261+00:00" }
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.