Updates the job work instruction list with the specified key
Request Information
URI Parameters :
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | globally unique identifier |
Required |
Body Parameters :
job_work_instruction_list| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Primary Key |
globally unique identifier |
Required |
| jobs_id |
Foreign key of the jobs |
globally unique identifier |
Optionally required : jobs_id, jobs_reference_back_office or jobs must be provided |
| jobs_reference_back_office |
Embedded entity "jobs" using ERP PK when adding/updating |
string |
Optionally required : jobs_id, jobs_reference_back_office or jobs must be provided |
| jobs |
Embedded entity "jobs" when adding/updating |
jobs |
Optionally required : jobs_id, jobs_reference_back_office or jobs must be provided |
| work_instruction_details_id |
work instruction details id |
globally unique identifier | |
| work_instruction_details_reference_back_office |
Embedded code "work instruction details" when adding/updating |
string | |
| work_instruction_details |
Embedded entity "work instruction details" when adding/updating |
work_instruction_details | |
| user_id |
Filled by the person that completed that item on the checklist |
globally unique identifier | |
| work_instruction_action_type |
Value from work_instruction_action_type.name |
string | |
| work_instruction_id |
work instruction id |
globally unique identifier |
Optionally required : work_instruction_id,work_instruction_reference_back_office or work_instruction must be provided |
| work_instruction_reference_back_office |
Embedded code "work instruction" when adding/updating |
string |
Optionally required : work_instruction_id,work_instruction_reference_back_office or work_instruction must be provided |
| work_instruction |
Embedded entity "work instruction" when adding/updating |
work_instruction |
Optionally required : work_instruction_id,work_instruction_reference_back_office or work_instruction must be provided |
| name |
The "on what" |
string |
Required Max length: 4000 |
| status |
Status can be Ok,NotOk,Replaced,NotApplicable |
string |
Max length: 50 |
| date_done |
Datetime filled when status goes to one valable status. |
date | |
| remark |
Additional remark from the technician. |
string |
Max length: 255 |
| advise |
Additional advice from the technician. |
string |
Max length: 255 |
| sequence |
To order it. |
integer | |
| reference_back_office |
The Id/Ref of the back office for this job work instruction. Used by Embedded entity |
string |
Max length: 255 |
| group_name |
Name of the group |
string |
Max length: 4000 |
| group_sequence |
Order of the group |
integer | |
| type |
One of the possible types which are Regular, Form, Picture, UsedParts, BillableHours. Regular is the default |
string | |
| instruction_document_count |
Specify how many documents/photos must be added if type is Picture |
integer | |
| db_report_type_id |
When type is Form, you must specify which db_report_type must be filled |
globally unique identifier | |
| db_report_type_name |
When type is Form, you must specify which db_report_type must be filled |
string | |
| modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date |
Request Formats :
application/json, text/json
Sample:
{
"id": "70c487e0-4437-4408-a74b-3ef1254a4fa4",
"jobs_id": "b52c147b-aec5-4bdb-86b9-55972498d30d",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "0ae4a8ef-6a55-45fd-b89e-d664c0ec0b62",
"_parent_id": "dd9eeef2-4e81-430f-b1d4-29dfa8e2c078",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "4677eb36-3cb1-4d04-9cda-43784bce425f",
"project_reference_back_office": "sample string 5",
"project": {
"id": "9dd49baf-c094-4974-872b-b99847411be1",
"_parent_id": "44e7085e-5875-43f1-9fc1-0a00510a68de",
"root_parent_id": "fd1d476a-50cf-4d6c-aa65-3a61590db1f6",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "64ac345d-a47d-41b0-aec8-c71c8925c1bd",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "e6e999f3-a325-4f11-b1df-4b73145dc79e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1079c819-51ef-4da1-b09a-0803577f32c4",
"_parent_code": "sample string 6",
"sales_organization_id": "1bb12461-94da-4209-bbe5-09647a5b602b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4c80f1f3-3db8-43b3-9b91-1238972f5dc3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "403439b6-64ec-4fbb-9c8f-df17e7714ab0",
"db_currency_id": "fa4b4baa-4faa-416a-86a8-ae8fe9c9c7aa",
"db_language_id": "752e33c2-85ed-4c9a-a21a-205059c805f1",
"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": "2026-06-02T03:50:10.6613413+00:00"
},
"modified_dateutc": "2026-06-02T03:50:10.6613413+00:00"
},
"equipment_model_id": "3ba7f02a-f680-4840-b41d-9a5f129c3a48",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "3ac5288a-85a0-4f46-a279-2d980f8c7ede",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "de141e95-64f9-4f62-90e2-1477345cafc3",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "d1faa61f-4156-4c43-8201-36a339f36875",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "55716d6c-f529-4117-9d5b-0b695ebc884a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4c80f1f3-3db8-43b3-9b91-1238972f5dc3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "403439b6-64ec-4fbb-9c8f-df17e7714ab0",
"db_currency_id": "fa4b4baa-4faa-416a-86a8-ae8fe9c9c7aa",
"db_language_id": "752e33c2-85ed-4c9a-a21a-205059c805f1",
"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": "2026-06-02T03:50:10.6613413+00:00"
},
"modified_dateutc": "2026-06-02T03:50:10.6613413+00:00"
},
"equipment_family_id": "3a3c0f9d-03b1-454e-8147-8b83c6e32766",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "e6e999f3-a325-4f11-b1df-4b73145dc79e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1079c819-51ef-4da1-b09a-0803577f32c4",
"_parent_code": "sample string 6",
"sales_organization_id": "1bb12461-94da-4209-bbe5-09647a5b602b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4c80f1f3-3db8-43b3-9b91-1238972f5dc3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "403439b6-64ec-4fbb-9c8f-df17e7714ab0",
"db_currency_id": "fa4b4baa-4faa-416a-86a8-ae8fe9c9c7aa",
"db_language_id": "752e33c2-85ed-4c9a-a21a-205059c805f1",
"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": "2026-06-02T03:50:10.6613413+00:00"
},
"modified_dateutc": "2026-06-02T03:50:10.6613413+00:00"
},
"date_in_production_since": "2026-06-02T03:50:10.6613413+00:00",
"date_out_of_production_since": "2026-06-02T03:50:10.6613413+00:00",
"date_end_support": "2026-06-02T03:50:10.6613413+00:00",
"sales_organization_id": "075dee23-20f3-4fbf-8000-aead761a99a0",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "4c80f1f3-3db8-43b3-9b91-1238972f5dc3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "403439b6-64ec-4fbb-9c8f-df17e7714ab0",
"db_currency_id": "fa4b4baa-4faa-416a-86a8-ae8fe9c9c7aa",
"db_language_id": "752e33c2-85ed-4c9a-a21a-205059c805f1",
"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": "2026-06-02T03:50:10.6613413+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": "2026-06-02T03:50:10.6613413+00:00"
},
"project_status_id": "25f1d480-0ca0-4a88-b899-30c00a9647e7",
"project_status_code": "sample string 10",
"project_status": {
"id": "572da5a4-dfed-4c20-b482-772499a44cae",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "d304c288-a43d-4f6f-84d1-b1f5db85399a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4c80f1f3-3db8-43b3-9b91-1238972f5dc3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "403439b6-64ec-4fbb-9c8f-df17e7714ab0",
"db_currency_id": "fa4b4baa-4faa-416a-86a8-ae8fe9c9c7aa",
"db_language_id": "752e33c2-85ed-4c9a-a21a-205059c805f1",
"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": "2026-06-02T03:50:10.6613413+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-02T03:50:10.6613413+00:00"
},
"company_id": "e7a9828d-4796-4683-9806-55b5d46eaf15",
"company_code": "sample string 12",
"db_address_id": "1096acf6-7564-464a-9cbb-297fd1d245c2",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "e80b22b2-b7fc-488a-99fd-2fb7a86b7f2f",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "94b3b3fa-fcfd-4e13-9416-a295c582dcac",
"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": "2026-06-02T03:50:10.6613413+00:00",
"date_create": "2026-06-02T03:50:10.6613413+00:00",
"date_update": "2026-06-02T03:50:10.6613413+00:00",
"updated_by_user_id": "6ad80134-62e0-4a97-8ed5-94c4de6c4fd3",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-02T03:50:10.6613413+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": "2026-06-02T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-02T03:50:10.6613413+00:00",
"date_last_job": "2026-06-02T03:50:10.6613413+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-02T03:50:10.6613413+00:00",
"modified_dateutc": "2026-06-02T03:50:10.6613413+00:00",
"is_mobile_installation": true
},
"job_type_id": "e3ecaabd-46e0-4c73-baf5-0fd3449ccdb2",
"job_type_code": "sample string 7",
"job_type": {
"id": "98f57325-549d-419f-b7dd-00554f86373e",
"name": "sample string 2",
"sales_organization_id": "c7f9e523-10e2-437f-8051-eb08a5ffa035",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-02T03:50:10.6613413+00:00",
"code": "sample string 7"
},
"job_priority_id": "636aeeb7-4c09-4357-baad-88f920836d19",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "35fc7610-e834-4dd7-b707-288c2389deca",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "2af4de0e-27f4-4ef0-b41f-d15b1c5ef052",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4c80f1f3-3db8-43b3-9b91-1238972f5dc3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "403439b6-64ec-4fbb-9c8f-df17e7714ab0",
"db_currency_id": "fa4b4baa-4faa-416a-86a8-ae8fe9c9c7aa",
"db_language_id": "752e33c2-85ed-4c9a-a21a-205059c805f1",
"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": "2026-06-02T03:50:10.6613413+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-02T03:50:10.6613413+00:00"
},
"job_status_id": "66c15828-f30f-4f6f-bf05-b89a223b656b",
"job_status_code": "sample string 11",
"db_address_id": "12979c24-57e6-49b8-be91-7cfc8c71e320",
"contact_id": "2dc9849c-cee3-4960-a7b3-8c324ec9aeb2",
"requested_by_company_id": "ee66a9e0-63fe-4bbd-aecf-7a8e0acdf3bf",
"requested_by_contact_id": "57edb4b2-6d1d-4fd9-b5ef-109823711601",
"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": "2026-06-02T03:50:10.6613413+00:00",
"due_date": "2026-06-02T03:50:10.6613413+00:00",
"date_create": "2026-06-02T03:50:10.6613413+00:00",
"date_update": "2026-06-02T03:50:10.6613413+00:00",
"date_closed": "2026-06-02T03:50:10.6613413+00:00",
"suggested_user_id": "52f7b08c-b2e2-4d08-b907-5953e327b05d",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "76e2416e-d557-4d39-8694-9cc7903028b5",
"db_language_id": "208d820b-424a-4948-8832-7cf648dcae39",
"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": "2026-06-02T03:50:10.6613413+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "0ea7448e-2078-4dcf-b5e0-a37f87626817",
"sales_organization": {
"id": "4c80f1f3-3db8-43b3-9b91-1238972f5dc3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "403439b6-64ec-4fbb-9c8f-df17e7714ab0",
"db_currency_id": "fa4b4baa-4faa-416a-86a8-ae8fe9c9c7aa",
"db_language_id": "752e33c2-85ed-4c9a-a21a-205059c805f1",
"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": "2026-06-02T03:50:10.6613413+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "d774e84d-a333-4344-95a3-ae5419c4fe5b",
"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": "2fad573d-56dd-406c-a813-cacd06157430",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-02T03:50:10.6613413+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "7a17231c-3583-4f4e-880b-c3d326642750"
},
"suggested_date_start": "2026-06-02T03:50:10.6613413+00:00",
"skill_id": "aaf03633-f092-46c8-b3e4-070dd81fdc50",
"skill_code": "sample string 32",
"skill": {
"id": "6f1b4280-e18d-4356-a0ad-a44dd5f845e6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "fbb7452e-0839-49f9-a526-fdb9a7491ced",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4c80f1f3-3db8-43b3-9b91-1238972f5dc3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "403439b6-64ec-4fbb-9c8f-df17e7714ab0",
"db_currency_id": "fa4b4baa-4faa-416a-86a8-ae8fe9c9c7aa",
"db_language_id": "752e33c2-85ed-4c9a-a21a-205059c805f1",
"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": "2026-06-02T03:50:10.6613413+00:00"
},
"modified_dateutc": "2026-06-02T03:50:10.6613413+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "009e70c4-6e6f-4b12-a2b8-8c893584758f",
"date_reported_by_company": "2026-06-02T03:50:10.6613413+00:00",
"id2": 36,
"company_id": "6ca087f5-63c1-48a6-9e49-015602afa229",
"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": "64ce5d8a-9fc4-43a8-8ed1-986b49fcd6bb",
"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": "2026-06-02T03:50:10.6613413+00:00"
},
"work_instruction_details_id": "01ccb1c1-fa19-417b-a116-06f2d8061c38",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "3e08aec3-1ceb-480a-8d4b-3bc07b7f81e4",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "01d691e8-528c-4dba-ba8e-0e422f5bc2f3",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-02T03:50:10.6613413+00:00",
"remark": "sample string 13",
"advise": "sample string 14",
"sequence": 1,
"reference_back_office": "sample string 15",
"group_name": "sample string 16",
"group_sequence": 1,
"type": "sample string 17",
"instruction_document_count": 1,
"db_report_type_id": "fde0bb46-718f-4f10-bc1a-50996959a5c5",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-02T03:50:10.6613413+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.