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": "e1fd74e2-965a-4141-8938-49f1a11ed015", "_parent_id": "cfd340e3-959c-4b5a-92a4-234deed34c43", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "d350279c-85f4-4c0a-9808-a8c69a0b34ee", "project_reference_back_office": "sample string 5", "project": { "id": "044524a0-54bf-4e6e-8181-089964bfa1a6", "_parent_id": "62aa5db8-e4e1-414f-a45a-f1cbfee3dfd2", "root_parent_id": "07d9b771-e641-42b1-aa8f-373124d5790e", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "21784608-4d52-4592-9d2c-6f8fc1f938cf", "equipment_family_code": "sample string 6", "equipment_family": { "id": "13146fad-10b6-46f0-b8c5-0e5a413fe035", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "57aa91f5-c72a-449f-9d89-2a5285607027", "_parent_code": "sample string 6", "sales_organization_id": "93548d7e-0d7d-45f4-95cc-53fe67b23e44", "sales_organization_code": "sample string 8", "sales_organization": { "id": "40c55f19-3766-49e4-9247-965cbcf5b51f", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "ff3f1db9-02d9-4184-b6ee-5d17aafc8050", "db_currency_id": "a144469e-5da1-44a1-8634-0fa83b38edc5", "db_language_id": "8d35fdd2-c6aa-4405-bf7c-5d1a21fb0203", "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-11-18T14:25:46.5314296+00:00" }, "modified_dateutc": "2024-11-18T14:25:46.5314296+00:00" }, "equipment_model_id": "d20fb4d2-5b0b-4a78-9b00-9e3493b2397a", "equipment_model_code": "sample string 8", "equipment_model": { "id": "dbc9fa92-a556-469d-aa1b-9a61352b0464", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "a4cdaf19-0669-4a4f-b4d1-dfd5ec76c307", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "8eef52b2-dd49-45cc-9ce5-d225dad756fd", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "dc4ed095-918e-4faa-a2b8-e11dbc3af1b8", "sales_organization_code": "sample string 5", "sales_organization": { "id": "40c55f19-3766-49e4-9247-965cbcf5b51f", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "ff3f1db9-02d9-4184-b6ee-5d17aafc8050", "db_currency_id": "a144469e-5da1-44a1-8634-0fa83b38edc5", "db_language_id": "8d35fdd2-c6aa-4405-bf7c-5d1a21fb0203", "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-11-18T14:25:46.5314296+00:00" }, "modified_dateutc": "2024-11-18T14:25:46.5314296+00:00" }, "equipment_family_id": "6f79f2dc-c98b-441f-aba4-68b42e9afde3", "equipment_family_code": "sample string 8", "equipment_family": { "id": "13146fad-10b6-46f0-b8c5-0e5a413fe035", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "57aa91f5-c72a-449f-9d89-2a5285607027", "_parent_code": "sample string 6", "sales_organization_id": "93548d7e-0d7d-45f4-95cc-53fe67b23e44", "sales_organization_code": "sample string 8", "sales_organization": { "id": "40c55f19-3766-49e4-9247-965cbcf5b51f", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "ff3f1db9-02d9-4184-b6ee-5d17aafc8050", "db_currency_id": "a144469e-5da1-44a1-8634-0fa83b38edc5", "db_language_id": "8d35fdd2-c6aa-4405-bf7c-5d1a21fb0203", "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-11-18T14:25:46.5314296+00:00" }, "modified_dateutc": "2024-11-18T14:25:46.5314296+00:00" }, "date_in_production_since": "2024-11-18T14:25:46.5314296+00:00", "date_out_of_production_since": "2024-11-18T14:25:46.5314296+00:00", "date_end_support": "2024-11-18T14:25:46.5314296+00:00", "sales_organization_id": "b054be6d-409c-4d23-98c0-b5c438047958", "sales_organization_code": "sample string 13", "sales_organization": { "id": "40c55f19-3766-49e4-9247-965cbcf5b51f", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "ff3f1db9-02d9-4184-b6ee-5d17aafc8050", "db_currency_id": "a144469e-5da1-44a1-8634-0fa83b38edc5", "db_language_id": "8d35fdd2-c6aa-4405-bf7c-5d1a21fb0203", "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-11-18T14:25:46.5314296+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-11-18T14:25:46.547068+00:00" }, "project_status_id": "cd0a2df5-5ce1-4a83-b411-a4c61207bfe1", "project_status_code": "sample string 10", "project_status": { "id": "001792f3-009f-4848-bd1a-d793c41c10a5", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "6e1a37d0-4c6e-438f-8ed4-18bf719d1ec6", "sales_organization_code": "sample string 6", "sales_organization": { "id": "40c55f19-3766-49e4-9247-965cbcf5b51f", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "ff3f1db9-02d9-4184-b6ee-5d17aafc8050", "db_currency_id": "a144469e-5da1-44a1-8634-0fa83b38edc5", "db_language_id": "8d35fdd2-c6aa-4405-bf7c-5d1a21fb0203", "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-11-18T14:25:46.5314296+00:00" }, "code": "sample string 7", "modified_dateutc": "2024-11-18T14:25:46.547068+00:00" }, "company_id": "3950b1a1-77f7-4a03-85c9-256dbb4bd035", "company_code": "sample string 12", "db_address_id": "3a8720a9-00ed-4f8a-91af-bf1e77cc33f8", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "c67d9ccd-3e69-4346-8951-bf80157a3abf", "contact_reference_back_office": "sample string 17", "owner_user_id": "59024bf2-0714-4231-b0e7-e0f092589451", "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-11-18T14:25:46.547068+00:00", "date_create": "2024-11-18T14:25:46.547068+00:00", "date_update": "2024-11-18T14:25:46.547068+00:00", "updated_by_user_id": "d8c9fb14-a49a-493d-b8ff-0e75b6f8828a", "customer_reference": "sample string 28", "warranty_date_until": "2024-11-18T14:25:46.547068+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-11-18T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2024-11-18T14:25:46.547068+00:00", "date_last_job": "2024-11-18T14:25:46.547068+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2024-11-18T14:25:46.547068+00:00", "modified_dateutc": "2024-11-18T14:25:46.547068+00:00", "is_mobile_installation": true }, "job_type_id": "06093e87-1548-4992-821f-01ae19dc7380", "job_type_code": "sample string 7", "job_type": { "id": "52459629-7c46-4807-a5ab-f302a67a4044", "name": "sample string 2", "sales_organization_id": "c630b5c2-d12c-48c5-9ec6-8dfef3fa4ef9", "description": "sample string 4", "is_default": true, "modified_dateutc": "2024-11-18T14:25:46.547068+00:00", "code": "sample string 7" }, "job_priority_id": "3cfcd277-b427-4cf0-8de5-397d27202143", "job_priority_code": "sample string 9", "job_priority": { "id": "43bd9273-7637-45e3-9143-2364bf64e559", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "b04e2ec7-16e4-4b9c-b2f0-666a1b34bc33", "sales_organization_code": "sample string 6", "sales_organization": { "id": "40c55f19-3766-49e4-9247-965cbcf5b51f", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "ff3f1db9-02d9-4184-b6ee-5d17aafc8050", "db_currency_id": "a144469e-5da1-44a1-8634-0fa83b38edc5", "db_language_id": "8d35fdd2-c6aa-4405-bf7c-5d1a21fb0203", "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-11-18T14:25:46.5314296+00:00" }, "code": "sample string 7", "modified_dateutc": "2024-11-18T14:25:46.547068+00:00" }, "job_status_id": "db97a77d-7ba5-4a18-b513-3cf25f913d01", "job_status_code": "sample string 11", "db_address_id": "2bf0dc93-3c3c-416e-afc2-9fea32e3deec", "contact_id": "a9e2c65b-4678-427c-8f70-068c99429fce", "requested_by_company_id": "b2538803-8bd7-4cf4-9b26-a3f280854d62", "requested_by_contact_id": "c9fbe2e0-736e-43f8-8a34-476e9368c07f", "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-11-18T14:25:46.547068+00:00", "due_date": "2024-11-18T14:25:46.547068+00:00", "date_create": "2024-11-18T14:25:46.547068+00:00", "date_update": "2024-11-18T14:25:46.547068+00:00", "date_closed": "2024-11-18T14:25:46.547068+00:00", "suggested_user_id": "8c826f71-dba0-4f65-b527-555807470ca9", "suggested_user_code": "sample string 29", "suggested_user": { "id": "5118508e-a3b1-45bf-9171-fdc6393f4a26", "db_language_id": "50a6fed4-fa23-4a59-9dc1-9e86ccbb05c2", "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-11-18T14:25:46.547068+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "45144be4-9bf4-425d-a514-f637084b2d04", "sales_organization": { "id": "40c55f19-3766-49e4-9247-965cbcf5b51f", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "ff3f1db9-02d9-4184-b6ee-5d17aafc8050", "db_currency_id": "a144469e-5da1-44a1-8634-0fa83b38edc5", "db_language_id": "8d35fdd2-c6aa-4405-bf7c-5d1a21fb0203", "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-11-18T14:25:46.5314296+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "c0959e1c-819e-43cc-8d3a-eb459801638e", "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": "bc31ecf7-1f82-4a7f-a341-37d740526f37", "private_db_country_code": "sample string 35", "modified_dateutc": "2024-11-18T14:25:46.547068+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "75549336-bfaf-4e5f-8663-81514d276315" }, "suggested_date_start": "2024-11-18T14:25:46.547068+00:00", "skill_id": "fc64f0cb-6065-4b8e-8375-29972a6a7d2b", "skill_code": "sample string 32", "skill": { "id": "ff98e27a-188f-470a-b4c7-4d14d44ad072", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "a944d406-f867-4140-a2ea-62a3640f581f", "sales_organization_code": "sample string 6", "sales_organization": { "id": "40c55f19-3766-49e4-9247-965cbcf5b51f", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "ff3f1db9-02d9-4184-b6ee-5d17aafc8050", "db_currency_id": "a144469e-5da1-44a1-8634-0fa83b38edc5", "db_language_id": "8d35fdd2-c6aa-4405-bf7c-5d1a21fb0203", "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-11-18T14:25:46.5314296+00:00" }, "modified_dateutc": "2024-11-18T14:25:46.547068+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "05dffdb0-e5d0-4b53-b608-a6055bc88abd", "date_reported_by_company": "2024-11-18T14:25:46.547068+00:00", "id2": 36, "company_id": "c8253e4b-5e18-4776-8ddd-0f14c7ad41b7", "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": "dbb83af1-c8f6-4d2d-985f-0f89922844aa", "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-11-18T14:25:46.547068+00:00" }
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.