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": "a120ad77-9746-46df-872e-6eaf3163d830",
"jobs_id": "7bcda0fe-dad9-401f-8645-73e5fed89f40",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "66a54136-51d9-44b5-a010-2dd2865ae2f2",
"_parent_id": "fb7a74db-bda4-4125-b101-c5fd5bd7b3da",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "b05d99ca-4a54-4f87-a465-ec901f0c0897",
"project_reference_back_office": "sample string 5",
"project": {
"id": "d48d0755-c823-471d-97b3-5cae4af968cd",
"_parent_id": "cf787e5e-619a-49a1-a5bf-18c9d9acc6e8",
"root_parent_id": "03358e4d-6d0b-48e4-b7ab-68b6a12d429a",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "1c3713f7-35d3-429e-a597-36c77b0131d7",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "0f421905-9723-4cbf-8521-f4c70d3d5017",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "0350f8d3-3ed2-44fb-ad74-6ba505f95486",
"_parent_code": "sample string 6",
"sales_organization_id": "e101c6ae-133a-4055-8d95-95dbf04401ce",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4910ad04-5e9f-47cb-84b4-74b39de06c11",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "97ffb96d-eae0-4405-a585-7d29ba16f524",
"db_currency_id": "ffd915c5-e3d4-4402-bd3c-ebed75478203",
"db_language_id": "6adaaf7d-df09-408c-aaf2-96276997cf0c",
"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-01-16T10:07:56.4705064+00:00"
},
"modified_dateutc": "2026-01-16T10:07:56.4705064+00:00"
},
"equipment_model_id": "a0c0c1db-7d8b-4f5f-8229-ce5a75a892b6",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "8a30a9da-588b-48e5-bd1e-00d81887a1d4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "7456a25e-d996-4549-9997-fe2c0ee1c3ea",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "30ea4047-62b8-417a-a747-3caf055acddc",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "95254b5f-f58a-4310-817d-9a778eacf406",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4910ad04-5e9f-47cb-84b4-74b39de06c11",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "97ffb96d-eae0-4405-a585-7d29ba16f524",
"db_currency_id": "ffd915c5-e3d4-4402-bd3c-ebed75478203",
"db_language_id": "6adaaf7d-df09-408c-aaf2-96276997cf0c",
"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-01-16T10:07:56.4705064+00:00"
},
"modified_dateutc": "2026-01-16T10:07:56.4705064+00:00"
},
"equipment_family_id": "8e8ad7f9-9ccf-4e0f-8d80-5fb700fb6f41",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "0f421905-9723-4cbf-8521-f4c70d3d5017",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "0350f8d3-3ed2-44fb-ad74-6ba505f95486",
"_parent_code": "sample string 6",
"sales_organization_id": "e101c6ae-133a-4055-8d95-95dbf04401ce",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4910ad04-5e9f-47cb-84b4-74b39de06c11",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "97ffb96d-eae0-4405-a585-7d29ba16f524",
"db_currency_id": "ffd915c5-e3d4-4402-bd3c-ebed75478203",
"db_language_id": "6adaaf7d-df09-408c-aaf2-96276997cf0c",
"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-01-16T10:07:56.4705064+00:00"
},
"modified_dateutc": "2026-01-16T10:07:56.4705064+00:00"
},
"date_in_production_since": "2026-01-16T10:07:56.4705064+00:00",
"date_out_of_production_since": "2026-01-16T10:07:56.4705064+00:00",
"date_end_support": "2026-01-16T10:07:56.4705064+00:00",
"sales_organization_id": "a6a444e8-f2a7-4ac3-b232-bfb0b159b804",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "4910ad04-5e9f-47cb-84b4-74b39de06c11",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "97ffb96d-eae0-4405-a585-7d29ba16f524",
"db_currency_id": "ffd915c5-e3d4-4402-bd3c-ebed75478203",
"db_language_id": "6adaaf7d-df09-408c-aaf2-96276997cf0c",
"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-01-16T10:07:56.4705064+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-01-16T10:07:56.5173749+00:00"
},
"project_status_id": "c280c65f-6dfd-44ff-acbb-f6db5ec4903e",
"project_status_code": "sample string 10",
"project_status": {
"id": "a7e3dff4-3a90-407f-a530-c1dc5a85011b",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "065c6456-a923-4d45-be3c-a9b8bbf22ac9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4910ad04-5e9f-47cb-84b4-74b39de06c11",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "97ffb96d-eae0-4405-a585-7d29ba16f524",
"db_currency_id": "ffd915c5-e3d4-4402-bd3c-ebed75478203",
"db_language_id": "6adaaf7d-df09-408c-aaf2-96276997cf0c",
"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-01-16T10:07:56.4705064+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-16T10:07:56.5173749+00:00"
},
"company_id": "56a3d530-b376-41a1-99ad-97a731a35137",
"company_code": "sample string 12",
"db_address_id": "e8f2137a-248f-48a2-bf4b-c570c082a4f6",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "f7544c00-f75a-4dd9-90b3-b69eb237a8f8",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "de149617-d7d4-49f2-bcdd-06cf8d8d7b5c",
"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-01-16T10:07:56.5173749+00:00",
"date_create": "2026-01-16T10:07:56.5173749+00:00",
"date_update": "2026-01-16T10:07:56.5173749+00:00",
"updated_by_user_id": "511e8f47-4e80-423e-803b-21483fddd621",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-16T10:07:56.5173749+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-01-16T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-16T10:07:56.5173749+00:00",
"date_last_job": "2026-01-16T10:07:56.5173749+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-16T10:07:56.5173749+00:00",
"modified_dateutc": "2026-01-16T10:07:56.5173749+00:00",
"is_mobile_installation": true
},
"job_type_id": "e384a52d-dcf3-45cc-93c6-b14516c9dddc",
"job_type_code": "sample string 7",
"job_type": {
"id": "c3d85278-7d10-4ec6-a02b-1bde3fc83dd6",
"name": "sample string 2",
"sales_organization_id": "44511008-5d44-449f-b550-40d28e1bf51a",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-16T10:07:56.5173749+00:00",
"code": "sample string 7"
},
"job_priority_id": "ec94bce0-9763-4da8-8133-6fe0ea29b22e",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "31a97ae8-4931-4a91-a52c-3e42794339dd",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "5ee4c6c9-2644-4088-95c1-5a7302ab5a74",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4910ad04-5e9f-47cb-84b4-74b39de06c11",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "97ffb96d-eae0-4405-a585-7d29ba16f524",
"db_currency_id": "ffd915c5-e3d4-4402-bd3c-ebed75478203",
"db_language_id": "6adaaf7d-df09-408c-aaf2-96276997cf0c",
"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-01-16T10:07:56.4705064+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-16T10:07:56.5173749+00:00"
},
"job_status_id": "1ae00f1c-b8bd-4e88-8b0d-6e66edcc1fa7",
"job_status_code": "sample string 11",
"db_address_id": "e7ac8762-6258-4a3d-950a-caecd5e47d3b",
"contact_id": "86a67c5c-b9f3-4771-8a83-1430436c9f0a",
"requested_by_company_id": "f25f66df-510c-4c32-9a4c-6889a87001a4",
"requested_by_contact_id": "3ab7975f-edb1-48d1-8e02-7e381b0a743e",
"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-01-16T10:07:56.5173749+00:00",
"due_date": "2026-01-16T10:07:56.5173749+00:00",
"date_create": "2026-01-16T10:07:56.5173749+00:00",
"date_update": "2026-01-16T10:07:56.5173749+00:00",
"date_closed": "2026-01-16T10:07:56.5173749+00:00",
"suggested_user_id": "bb2af20b-34f0-4978-bf8a-7bbd5abc22d2",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "cf324f9c-9135-4fcb-a607-2e3243050f63",
"db_language_id": "3559f983-ef4e-47f6-a26d-67a823a4c2a9",
"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-01-16T10:07:56.5173749+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "c3901a1b-17eb-4f37-b398-4094d76f5c4d",
"sales_organization": {
"id": "4910ad04-5e9f-47cb-84b4-74b39de06c11",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "97ffb96d-eae0-4405-a585-7d29ba16f524",
"db_currency_id": "ffd915c5-e3d4-4402-bd3c-ebed75478203",
"db_language_id": "6adaaf7d-df09-408c-aaf2-96276997cf0c",
"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-01-16T10:07:56.4705064+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "1f59b886-fd59-4544-9e4d-62133c147859",
"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": "83e8aa93-6ec7-4746-8158-589f116875c4",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-16T10:07:56.5173749+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "312a642f-d4c8-4d7a-83df-7fb2b1899ec4"
},
"suggested_date_start": "2026-01-16T10:07:56.5173749+00:00",
"skill_id": "2cb48262-c278-459c-88bd-61ffb88773d6",
"skill_code": "sample string 32",
"skill": {
"id": "2e76e3f1-1258-409a-a4e3-34e001a61f47",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "9f0603da-3a5a-472d-9def-2b65dda1c94c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4910ad04-5e9f-47cb-84b4-74b39de06c11",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "97ffb96d-eae0-4405-a585-7d29ba16f524",
"db_currency_id": "ffd915c5-e3d4-4402-bd3c-ebed75478203",
"db_language_id": "6adaaf7d-df09-408c-aaf2-96276997cf0c",
"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-01-16T10:07:56.4705064+00:00"
},
"modified_dateutc": "2026-01-16T10:07:56.5173749+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "1672baa8-7036-4e7d-9cf7-3c2ec54e32ac",
"date_reported_by_company": "2026-01-16T10:07:56.5173749+00:00",
"id2": 36,
"company_id": "b1128206-581b-46b0-8558-386c85cfbc39",
"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": "e2e6129e-43da-4668-8280-2260edf20768",
"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-01-16T10:07:56.5173749+00:00"
},
"work_instruction_details_id": "c227add4-04df-45bf-928a-f0396b0d1177",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "cd608dd6-6dba-43fa-ae70-a7c3a72cdaee",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "9a479635-e798-491a-8849-688fb91f1840",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-16T10:07:56.5173749+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": "01e1414a-bb7b-4ed2-b8ed-1d1eae6bd3da",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-16T10:07:56.5173749+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.