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": "ddde4d5a-a7f9-499c-8724-1b8b4b40b73a", "_parent_id": "e015eb6c-7221-4ab3-b687-cd4ed2177697", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "c0135f0f-5d79-4706-b50b-4c7fae250f3a", "project_reference_back_office": "sample string 5", "project": { "id": "4e6ec488-7abd-429b-ae60-69af7e583f67", "_parent_id": "caa0801c-38e4-4db5-8e0d-d8c4cdf38060", "root_parent_id": "360f7394-b424-4bc8-99d7-74a1792caf31", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "f7c7a583-e842-4fe4-b11b-3ef450c3b2ce", "equipment_family_code": "sample string 6", "equipment_family": { "id": "9acbb768-2c1f-4550-9b4f-d4f0ff5ce1b7", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "1c1ae9ca-cfff-4721-b71b-70271617340b", "_parent_code": "sample string 6", "sales_organization_id": "1648e9cd-05b2-4777-8f01-2766996ef28f", "sales_organization_code": "sample string 8", "sales_organization": { "id": "28c25dc2-b2de-47da-8810-f087656aeb04", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "a8b3bf10-9712-464f-8ee2-30f2aa562301", "db_currency_id": "9773d0d9-19de-4bca-8f87-d31e0467fa80", "db_language_id": "9c61778b-cafd-4e4b-a3b2-3e5c3776ff57", "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-12-21T17:11:21.0684015+00:00" }, "modified_dateutc": "2024-12-21T17:11:21.0684015+00:00" }, "equipment_model_id": "ac399d17-0c10-47a7-955d-006deb30358f", "equipment_model_code": "sample string 8", "equipment_model": { "id": "49cc2c03-4dfe-41a7-be00-67dea115c15a", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "79c79f3e-db50-47fa-86bd-908251fa03be", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "beaa5717-bdbe-4e90-bf22-28aec65e4996", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "7bb7ddd2-d6a6-45bd-9d8a-5ce7293800d6", "sales_organization_code": "sample string 5", "sales_organization": { "id": "28c25dc2-b2de-47da-8810-f087656aeb04", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "a8b3bf10-9712-464f-8ee2-30f2aa562301", "db_currency_id": "9773d0d9-19de-4bca-8f87-d31e0467fa80", "db_language_id": "9c61778b-cafd-4e4b-a3b2-3e5c3776ff57", "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-12-21T17:11:21.0684015+00:00" }, "modified_dateutc": "2024-12-21T17:11:21.0684015+00:00" }, "equipment_family_id": "f6d49eb8-d753-455b-9f0f-5362c05b82fb", "equipment_family_code": "sample string 8", "equipment_family": { "id": "9acbb768-2c1f-4550-9b4f-d4f0ff5ce1b7", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "1c1ae9ca-cfff-4721-b71b-70271617340b", "_parent_code": "sample string 6", "sales_organization_id": "1648e9cd-05b2-4777-8f01-2766996ef28f", "sales_organization_code": "sample string 8", "sales_organization": { "id": "28c25dc2-b2de-47da-8810-f087656aeb04", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "a8b3bf10-9712-464f-8ee2-30f2aa562301", "db_currency_id": "9773d0d9-19de-4bca-8f87-d31e0467fa80", "db_language_id": "9c61778b-cafd-4e4b-a3b2-3e5c3776ff57", "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-12-21T17:11:21.0684015+00:00" }, "modified_dateutc": "2024-12-21T17:11:21.0684015+00:00" }, "date_in_production_since": "2024-12-21T17:11:21.0684015+00:00", "date_out_of_production_since": "2024-12-21T17:11:21.0684015+00:00", "date_end_support": "2024-12-21T17:11:21.0684015+00:00", "sales_organization_id": "78ea29dc-8deb-4074-9223-f955df61be78", "sales_organization_code": "sample string 13", "sales_organization": { "id": "28c25dc2-b2de-47da-8810-f087656aeb04", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "a8b3bf10-9712-464f-8ee2-30f2aa562301", "db_currency_id": "9773d0d9-19de-4bca-8f87-d31e0467fa80", "db_language_id": "9c61778b-cafd-4e4b-a3b2-3e5c3776ff57", "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-12-21T17:11:21.0684015+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-12-21T17:11:21.0684015+00:00" }, "project_status_id": "bb2a08cd-cb7f-4c29-8d0b-0060bc9ba3a7", "project_status_code": "sample string 10", "project_status": { "id": "0a92e635-a405-4c7a-a7ff-98acfac87c79", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "6e9ffb34-ef7c-4da1-8f4a-e2c226a9633a", "sales_organization_code": "sample string 6", "sales_organization": { "id": "28c25dc2-b2de-47da-8810-f087656aeb04", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "a8b3bf10-9712-464f-8ee2-30f2aa562301", "db_currency_id": "9773d0d9-19de-4bca-8f87-d31e0467fa80", "db_language_id": "9c61778b-cafd-4e4b-a3b2-3e5c3776ff57", "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-12-21T17:11:21.0684015+00:00" }, "code": "sample string 7", "modified_dateutc": "2024-12-21T17:11:21.0684015+00:00" }, "company_id": "e336ad85-06eb-4f93-8ac8-c0b7331b7974", "company_code": "sample string 12", "db_address_id": "6a7e3242-c3c2-4a77-9b69-3aa4ccc3ff73", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "a685c172-6e14-47aa-9240-46719874ba20", "contact_reference_back_office": "sample string 17", "owner_user_id": "5797870c-1faf-4f06-8341-acb5cf7dce53", "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-12-21T17:11:21.0684015+00:00", "date_create": "2024-12-21T17:11:21.0684015+00:00", "date_update": "2024-12-21T17:11:21.0684015+00:00", "updated_by_user_id": "2c444083-df13-4009-a75f-4b64dc8b31b2", "customer_reference": "sample string 28", "warranty_date_until": "2024-12-21T17:11:21.0684015+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-12-21T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2024-12-21T17:11:21.0684015+00:00", "date_last_job": "2024-12-21T17:11:21.0684015+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2024-12-21T17:11:21.0684015+00:00", "modified_dateutc": "2024-12-21T17:11:21.0684015+00:00", "is_mobile_installation": true }, "job_type_id": "9cef0a1a-b08b-4f10-832b-ac8d2dac2549", "job_type_code": "sample string 7", "job_type": { "id": "daa60350-b1ee-41fe-9416-fabc8d3af035", "name": "sample string 2", "sales_organization_id": "937b17d3-dd9d-42d8-8821-068baeb4bb63", "description": "sample string 4", "is_default": true, "modified_dateutc": "2024-12-21T17:11:21.0684015+00:00", "code": "sample string 7" }, "job_priority_id": "41b75327-01b6-4b22-be16-3c0c28476485", "job_priority_code": "sample string 9", "job_priority": { "id": "30527612-5d06-4f5e-806e-4e607e338f98", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "01e30a8c-c5bc-4a91-9524-c2b41f07e5d0", "sales_organization_code": "sample string 6", "sales_organization": { "id": "28c25dc2-b2de-47da-8810-f087656aeb04", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "a8b3bf10-9712-464f-8ee2-30f2aa562301", "db_currency_id": "9773d0d9-19de-4bca-8f87-d31e0467fa80", "db_language_id": "9c61778b-cafd-4e4b-a3b2-3e5c3776ff57", "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-12-21T17:11:21.0684015+00:00" }, "code": "sample string 7", "modified_dateutc": "2024-12-21T17:11:21.0684015+00:00" }, "job_status_id": "a69eca5e-c318-42d4-94d0-7ded1e5e99de", "job_status_code": "sample string 11", "db_address_id": "44846e65-5732-4a9c-83d0-8e3345c7acca", "contact_id": "394901fa-31df-46de-870f-c0cc2b8292ee", "requested_by_company_id": "6bf47205-034e-48d5-ac29-2f8e538b0cea", "requested_by_contact_id": "ce3a9f84-97c2-48d5-ac84-514065523d0e", "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-12-21T17:11:21.0684015+00:00", "due_date": "2024-12-21T17:11:21.0684015+00:00", "date_create": "2024-12-21T17:11:21.0684015+00:00", "date_update": "2024-12-21T17:11:21.0684015+00:00", "date_closed": "2024-12-21T17:11:21.0684015+00:00", "suggested_user_id": "24a6fa75-f735-4b01-8afc-3c7ff23a2528", "suggested_user_code": "sample string 29", "suggested_user": { "id": "edd3975e-db8c-408f-b7c2-c08e2cbd0ba8", "db_language_id": "4b026d3f-c271-4719-ac33-b62c623d72f6", "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-12-21T17:11:21.0684015+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "0dd78c5f-6af4-45dc-b190-25a2ec775b97", "sales_organization": { "id": "28c25dc2-b2de-47da-8810-f087656aeb04", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "a8b3bf10-9712-464f-8ee2-30f2aa562301", "db_currency_id": "9773d0d9-19de-4bca-8f87-d31e0467fa80", "db_language_id": "9c61778b-cafd-4e4b-a3b2-3e5c3776ff57", "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-12-21T17:11:21.0684015+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "c2fd404f-d19c-4dbd-a9f1-47233ac9b5d0", "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": "2c1a8613-b76e-4bf7-bbd5-e20278ce45b2", "private_db_country_code": "sample string 35", "modified_dateutc": "2024-12-21T17:11:21.0684015+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "3a3f5e8e-9178-4490-8543-38f2caa54e40" }, "suggested_date_start": "2024-12-21T17:11:21.0684015+00:00", "skill_id": "fe487fcf-2ea0-4f91-98ee-9efb4dc2e862", "skill_code": "sample string 32", "skill": { "id": "f8ef22d3-3ec6-4371-be44-2b974603ce03", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "d6a9128a-5dea-4acb-9cfc-c58846ef1e93", "sales_organization_code": "sample string 6", "sales_organization": { "id": "28c25dc2-b2de-47da-8810-f087656aeb04", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "a8b3bf10-9712-464f-8ee2-30f2aa562301", "db_currency_id": "9773d0d9-19de-4bca-8f87-d31e0467fa80", "db_language_id": "9c61778b-cafd-4e4b-a3b2-3e5c3776ff57", "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-12-21T17:11:21.0684015+00:00" }, "modified_dateutc": "2024-12-21T17:11:21.0684015+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "b4fcc958-044d-455b-9217-f201c84bf493", "date_reported_by_company": "2024-12-21T17:11:21.0684015+00:00", "id2": 36, "company_id": "5fd64c4a-7033-4718-a1bc-77798af2010c", "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": "b6650d23-c4d0-4a64-aba4-cb10928b7ee4", "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-12-21T17:11:21.0684015+00:00" }
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.