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": "dd7bdf26-7e7c-48b0-b431-3a7afdb5914a", "_parent_id": "3a38daff-7505-4d27-bbe2-a11d1c381992", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "e7d2b096-2c1d-4ec1-8376-4cb2f146d10b", "project_reference_back_office": "sample string 5", "project": { "id": "591b690a-2dcb-4ade-a7ca-090b18f6f575", "_parent_id": "4659fe40-3056-4961-8767-f5f33ed07902", "root_parent_id": "23395d9a-5144-4af0-9c68-5cc4eb8be0f7", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "b2008bd9-3e52-41bf-b1de-66ef9dc3cc52", "equipment_family_code": "sample string 6", "equipment_family": { "id": "d3885b3e-f993-45c3-8010-2985f73b010f", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "dcec7d11-7d72-42d8-a294-ffbdf42139ff", "_parent_code": "sample string 6", "sales_organization_id": "3e407705-311c-4ac1-80e7-0d3cafdf22d0", "sales_organization_code": "sample string 8", "sales_organization": { "id": "7aae8728-55b7-4943-99e6-ea373af0c2f5", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "11d72bc1-07be-4e6b-8045-f4186a909b9e", "db_currency_id": "0b36e80b-c265-4be5-9ba2-f298c06103b8", "db_language_id": "3e8f3097-edc9-4521-b1b2-bde398a8e666", "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-04-22T01:49:47.9985554+00:00" }, "modified_dateutc": "2024-04-22T01:49:47.9985554+00:00" }, "equipment_model_id": "3e3d7c96-54c5-47c3-a0d1-d988dea93021", "equipment_model_code": "sample string 8", "equipment_model": { "id": "54c8ff1f-8ff1-4872-a150-f3c864f870ca", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "0f6c562d-355c-48bc-85c0-d43c92eae36f", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "a4bc83d5-f883-4c76-b713-4a10b70509c7", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "afbec8c6-33fa-43fb-b7fd-42241d7b224c", "sales_organization_code": "sample string 5", "sales_organization": { "id": "7aae8728-55b7-4943-99e6-ea373af0c2f5", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "11d72bc1-07be-4e6b-8045-f4186a909b9e", "db_currency_id": "0b36e80b-c265-4be5-9ba2-f298c06103b8", "db_language_id": "3e8f3097-edc9-4521-b1b2-bde398a8e666", "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-04-22T01:49:47.9985554+00:00" }, "modified_dateutc": "2024-04-22T01:49:47.9985554+00:00" }, "equipment_family_id": "f6c80e3a-1521-4afc-a031-0dd0e6dfffcd", "equipment_family_code": "sample string 8", "equipment_family": { "id": "d3885b3e-f993-45c3-8010-2985f73b010f", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "dcec7d11-7d72-42d8-a294-ffbdf42139ff", "_parent_code": "sample string 6", "sales_organization_id": "3e407705-311c-4ac1-80e7-0d3cafdf22d0", "sales_organization_code": "sample string 8", "sales_organization": { "id": "7aae8728-55b7-4943-99e6-ea373af0c2f5", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "11d72bc1-07be-4e6b-8045-f4186a909b9e", "db_currency_id": "0b36e80b-c265-4be5-9ba2-f298c06103b8", "db_language_id": "3e8f3097-edc9-4521-b1b2-bde398a8e666", "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-04-22T01:49:47.9985554+00:00" }, "modified_dateutc": "2024-04-22T01:49:47.9985554+00:00" }, "date_in_production_since": "2024-04-22T01:49:47.9985554+00:00", "date_out_of_production_since": "2024-04-22T01:49:47.9985554+00:00", "date_end_support": "2024-04-22T01:49:47.9985554+00:00", "sales_organization_id": "3a648d9f-ddc9-4e3d-9a89-83335dc74dc9", "sales_organization_code": "sample string 13", "sales_organization": { "id": "7aae8728-55b7-4943-99e6-ea373af0c2f5", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "11d72bc1-07be-4e6b-8045-f4186a909b9e", "db_currency_id": "0b36e80b-c265-4be5-9ba2-f298c06103b8", "db_language_id": "3e8f3097-edc9-4521-b1b2-bde398a8e666", "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-04-22T01:49:47.9985554+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-04-22T01:49:47.9985554+00:00" }, "project_status_id": "76f08103-1fe4-4b40-9f2b-bfd413faaa8b", "project_status_code": "sample string 10", "project_status": { "id": "c808957e-ac5b-4c45-9d98-737c8510081c", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "531a9f75-a57c-47b1-a5df-05f511947c6c", "sales_organization_code": "sample string 6", "sales_organization": { "id": "7aae8728-55b7-4943-99e6-ea373af0c2f5", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "11d72bc1-07be-4e6b-8045-f4186a909b9e", "db_currency_id": "0b36e80b-c265-4be5-9ba2-f298c06103b8", "db_language_id": "3e8f3097-edc9-4521-b1b2-bde398a8e666", "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-04-22T01:49:47.9985554+00:00" }, "code": "sample string 7", "modified_dateutc": "2024-04-22T01:49:47.9985554+00:00" }, "company_id": "c2472bb2-ac2a-4c1f-b7a5-9e69f96f7bb2", "company_code": "sample string 12", "db_address_id": "5cd1d05b-b378-4622-9a57-9a084df06bd2", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "bbf10c1a-7cb6-4bc8-95ac-d67dfa56a87a", "contact_reference_back_office": "sample string 17", "owner_user_id": "32c3e02d-588c-4bad-9cf6-e5261aa67b97", "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-04-22T01:49:47.9985554+00:00", "date_create": "2024-04-22T01:49:47.9985554+00:00", "date_update": "2024-04-22T01:49:47.9985554+00:00", "updated_by_user_id": "ef1c67b7-1b0b-4155-b06d-53c525fa9158", "customer_reference": "sample string 28", "warranty_date_until": "2024-04-22T01:49:47.9985554+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-04-22T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2024-04-22T01:49:47.9985554+00:00", "date_last_job": "2024-04-22T01:49:47.9985554+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2024-04-22T01:49:47.9985554+00:00", "modified_dateutc": "2024-04-22T01:49:47.9985554+00:00", "is_mobile_installation": true }, "job_type_id": "7fd99fa0-53ba-4ef5-bddb-17afa798810d", "job_type_code": "sample string 7", "job_type": { "id": "1df60018-a522-4af9-b01c-59c1652b2a9e", "name": "sample string 2", "sales_organization_id": "061ad0cd-7d39-4332-b90b-c78fe24ce7df", "description": "sample string 4", "is_default": true, "modified_dateutc": "2024-04-22T01:49:47.9985554+00:00", "code": "sample string 7" }, "job_priority_id": "ce223e91-fe62-43d2-9a91-3a72364770b0", "job_priority_code": "sample string 9", "job_priority": { "id": "a424af81-99d4-49a4-b4c1-0a75e138f351", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "34119285-ab47-45ce-a873-5a09c4a8ca36", "sales_organization_code": "sample string 6", "sales_organization": { "id": "7aae8728-55b7-4943-99e6-ea373af0c2f5", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "11d72bc1-07be-4e6b-8045-f4186a909b9e", "db_currency_id": "0b36e80b-c265-4be5-9ba2-f298c06103b8", "db_language_id": "3e8f3097-edc9-4521-b1b2-bde398a8e666", "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-04-22T01:49:47.9985554+00:00" }, "code": "sample string 7", "modified_dateutc": "2024-04-22T01:49:47.9985554+00:00" }, "job_status_id": "5e097b70-0efc-4c45-affc-f31a9071c772", "job_status_code": "sample string 11", "db_address_id": "b8ca8a56-bf69-4f32-9e15-19026a928f33", "contact_id": "d3bf3985-e6b3-4721-b918-4f8c9c991b26", "requested_by_company_id": "085acd90-ecd1-4e09-ae5d-67d5b820fa35", "requested_by_contact_id": "2e1e2e43-4047-4d34-9d14-d53cffbe02b6", "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-04-22T01:49:47.9985554+00:00", "due_date": "2024-04-22T01:49:47.9985554+00:00", "date_create": "2024-04-22T01:49:47.9985554+00:00", "date_update": "2024-04-22T01:49:47.9985554+00:00", "date_closed": "2024-04-22T01:49:47.9985554+00:00", "suggested_user_id": "10da7a40-29e9-4a99-8acc-7b14d40c723f", "suggested_user_code": "sample string 29", "suggested_user": { "id": "b4db420f-1b4b-4958-94c6-c977d2706fec", "db_language_id": "7ee327e3-d0f6-4171-99c6-a752ad6c044b", "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-04-22T01:49:47.9985554+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "c1f250d7-0f0a-494e-aedd-126ab2672ca2", "sales_organization": { "id": "7aae8728-55b7-4943-99e6-ea373af0c2f5", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "11d72bc1-07be-4e6b-8045-f4186a909b9e", "db_currency_id": "0b36e80b-c265-4be5-9ba2-f298c06103b8", "db_language_id": "3e8f3097-edc9-4521-b1b2-bde398a8e666", "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-04-22T01:49:47.9985554+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "42890af2-2f52-4b71-bc53-288cbe9390ef", "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": "284be916-b9ef-4802-9f62-d7ce9b15d1d3", "private_db_country_code": "sample string 35", "modified_dateutc": "2024-04-22T01:49:47.9985554+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "64172799-a446-41c3-b140-d88d8cda8817" }, "suggested_date_start": "2024-04-22T01:49:47.9985554+00:00", "skill_id": "5ce61d9d-d145-4905-ba09-a7d82bcb8529", "skill_code": "sample string 32", "skill": { "id": "f18210fc-7935-465e-9640-6d25d559b4de", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "8242dc78-e28f-4b68-820e-d0b28d08d44f", "sales_organization_code": "sample string 6", "sales_organization": { "id": "7aae8728-55b7-4943-99e6-ea373af0c2f5", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "11d72bc1-07be-4e6b-8045-f4186a909b9e", "db_currency_id": "0b36e80b-c265-4be5-9ba2-f298c06103b8", "db_language_id": "3e8f3097-edc9-4521-b1b2-bde398a8e666", "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-04-22T01:49:47.9985554+00:00" }, "modified_dateutc": "2024-04-22T01:49:47.9985554+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "2fe34b28-3658-4a67-9e90-933590aca98e", "date_reported_by_company": "2024-04-22T01:49:47.9985554+00:00", "id2": 36, "company_id": "c29a5f11-d178-421d-b0fe-02b50b25aa8f", "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": "e8c7eadc-d341-49a2-a28a-5b8760d2fc51", "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-04-22T01:49:47.9985554+00:00" }
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.