Retrieves 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 :
None.
Response Information
Resource Description :
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 |
Response Formats
application/json, text/json
Sample:
{
"id": "77099b62-9b99-4e5d-ab7b-f1a3e620d757",
"jobs_id": "16d519c7-0e83-44a5-b452-9ebe72a17f66",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "ea84f0cc-110d-4564-aa9c-6060122e2c0b",
"_parent_id": "89f46f4d-d121-4048-9199-2cd464e468a4",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "c1e8068d-f4af-44dc-977d-2e86d3d939a2",
"project_reference_back_office": "sample string 5",
"project": {
"id": "284b74ff-cffa-4423-8bb6-19480d4e4df0",
"_parent_id": "f31974ed-8721-417f-8252-e08f1b39f7b7",
"root_parent_id": "05b0e188-ceb5-4897-81f3-a22f8bcde6bd",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "8c990cb1-c3c4-491b-81eb-f30fc720ea3e",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "7a44c417-c794-4ca9-8cbd-c50b4caedbfc",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "0a3cd72a-35da-43e9-a621-7da1b42bf835",
"_parent_code": "sample string 6",
"sales_organization_id": "08fc6513-e5cd-4d0c-be12-d7c9c438c0e3",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "7773121d-93b5-4ee1-b775-66e5ab4f49a0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "350ff369-1e89-4e2f-a17b-0e22733fba10",
"db_currency_id": "b835cf53-9a74-4b09-a389-04bb4950e2a3",
"db_language_id": "48f5bf97-97a6-42c1-aa30-9fffce89f725",
"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-09T23:28:29.634151+00:00"
},
"modified_dateutc": "2026-01-09T23:28:29.634151+00:00"
},
"equipment_model_id": "f6c0d38a-b3de-4804-b7cd-3db539093626",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "3cab5f2e-61c6-4d5b-9e90-b7dfaa2002a8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "a35c4b68-9db0-4f00-b1eb-df0b50645da1",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "00a90908-be0b-4604-b85c-dfb865384a69",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "4a235965-1dac-45cc-aa3d-66871f9b84a3",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7773121d-93b5-4ee1-b775-66e5ab4f49a0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "350ff369-1e89-4e2f-a17b-0e22733fba10",
"db_currency_id": "b835cf53-9a74-4b09-a389-04bb4950e2a3",
"db_language_id": "48f5bf97-97a6-42c1-aa30-9fffce89f725",
"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-09T23:28:29.634151+00:00"
},
"modified_dateutc": "2026-01-09T23:28:29.634151+00:00"
},
"equipment_family_id": "f7fbdebd-fa9e-436c-91f9-65f7a7139316",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "7a44c417-c794-4ca9-8cbd-c50b4caedbfc",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "0a3cd72a-35da-43e9-a621-7da1b42bf835",
"_parent_code": "sample string 6",
"sales_organization_id": "08fc6513-e5cd-4d0c-be12-d7c9c438c0e3",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "7773121d-93b5-4ee1-b775-66e5ab4f49a0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "350ff369-1e89-4e2f-a17b-0e22733fba10",
"db_currency_id": "b835cf53-9a74-4b09-a389-04bb4950e2a3",
"db_language_id": "48f5bf97-97a6-42c1-aa30-9fffce89f725",
"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-09T23:28:29.634151+00:00"
},
"modified_dateutc": "2026-01-09T23:28:29.634151+00:00"
},
"date_in_production_since": "2026-01-09T23:28:29.634151+00:00",
"date_out_of_production_since": "2026-01-09T23:28:29.634151+00:00",
"date_end_support": "2026-01-09T23:28:29.634151+00:00",
"sales_organization_id": "24292d51-845a-498b-81d2-98df8c309ae4",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "7773121d-93b5-4ee1-b775-66e5ab4f49a0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "350ff369-1e89-4e2f-a17b-0e22733fba10",
"db_currency_id": "b835cf53-9a74-4b09-a389-04bb4950e2a3",
"db_language_id": "48f5bf97-97a6-42c1-aa30-9fffce89f725",
"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-09T23:28:29.634151+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-09T23:28:29.634151+00:00"
},
"project_status_id": "b12d9a57-b312-429f-aa68-b07a8d9b08d5",
"project_status_code": "sample string 10",
"project_status": {
"id": "aead7ccc-5c99-4dd8-89a7-c78c7670ecd5",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "65864371-20e3-4798-bbb5-05b7e05b9457",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7773121d-93b5-4ee1-b775-66e5ab4f49a0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "350ff369-1e89-4e2f-a17b-0e22733fba10",
"db_currency_id": "b835cf53-9a74-4b09-a389-04bb4950e2a3",
"db_language_id": "48f5bf97-97a6-42c1-aa30-9fffce89f725",
"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-09T23:28:29.634151+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-09T23:28:29.634151+00:00"
},
"company_id": "567569b7-3d51-4758-ba8f-668e506ad46a",
"company_code": "sample string 12",
"db_address_id": "9f234e7b-60ad-4a0e-9977-82c9c1264a4e",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "295c933e-a460-4ffb-bfbc-7e750f6c026a",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "ce007df2-ea1c-42c4-85e7-4f445254e5cc",
"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-09T23:28:29.634151+00:00",
"date_create": "2026-01-09T23:28:29.634151+00:00",
"date_update": "2026-01-09T23:28:29.634151+00:00",
"updated_by_user_id": "0348cad6-778f-4337-ada8-ec5b214a8fd1",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-09T23:28:29.634151+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-09T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-09T23:28:29.634151+00:00",
"date_last_job": "2026-01-09T23:28:29.634151+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-09T23:28:29.634151+00:00",
"modified_dateutc": "2026-01-09T23:28:29.634151+00:00",
"is_mobile_installation": true
},
"job_type_id": "17302d39-d0ce-4715-af2a-b2dba2c40c81",
"job_type_code": "sample string 7",
"job_type": {
"id": "3458ea78-f45a-4e79-bdc8-62ee3e573d85",
"name": "sample string 2",
"sales_organization_id": "b1ce5b83-5834-4939-a995-7335008d27dd",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-09T23:28:29.634151+00:00",
"code": "sample string 7"
},
"job_priority_id": "6495d5ed-d082-436d-8288-2118421d0b21",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "34772d9f-83c1-4a5b-9f17-4d83827a8609",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "1171af1c-7de0-4131-a57d-a014d8ee3d89",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7773121d-93b5-4ee1-b775-66e5ab4f49a0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "350ff369-1e89-4e2f-a17b-0e22733fba10",
"db_currency_id": "b835cf53-9a74-4b09-a389-04bb4950e2a3",
"db_language_id": "48f5bf97-97a6-42c1-aa30-9fffce89f725",
"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-09T23:28:29.634151+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-09T23:28:29.634151+00:00"
},
"job_status_id": "56efabb0-c6e9-4832-9ef2-e8cacac185fa",
"job_status_code": "sample string 11",
"db_address_id": "8c1926c5-b599-4f4a-aa28-78c06f758802",
"contact_id": "c592fa99-d624-43fd-a421-d06ffc637d88",
"requested_by_company_id": "a51485a6-e5d7-438e-a8fe-9f357a31bde1",
"requested_by_contact_id": "406768c3-b0ec-4782-a8dc-2ead6aa896d9",
"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-09T23:28:29.634151+00:00",
"due_date": "2026-01-09T23:28:29.634151+00:00",
"date_create": "2026-01-09T23:28:29.634151+00:00",
"date_update": "2026-01-09T23:28:29.634151+00:00",
"date_closed": "2026-01-09T23:28:29.634151+00:00",
"suggested_user_id": "b8e865a7-fe42-4abb-8db2-18d14fc03f94",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "928cb4cf-d1a0-43a2-95d6-80112caec9c4",
"db_language_id": "79c8eb49-d63d-446a-bd0e-4df4fa6a247b",
"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-09T23:28:29.634151+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "1970a98f-5a55-4373-ad80-e0cc50340bcd",
"sales_organization": {
"id": "7773121d-93b5-4ee1-b775-66e5ab4f49a0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "350ff369-1e89-4e2f-a17b-0e22733fba10",
"db_currency_id": "b835cf53-9a74-4b09-a389-04bb4950e2a3",
"db_language_id": "48f5bf97-97a6-42c1-aa30-9fffce89f725",
"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-09T23:28:29.634151+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "f0b63fdb-85f9-4145-9ad3-675b22590ee6",
"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": "fa24bb9c-5b71-487b-aabf-d95100c6b91e",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-09T23:28:29.634151+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "a31403be-486c-438f-b7fc-b31d8982fffa"
},
"suggested_date_start": "2026-01-09T23:28:29.634151+00:00",
"skill_id": "55d2a026-e0fe-4da0-a45c-6353ef8c8e88",
"skill_code": "sample string 32",
"skill": {
"id": "00460596-0f47-4177-a142-c9275fc4218c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "4e194798-e435-40c6-aa49-6e45579b4dbc",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7773121d-93b5-4ee1-b775-66e5ab4f49a0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "350ff369-1e89-4e2f-a17b-0e22733fba10",
"db_currency_id": "b835cf53-9a74-4b09-a389-04bb4950e2a3",
"db_language_id": "48f5bf97-97a6-42c1-aa30-9fffce89f725",
"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-09T23:28:29.634151+00:00"
},
"modified_dateutc": "2026-01-09T23:28:29.634151+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "a33df7b0-5e26-49e3-8d46-d74d68ed7a46",
"date_reported_by_company": "2026-01-09T23:28:29.634151+00:00",
"id2": 36,
"company_id": "49dfd512-2695-49d4-836c-378398519358",
"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": "8477bfec-3994-48c5-beb1-5fbc0478d784",
"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-09T23:28:29.6497796+00:00"
},
"work_instruction_details_id": "edc82cd3-b89f-4bba-81db-5ff65b2d39c7",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "9f3d08ea-7d18-4bed-8e12-dc5298643d46",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "aee0c0be-8914-48b2-98fe-a0e54e380a4e",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-09T23:28:29.6497796+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": "3876ee1a-865e-4888-bb43-babdd8b9be05",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-09T23:28:29.6497796+00:00"
}