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": "81ddefcc-f87f-4566-912a-ee19d6f2d446", "_parent_id": "084bd765-86bb-41ad-8c79-b16d8e9f9a5e", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "a08d70ee-7cc7-4392-9eee-68d6339668ee", "project_reference_back_office": "sample string 5", "project": { "id": "748ff0d6-d82a-450a-8f3b-560a25820546", "_parent_id": "7fd522c2-0942-4fb5-b085-9db9c30de8d9", "root_parent_id": "93cdaefe-6eec-471d-bd4e-24c94c8ca746", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "d046efd2-b9ad-4d72-b7e8-b4bf9e8ca2e8", "equipment_family_code": "sample string 6", "equipment_family": { "id": "5ba3d68b-321e-48d9-821e-8203341df185", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "d920d4ac-eda6-4af0-8c8c-16ed83748a84", "_parent_code": "sample string 6", "sales_organization_id": "ce96fc09-d51d-442f-ab07-db452c77d9f8", "sales_organization_code": "sample string 8", "sales_organization": { "id": "f5549301-cd58-4f15-8b5c-7aa80729c047", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "125bd7da-af20-468f-b628-b4b1aff02b62", "db_currency_id": "a0b6e884-ac79-4c71-97e7-093c638d8698", "db_language_id": "92cefa65-5b98-4a32-8bef-bf351520092e", "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-20T11:14:00.6139208+00:00" }, "modified_dateutc": "2024-11-20T11:14:00.6139208+00:00" }, "equipment_model_id": "7c866c35-691d-418d-9f8a-6d229ef18a51", "equipment_model_code": "sample string 8", "equipment_model": { "id": "95a641e6-172e-4b85-a949-547839fa4b9f", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "21216429-7d44-4343-a3cb-ec1af504d08e", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "39b1c402-cb55-4970-ae8a-ce54a7eefd2d", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "7241b0c4-e950-48aa-9fea-cb87145446ad", "sales_organization_code": "sample string 5", "sales_organization": { "id": "f5549301-cd58-4f15-8b5c-7aa80729c047", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "125bd7da-af20-468f-b628-b4b1aff02b62", "db_currency_id": "a0b6e884-ac79-4c71-97e7-093c638d8698", "db_language_id": "92cefa65-5b98-4a32-8bef-bf351520092e", "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-20T11:14:00.6139208+00:00" }, "modified_dateutc": "2024-11-20T11:14:00.6139208+00:00" }, "equipment_family_id": "22c8b8c7-9f96-4ab6-8e78-51c178da8782", "equipment_family_code": "sample string 8", "equipment_family": { "id": "5ba3d68b-321e-48d9-821e-8203341df185", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "d920d4ac-eda6-4af0-8c8c-16ed83748a84", "_parent_code": "sample string 6", "sales_organization_id": "ce96fc09-d51d-442f-ab07-db452c77d9f8", "sales_organization_code": "sample string 8", "sales_organization": { "id": "f5549301-cd58-4f15-8b5c-7aa80729c047", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "125bd7da-af20-468f-b628-b4b1aff02b62", "db_currency_id": "a0b6e884-ac79-4c71-97e7-093c638d8698", "db_language_id": "92cefa65-5b98-4a32-8bef-bf351520092e", "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-20T11:14:00.6139208+00:00" }, "modified_dateutc": "2024-11-20T11:14:00.6139208+00:00" }, "date_in_production_since": "2024-11-20T11:14:00.6139208+00:00", "date_out_of_production_since": "2024-11-20T11:14:00.6139208+00:00", "date_end_support": "2024-11-20T11:14:00.6139208+00:00", "sales_organization_id": "0040a86b-8a17-404e-ae00-ef0c06c0c807", "sales_organization_code": "sample string 13", "sales_organization": { "id": "f5549301-cd58-4f15-8b5c-7aa80729c047", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "125bd7da-af20-468f-b628-b4b1aff02b62", "db_currency_id": "a0b6e884-ac79-4c71-97e7-093c638d8698", "db_language_id": "92cefa65-5b98-4a32-8bef-bf351520092e", "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-20T11:14:00.6139208+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-20T11:14:00.6139208+00:00" }, "project_status_id": "ae19ea3b-706e-4ab2-8029-b5372266db72", "project_status_code": "sample string 10", "project_status": { "id": "5a3a7de9-572c-4313-8e14-003e141f5f1c", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "d7d82d4d-144e-463f-9b58-9b82ebff2e7a", "sales_organization_code": "sample string 6", "sales_organization": { "id": "f5549301-cd58-4f15-8b5c-7aa80729c047", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "125bd7da-af20-468f-b628-b4b1aff02b62", "db_currency_id": "a0b6e884-ac79-4c71-97e7-093c638d8698", "db_language_id": "92cefa65-5b98-4a32-8bef-bf351520092e", "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-20T11:14:00.6139208+00:00" }, "code": "sample string 7", "modified_dateutc": "2024-11-20T11:14:00.6139208+00:00" }, "company_id": "15516452-0afe-4598-9829-45779976b50c", "company_code": "sample string 12", "db_address_id": "eb43bac7-82af-4cbd-b63f-ba8040c161af", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "e06b8cda-4c09-4c8e-834a-a43779c306d7", "contact_reference_back_office": "sample string 17", "owner_user_id": "6b119f37-cf88-4679-81f6-898f05acde11", "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-20T11:14:00.6139208+00:00", "date_create": "2024-11-20T11:14:00.6139208+00:00", "date_update": "2024-11-20T11:14:00.6139208+00:00", "updated_by_user_id": "67aa405a-7c7c-43e0-a7d7-0a7147f54570", "customer_reference": "sample string 28", "warranty_date_until": "2024-11-20T11:14:00.6139208+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-20T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2024-11-20T11:14:00.6139208+00:00", "date_last_job": "2024-11-20T11:14:00.6139208+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2024-11-20T11:14:00.6139208+00:00", "modified_dateutc": "2024-11-20T11:14:00.6139208+00:00", "is_mobile_installation": true }, "job_type_id": "01cba084-c4d1-4b7e-8211-5ff0223cc5dd", "job_type_code": "sample string 7", "job_type": { "id": "6510864e-95c5-4520-917e-e16c4419c5cb", "name": "sample string 2", "sales_organization_id": "5acf4efd-0a9e-4c70-8da5-d0fcea3b0fbc", "description": "sample string 4", "is_default": true, "modified_dateutc": "2024-11-20T11:14:00.6139208+00:00", "code": "sample string 7" }, "job_priority_id": "13aad7ac-bc4e-42bc-a76b-39b82d44f722", "job_priority_code": "sample string 9", "job_priority": { "id": "746c0775-bb8d-4b6b-a2d2-da709661a498", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "645b0078-f914-4bb3-84ca-fc6a405e182a", "sales_organization_code": "sample string 6", "sales_organization": { "id": "f5549301-cd58-4f15-8b5c-7aa80729c047", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "125bd7da-af20-468f-b628-b4b1aff02b62", "db_currency_id": "a0b6e884-ac79-4c71-97e7-093c638d8698", "db_language_id": "92cefa65-5b98-4a32-8bef-bf351520092e", "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-20T11:14:00.6139208+00:00" }, "code": "sample string 7", "modified_dateutc": "2024-11-20T11:14:00.6139208+00:00" }, "job_status_id": "c3248e80-b962-4022-a213-10dd77323fcc", "job_status_code": "sample string 11", "db_address_id": "fb69f966-e77a-4c7e-be97-ccefe70c8696", "contact_id": "76e8dfeb-8ce7-4343-8ac7-9650414ae940", "requested_by_company_id": "f2782258-8a53-40ce-a62d-0b7e909b5598", "requested_by_contact_id": "1b68ec24-d159-4b8f-8570-c258ab47c5f9", "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-20T11:14:00.6139208+00:00", "due_date": "2024-11-20T11:14:00.6139208+00:00", "date_create": "2024-11-20T11:14:00.6139208+00:00", "date_update": "2024-11-20T11:14:00.6139208+00:00", "date_closed": "2024-11-20T11:14:00.6139208+00:00", "suggested_user_id": "69c02908-633c-4e2c-a3b2-3fd093bb237a", "suggested_user_code": "sample string 29", "suggested_user": { "id": "42172b4f-8fc5-461c-9b0b-e3e433bb4e81", "db_language_id": "21389c24-dfa2-42cf-afc3-fd515a9366ef", "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-20T11:14:00.6139208+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "2ecabb6a-7a3e-4e1b-8084-fbbbeca10a15", "sales_organization": { "id": "f5549301-cd58-4f15-8b5c-7aa80729c047", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "125bd7da-af20-468f-b628-b4b1aff02b62", "db_currency_id": "a0b6e884-ac79-4c71-97e7-093c638d8698", "db_language_id": "92cefa65-5b98-4a32-8bef-bf351520092e", "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-20T11:14:00.6139208+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "bd0e87bb-a9ea-4f5c-9867-59cd28cb0ce1", "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": "99271646-90d2-48ce-951f-2d3342179a66", "private_db_country_code": "sample string 35", "modified_dateutc": "2024-11-20T11:14:00.6139208+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "cd77dd21-8573-437a-8dcc-35642de46124" }, "suggested_date_start": "2024-11-20T11:14:00.6139208+00:00", "skill_id": "0eedda55-2a27-48c2-a44e-04bbbbcf1324", "skill_code": "sample string 32", "skill": { "id": "f62b448c-e277-4169-a4d5-9e09fd3dccac", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "3be59107-8761-4ef0-a20d-5daddc96b49d", "sales_organization_code": "sample string 6", "sales_organization": { "id": "f5549301-cd58-4f15-8b5c-7aa80729c047", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "125bd7da-af20-468f-b628-b4b1aff02b62", "db_currency_id": "a0b6e884-ac79-4c71-97e7-093c638d8698", "db_language_id": "92cefa65-5b98-4a32-8bef-bf351520092e", "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-20T11:14:00.6139208+00:00" }, "modified_dateutc": "2024-11-20T11:14:00.6139208+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "ae997591-78c0-4a24-8377-39d801d74e79", "date_reported_by_company": "2024-11-20T11:14:00.6139208+00:00", "id2": 36, "company_id": "f8d05de9-9217-46e1-a518-da0f004e475b", "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": "ac758532-d8b9-4b27-af34-084b65e665c8", "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-20T11:14:00.6139208+00:00" }
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.