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": "cb05117a-9835-4d1f-b472-fa6a2769230f", "_parent_id": "9bb73543-f564-4050-a759-3c2e02be1326", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "c9b919fa-9e7a-4d7a-8665-cfff88e6d42b", "project_reference_back_office": "sample string 5", "project": { "id": "df6f1f1d-2acd-4c0b-8a32-c8274ff2cb8c", "_parent_id": "a4afaf33-b6ab-441e-ac53-1bf4575032be", "root_parent_id": "508cecf3-6eaf-496e-846f-df8d709f69de", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "dc5ccb3e-3c4d-4757-988a-775d79ab9ee9", "equipment_family_code": "sample string 6", "equipment_family": { "id": "23095975-caaf-4b6d-9eba-b42e765a95f6", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "47de76e7-8ace-4be6-80e5-d2d5737ca9c7", "_parent_code": "sample string 6", "sales_organization_id": "5f539d0e-0203-4d3a-8b78-e96bb5c40c1c", "sales_organization_code": "sample string 8", "sales_organization": { "id": "3cf045d5-01ef-4783-b1ae-dd51f7184043", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "da4251e6-e06d-4f3a-baa9-61361725b788", "db_currency_id": "cd574387-8854-4f5f-aab1-473f2424ace3", "db_language_id": "7542bdad-074d-4597-a6ea-cae6bb40a87a", "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-03-29T14:16:51.320259+00:00" }, "modified_dateutc": "2024-03-29T14:16:51.320259+00:00" }, "equipment_model_id": "46b88619-2e3c-4ea8-a573-77be241aba4d", "equipment_model_code": "sample string 8", "equipment_model": { "id": "239f7f3a-c46e-459e-ba1f-e707dd06fd18", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "e8156e9c-5e10-461b-b456-66a132eba2b3", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "f445fe8a-6e65-439d-9f7e-add18dd0f9af", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "2c13e9dd-f06a-40d5-98cb-2305d4e229c6", "sales_organization_code": "sample string 5", "sales_organization": { "id": "3cf045d5-01ef-4783-b1ae-dd51f7184043", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "da4251e6-e06d-4f3a-baa9-61361725b788", "db_currency_id": "cd574387-8854-4f5f-aab1-473f2424ace3", "db_language_id": "7542bdad-074d-4597-a6ea-cae6bb40a87a", "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-03-29T14:16:51.320259+00:00" }, "modified_dateutc": "2024-03-29T14:16:51.320259+00:00" }, "equipment_family_id": "0fb89a51-6b59-439b-b83f-705af035c9a3", "equipment_family_code": "sample string 8", "equipment_family": { "id": "23095975-caaf-4b6d-9eba-b42e765a95f6", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "47de76e7-8ace-4be6-80e5-d2d5737ca9c7", "_parent_code": "sample string 6", "sales_organization_id": "5f539d0e-0203-4d3a-8b78-e96bb5c40c1c", "sales_organization_code": "sample string 8", "sales_organization": { "id": "3cf045d5-01ef-4783-b1ae-dd51f7184043", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "da4251e6-e06d-4f3a-baa9-61361725b788", "db_currency_id": "cd574387-8854-4f5f-aab1-473f2424ace3", "db_language_id": "7542bdad-074d-4597-a6ea-cae6bb40a87a", "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-03-29T14:16:51.320259+00:00" }, "modified_dateutc": "2024-03-29T14:16:51.320259+00:00" }, "date_in_production_since": "2024-03-29T14:16:51.320259+00:00", "date_out_of_production_since": "2024-03-29T14:16:51.320259+00:00", "date_end_support": "2024-03-29T14:16:51.320259+00:00", "sales_organization_id": "00c467fc-a345-46c1-bb0c-f5817b23b97f", "sales_organization_code": "sample string 13", "sales_organization": { "id": "3cf045d5-01ef-4783-b1ae-dd51f7184043", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "da4251e6-e06d-4f3a-baa9-61361725b788", "db_currency_id": "cd574387-8854-4f5f-aab1-473f2424ace3", "db_language_id": "7542bdad-074d-4597-a6ea-cae6bb40a87a", "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-03-29T14:16:51.320259+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-03-29T14:16:51.320259+00:00" }, "project_status_id": "31b1e351-3476-49c9-8d2c-189d2ccd1ff7", "project_status_code": "sample string 10", "project_status": { "id": "a6b2b003-1a46-4bbd-9f14-f6633e2d7b05", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "15bb5466-d15a-4eb6-80ad-2920f167c324", "sales_organization_code": "sample string 6", "sales_organization": { "id": "3cf045d5-01ef-4783-b1ae-dd51f7184043", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "da4251e6-e06d-4f3a-baa9-61361725b788", "db_currency_id": "cd574387-8854-4f5f-aab1-473f2424ace3", "db_language_id": "7542bdad-074d-4597-a6ea-cae6bb40a87a", "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-03-29T14:16:51.320259+00:00" }, "code": "sample string 7", "modified_dateutc": "2024-03-29T14:16:51.320259+00:00" }, "company_id": "7a610d4d-b986-4ca2-8fcf-a4357ffd0b2a", "company_code": "sample string 12", "db_address_id": "0b1fcb3a-6121-4f05-8b20-213588384e0f", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "0fe040fa-9c85-4ab5-8c5f-47a40d2c52e5", "contact_reference_back_office": "sample string 17", "owner_user_id": "7e9187af-a6d7-42df-a420-a381b5e5eb2a", "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-03-29T14:16:51.320259+00:00", "date_create": "2024-03-29T14:16:51.320259+00:00", "date_update": "2024-03-29T14:16:51.320259+00:00", "updated_by_user_id": "3c23d30f-e22a-4187-a0fa-edc2c9b9e5cc", "customer_reference": "sample string 28", "warranty_date_until": "2024-03-29T14:16:51.320259+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-03-29T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2024-03-29T14:16:51.320259+00:00", "date_last_job": "2024-03-29T14:16:51.320259+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2024-03-29T14:16:51.320259+00:00", "modified_dateutc": "2024-03-29T14:16:51.320259+00:00", "is_mobile_installation": true }, "job_type_id": "7aa25ba0-cc00-4214-8bce-0f66f7002350", "job_type_code": "sample string 7", "job_type": { "id": "cdcbc6fc-7c54-4041-81fc-5ede5f22e8c2", "name": "sample string 2", "sales_organization_id": "fe46a4a5-99ce-45f9-b564-aec796e6d544", "description": "sample string 4", "is_default": true, "modified_dateutc": "2024-03-29T14:16:51.320259+00:00", "code": "sample string 7" }, "job_priority_id": "cf8d4269-d10e-461b-b8ba-4cd2cf8b0b49", "job_priority_code": "sample string 9", "job_priority": { "id": "7bf31aed-7669-40d6-b20b-0582046cbe15", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "d6e151a1-8b84-4a51-83bb-93eb694902c2", "sales_organization_code": "sample string 6", "sales_organization": { "id": "3cf045d5-01ef-4783-b1ae-dd51f7184043", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "da4251e6-e06d-4f3a-baa9-61361725b788", "db_currency_id": "cd574387-8854-4f5f-aab1-473f2424ace3", "db_language_id": "7542bdad-074d-4597-a6ea-cae6bb40a87a", "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-03-29T14:16:51.320259+00:00" }, "code": "sample string 7", "modified_dateutc": "2024-03-29T14:16:51.320259+00:00" }, "job_status_id": "e47cf4b2-a770-4830-923a-6dbf85b488a4", "job_status_code": "sample string 11", "db_address_id": "e1f2b712-0597-4e54-b559-337e6e293185", "contact_id": "2716dc0a-0daa-4c93-865b-53c8bcdef707", "requested_by_company_id": "6e230802-915c-429c-bc68-14b055d9b868", "requested_by_contact_id": "8be96990-54c4-484b-a613-ada26855de91", "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-03-29T14:16:51.320259+00:00", "due_date": "2024-03-29T14:16:51.320259+00:00", "date_create": "2024-03-29T14:16:51.320259+00:00", "date_update": "2024-03-29T14:16:51.320259+00:00", "date_closed": "2024-03-29T14:16:51.320259+00:00", "suggested_user_id": "0c458b30-b374-421a-a460-03b591962c95", "suggested_user_code": "sample string 29", "suggested_user": { "id": "96ac4e5a-4d27-4a93-8ccb-481364b0a842", "db_language_id": "b482d5ac-3dd9-4d97-8dea-0c937363e53a", "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-03-29T14:16:51.320259+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "2ff7fefa-8c67-4cf2-b374-8d2f2a40d0ac", "sales_organization": { "id": "3cf045d5-01ef-4783-b1ae-dd51f7184043", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "da4251e6-e06d-4f3a-baa9-61361725b788", "db_currency_id": "cd574387-8854-4f5f-aab1-473f2424ace3", "db_language_id": "7542bdad-074d-4597-a6ea-cae6bb40a87a", "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-03-29T14:16:51.320259+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "d21afe4b-503a-4537-9b1b-24cff6760d2d", "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": "70dc9040-389c-42d3-ac9f-ba106c3dc586", "private_db_country_code": "sample string 35", "modified_dateutc": "2024-03-29T14:16:51.320259+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "baaff1fa-2168-4edb-bbe9-8a95055c5395" }, "suggested_date_start": "2024-03-29T14:16:51.320259+00:00", "skill_id": "9b8b5a90-2a03-47ee-915f-81a9057a4cc4", "skill_code": "sample string 32", "skill": { "id": "eb50e452-71aa-4702-b2e8-6d49ac828c6f", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "93729cac-6b63-434c-afbb-781d10332ed6", "sales_organization_code": "sample string 6", "sales_organization": { "id": "3cf045d5-01ef-4783-b1ae-dd51f7184043", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "da4251e6-e06d-4f3a-baa9-61361725b788", "db_currency_id": "cd574387-8854-4f5f-aab1-473f2424ace3", "db_language_id": "7542bdad-074d-4597-a6ea-cae6bb40a87a", "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-03-29T14:16:51.320259+00:00" }, "modified_dateutc": "2024-03-29T14:16:51.320259+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "4d81549a-65ec-45cf-b5e8-280b8fb32f29", "date_reported_by_company": "2024-03-29T14:16:51.320259+00:00", "id2": 36, "company_id": "aed401a9-aac3-4720-8986-60a2d5db7db5", "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": "66d7567c-c96a-4830-a3b4-97ee12a81605", "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-03-29T14:16:51.320259+00:00" }
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.