Retrieves all job work instruction details, optionally filtered via OData query options.
Request Information
URI Parameters :
None.
Body Parameters :
None.
Response Information
Resource Description :
IHttpActionResult containing the list of job work instruction details.
job_work_instruction_details| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Primary Key |
globally unique identifier | |
| job_work_instruction_id |
Ref job workinstuction |
globally unique identifier | |
| work_instruction_details_id |
Ref work instruction details |
globally unique identifier | |
| work_instruction_action_type_id |
Ref work instruction type |
globally unique identifier | |
| description |
Description |
string | |
| sequence |
Sequence |
integer | |
| reference_back_office |
Ref back office |
string | |
| modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date | |
| parent_id |
Parent id |
globally unique identifier | |
| is_group |
is_group flag |
boolean | |
| is_archived |
is_archived flag |
boolean | |
| type |
Kind of checklist step this represents (e.g. a simple check vs a measurement step), controlling how it is rendered. |
string | |
| db_report_type_id |
Foreign key of the report type to use when this step requires filling in a report. |
globally unique identifier | |
| instruction_document_count |
Number of reference documents attached to this instruction step. |
integer | |
| show_ok |
Indicates the "OK" outcome option is offered to the technician for this step. |
boolean | |
| show_nok |
Indicates the "Not OK" outcome option is offered to the technician for this step. |
boolean | |
| show_replaced |
Indicates the "Replaced" outcome option is offered to the technician for this step. |
boolean | |
| show_na |
Indicates the "Not Applicable" outcome option is offered to the technician for this step. |
boolean | |
| db_file_id |
Foreign key of a reference file/document attached to this instruction step. |
globally unique identifier | |
| work_instruction_type_id |
Foreign key of the work instruction type controlling which outcome options are available (see ). |
globally unique identifier | |
| show_options |
Serialized set of outcome options enabled for this step, when they differ from the defaults defined by . |
string |
Response Formats
application/json, text/json
{
"id": "985cfc87-7d9c-4e72-977f-f83f60b147ec",
"job_work_instruction_id": "2e50ed65-87f1-42fb-9f91-2274f61678ad",
"work_instruction_details_id": "3390ba86-6314-45d1-8701-612d1c3c266c",
"work_instruction_action_type_id": "cdff9944-b4be-4ee3-a4bd-f7521e623908",
"description": "sample string 5",
"sequence": 6,
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-16T10:16:16.0055186+00:00",
"parent_id": "da7a0edd-20f3-48e3-baf3-f75379863122",
"is_group": true,
"is_archived": true,
"type": "sample string 12",
"db_report_type_id": "53ad73a1-fed2-4ccd-a2d1-96c08900eeea",
"instruction_document_count": 14,
"show_ok": true,
"show_nok": true,
"show_replaced": true,
"show_na": true,
"db_file_id": "01f1d9cb-82d1-4d74-9ec7-e6f35c062386",
"work_instruction_type_id": "b3983fe7-6bcc-4e99-ae01-2120ea9d3279",
"show_options": "sample string 21"
}
application/xml, text/xml
<job_work_instruction_details xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <db_file_id>01f1d9cb-82d1-4d74-9ec7-e6f35c062386</db_file_id> <db_report_type_id>53ad73a1-fed2-4ccd-a2d1-96c08900eeea</db_report_type_id> <description>sample string 5</description> <id>985cfc87-7d9c-4e72-977f-f83f60b147ec</id> <instruction_document_count>14</instruction_document_count> <is_archived>true</is_archived> <is_group>true</is_group> <job_work_instruction_id>2e50ed65-87f1-42fb-9f91-2274f61678ad</job_work_instruction_id> <modified_dateutc>2026-09-16T10:16:16.005Z</modified_dateutc> <parent_id>da7a0edd-20f3-48e3-baf3-f75379863122</parent_id> <reference_back_office>sample string 7</reference_back_office> <sequence>6</sequence> <show_na>true</show_na> <show_nok>true</show_nok> <show_ok>true</show_ok> <show_options>sample string 21</show_options> <show_replaced>true</show_replaced> <type>sample string 12</type> <work_instruction_action_type_id>cdff9944-b4be-4ee3-a4bd-f7521e623908</work_instruction_action_type_id> <work_instruction_details_id>3390ba86-6314-45d1-8701-612d1c3c266c</work_instruction_details_id> <work_instruction_type_id>b3983fe7-6bcc-4e99-ae01-2120ea9d3279</work_instruction_type_id> </job_work_instruction_details>