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": "f0d83b1c-4cd3-4ab2-b3c1-8d6fe79a76c6", "_parent_id": "721e6e73-8c6f-42b7-a7ed-11e03f8ae90b", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "4f016a82-adce-4f2f-82f2-ea0c98340236", "project_reference_back_office": "sample string 5", "project": { "id": "ccf2b0eb-0ee5-4e61-9ff4-145be3794c4b", "_parent_id": "150a8638-881b-4a50-998b-f401bd3fd09a", "root_parent_id": "04e2be30-f7a3-4998-9328-edde87141716", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "4a1870b7-7cf7-452f-afca-346de8ca3a57", "equipment_family_code": "sample string 6", "equipment_family": { "id": "f0b18663-576e-45cb-bc9a-a738cd4aa2f4", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "dd9201fa-23a3-4ce2-9a7f-9f90e63b9e9c", "_parent_code": "sample string 6", "sales_organization_id": "a66843ef-d207-4f37-80e8-05338f8d332b", "sales_organization_code": "sample string 8", "sales_organization": { "id": "7c7a967b-ca45-4098-994c-c7f5aa25d16a", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "847ef2b8-d83e-4933-b9a2-5ddcf3db27f7", "db_currency_id": "2e7aab14-bd87-487c-919d-6a9ff075f28f", "db_language_id": "03599fe1-3af5-46ad-a12f-8cee08e0000b", "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": "2022-08-08T07:20:58.5932547+02:00" }, "modified_dateutc": "2022-08-08T07:20:58.5932547+02:00" }, "equipment_model_id": "d2a08d66-8814-4c98-8924-789c1ad17bb9", "equipment_model_code": "sample string 8", "equipment_model": { "id": "c399de28-e23a-481e-a11d-ed41a0da652e", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "910cb89d-4332-48ee-899d-ace64d4578a4", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "b573623e-0208-474c-b037-d475bb21caf1", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "20e23c9e-a0aa-43c9-a25e-17bf11f9209c", "sales_organization_code": "sample string 5", "sales_organization": { "id": "7c7a967b-ca45-4098-994c-c7f5aa25d16a", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "847ef2b8-d83e-4933-b9a2-5ddcf3db27f7", "db_currency_id": "2e7aab14-bd87-487c-919d-6a9ff075f28f", "db_language_id": "03599fe1-3af5-46ad-a12f-8cee08e0000b", "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": "2022-08-08T07:20:58.5932547+02:00" }, "modified_dateutc": "2022-08-08T07:20:58.5932547+02:00" }, "equipment_family_id": "3f862fac-791f-4504-8cf9-b736b08ebb5f", "equipment_family_code": "sample string 8", "equipment_family": { "id": "f0b18663-576e-45cb-bc9a-a738cd4aa2f4", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "dd9201fa-23a3-4ce2-9a7f-9f90e63b9e9c", "_parent_code": "sample string 6", "sales_organization_id": "a66843ef-d207-4f37-80e8-05338f8d332b", "sales_organization_code": "sample string 8", "sales_organization": { "id": "7c7a967b-ca45-4098-994c-c7f5aa25d16a", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "847ef2b8-d83e-4933-b9a2-5ddcf3db27f7", "db_currency_id": "2e7aab14-bd87-487c-919d-6a9ff075f28f", "db_language_id": "03599fe1-3af5-46ad-a12f-8cee08e0000b", "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": "2022-08-08T07:20:58.5932547+02:00" }, "modified_dateutc": "2022-08-08T07:20:58.5932547+02:00" }, "date_in_production_since": "2022-08-08T07:20:58.5932547+02:00", "date_out_of_production_since": "2022-08-08T07:20:58.5932547+02:00", "date_end_support": "2022-08-08T07:20:58.5932547+02:00", "sales_organization_id": "9969984e-bbc0-40c3-852a-3fee834c8a7c", "sales_organization_code": "sample string 13", "sales_organization": { "id": "7c7a967b-ca45-4098-994c-c7f5aa25d16a", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "847ef2b8-d83e-4933-b9a2-5ddcf3db27f7", "db_currency_id": "2e7aab14-bd87-487c-919d-6a9ff075f28f", "db_language_id": "03599fe1-3af5-46ad-a12f-8cee08e0000b", "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": "2022-08-08T07:20:58.5932547+02: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": "2022-08-08T07:20:58.5932547+02:00" }, "project_status_id": "e54d2a3b-a6aa-42c1-9d4d-92d598b3798f", "project_status_code": "sample string 10", "project_status": { "id": "96dbb1c4-0b77-459d-af32-787054d07c3e", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "4da4a074-9c52-4828-acac-4b2e5c15f781", "sales_organization_code": "sample string 6", "sales_organization": { "id": "7c7a967b-ca45-4098-994c-c7f5aa25d16a", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "847ef2b8-d83e-4933-b9a2-5ddcf3db27f7", "db_currency_id": "2e7aab14-bd87-487c-919d-6a9ff075f28f", "db_language_id": "03599fe1-3af5-46ad-a12f-8cee08e0000b", "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": "2022-08-08T07:20:58.5932547+02:00" }, "code": "sample string 7", "modified_dateutc": "2022-08-08T07:20:58.5932547+02:00" }, "company_id": "bb1b6ecd-be83-4962-8773-c6477f18fb8d", "company_code": "sample string 12", "db_address_id": "c0cc29ab-3e80-455c-b1d2-272b20c03448", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "1479a706-f5c7-42e8-b4b3-c88e83af7189", "contact_reference_back_office": "sample string 17", "owner_user_id": "1c1a91fa-8add-449f-8650-9d9d0737004f", "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": "2022-08-08T07:20:58.5932547+02:00", "date_create": "2022-08-08T07:20:58.5932547+02:00", "date_update": "2022-08-08T07:20:58.5932547+02:00", "updated_by_user_id": "86d54a5f-1fd9-4d9b-91dc-6c2d46ffd122", "customer_reference": "sample string 28", "warranty_date_until": "2022-08-08T07:20:58.5932547+02: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": "2022-08-08T00:00:00+02:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2022-08-08T07:20:58.5932547+02:00", "date_last_job": "2022-08-08T07:20:58.5932547+02:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2022-08-08T07:20:58.5932547+02:00", "modified_dateutc": "2022-08-08T07:20:58.5932547+02:00", "is_mobile_installation": true }, "job_type_id": "401f3f4b-45f7-4b45-a807-d4b1ca7a26a0", "job_type_code": "sample string 7", "job_type": { "id": "dcdd65ad-14ee-42f7-80af-7dfa4e5ba3d8", "name": "sample string 2", "sales_organization_id": "7d62df74-9902-462d-a860-332d8622feb0", "description": "sample string 4", "is_default": true, "modified_dateutc": "2022-08-08T07:20:58.5932547+02:00", "code": "sample string 7" }, "job_priority_id": "48f4fc65-c8da-45a8-86ed-cbb75ec6972c", "job_priority_code": "sample string 9", "job_priority": { "id": "2acf0e1f-1644-4ecd-8919-5515d8d0e772", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "18a6960d-0f67-4bda-a485-114a473d537d", "sales_organization_code": "sample string 6", "sales_organization": { "id": "7c7a967b-ca45-4098-994c-c7f5aa25d16a", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "847ef2b8-d83e-4933-b9a2-5ddcf3db27f7", "db_currency_id": "2e7aab14-bd87-487c-919d-6a9ff075f28f", "db_language_id": "03599fe1-3af5-46ad-a12f-8cee08e0000b", "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": "2022-08-08T07:20:58.5932547+02:00" }, "code": "sample string 7", "modified_dateutc": "2022-08-08T07:20:58.5932547+02:00" }, "job_status_id": "edf04e8d-fd3a-4907-826b-918ccdee6e4a", "job_status_code": "sample string 11", "db_address_id": "64226795-359c-4b32-991f-24f31b72c573", "contact_id": "4642d35d-2f33-456d-84e0-61fe1e023938", "requested_by_company_id": "66021019-2e47-40e7-8dde-9cabe5f152bb", "requested_by_contact_id": "ea38c4e7-81e2-4114-9947-3a88f5e70309", "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": "2022-08-08T07:20:58.5932547+02:00", "due_date": "2022-08-08T07:20:58.5932547+02:00", "date_create": "2022-08-08T07:20:58.5932547+02:00", "date_update": "2022-08-08T07:20:58.5932547+02:00", "date_closed": "2022-08-08T07:20:58.5932547+02:00", "suggested_user_id": "a2d26ad8-d5a7-4524-a622-10f98557e26e", "suggested_user_code": "sample string 29", "suggested_user": { "id": "095cd3ea-ae84-4689-988e-039051cb1774", "db_language_id": "d12d3e56-493f-4791-8d52-7fb5e0d839c1", "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": "2022-08-08T07:20:58.5932547+02:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "a0b11f4d-df92-482c-9518-acbcac3ba65f", "sales_organization": { "id": "7c7a967b-ca45-4098-994c-c7f5aa25d16a", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "847ef2b8-d83e-4933-b9a2-5ddcf3db27f7", "db_currency_id": "2e7aab14-bd87-487c-919d-6a9ff075f28f", "db_language_id": "03599fe1-3af5-46ad-a12f-8cee08e0000b", "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": "2022-08-08T07:20:58.5932547+02:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "e4ed9298-cce1-4632-aa89-97b8ff110329", "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": "18c24d27-47b7-423e-a881-5a84316bb4f4", "private_db_country_code": "sample string 35", "modified_dateutc": "2022-08-08T07:20:58.5932547+02:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "00025af7-30be-40aa-b66f-68cb0733e75b" }, "suggested_date_start": "2022-08-08T07:20:58.5932547+02:00", "skill_id": "ea623808-46db-47b9-8d84-8db558d54b0d", "skill_code": "sample string 32", "skill": { "id": "a975a5e2-4c99-4eb9-aeb0-48b5762b3112", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "e682c005-59af-448b-888f-27156ed53403", "sales_organization_code": "sample string 6", "sales_organization": { "id": "7c7a967b-ca45-4098-994c-c7f5aa25d16a", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "847ef2b8-d83e-4933-b9a2-5ddcf3db27f7", "db_currency_id": "2e7aab14-bd87-487c-919d-6a9ff075f28f", "db_language_id": "03599fe1-3af5-46ad-a12f-8cee08e0000b", "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": "2022-08-08T07:20:58.5932547+02:00" }, "modified_dateutc": "2022-08-08T07:20:58.5932547+02:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "9bc52331-7e8c-4d63-910e-26b905c00263", "date_reported_by_company": "2022-08-08T07:20:58.5932547+02:00", "id2": 36, "company_id": "5dfd8860-248b-4515-a072-0e4dcfc4ca5d", "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": "42d98271-5b45-4e02-9e1d-a3285647a579", "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": "2022-08-08T07:20:58.5932547+02:00" }
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.