Retrieves the work instruction detail step with the specified key.
Request Information
URI Parameters :
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
The work instruction detail step id. |
globally unique identifier |
Required |
Body Parameters :
None.
Response Information
Resource Description :
IHttpActionResult containing the work instruction detail step, or 404 Not Found if it doesn't exist.
work_instruction_details| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Primary Key |
globally unique identifier | |
| work_instruction_id |
Ref work instruction |
globally unique identifier | |
| work_instruction_action_type_id |
Ref work instruction action 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": "2c4918a7-a1d1-4383-a27a-e35356a0b41f",
"work_instruction_id": "13a4559d-9fc2-4afe-8e5b-cf68d6315148",
"work_instruction_action_type_id": "8105cf4c-45c4-43b4-b553-c238321c9411",
"description": "sample string 4",
"sequence": 5,
"reference_back_office": "sample string 6",
"modified_dateutc": "2026-09-16T09:25:03.7213125+00:00",
"parent_id": "7b4c6bcd-71a9-4857-ba6c-580c0a6beee2",
"is_group": true,
"is_archived": true,
"type": "sample string 11",
"db_report_type_id": "d72085f6-2110-4811-b8d2-850609af68e3",
"instruction_document_count": 13,
"show_ok": true,
"show_nok": true,
"show_replaced": true,
"show_na": true,
"db_file_id": "6fc0a7d2-957e-4761-9fbb-267ba9e4992d",
"work_instruction_type_id": "c4211c51-a1e1-4408-babe-2e6a87a4aeb2",
"show_options": "sample string 20"
}
application/xml, text/xml
<work_instruction_details xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <db_file_id>6fc0a7d2-957e-4761-9fbb-267ba9e4992d</db_file_id> <db_report_type_id>d72085f6-2110-4811-b8d2-850609af68e3</db_report_type_id> <description>sample string 4</description> <id>2c4918a7-a1d1-4383-a27a-e35356a0b41f</id> <instruction_document_count>13</instruction_document_count> <is_archived>true</is_archived> <is_group>true</is_group> <modified_dateutc>2026-09-16T09:25:03.721Z</modified_dateutc> <parent_id>7b4c6bcd-71a9-4857-ba6c-580c0a6beee2</parent_id> <reference_back_office>sample string 6</reference_back_office> <sequence>5</sequence> <show_na>true</show_na> <show_nok>true</show_nok> <show_ok>true</show_ok> <show_options>sample string 20</show_options> <show_replaced>true</show_replaced> <type>sample string 11</type> <work_instruction_action_type_id>8105cf4c-45c4-43b4-b553-c238321c9411</work_instruction_action_type_id> <work_instruction_id>13a4559d-9fc2-4afe-8e5b-cf68d6315148</work_instruction_id> <work_instruction_type_id>c4211c51-a1e1-4408-babe-2e6a87a4aeb2</work_instruction_type_id> </work_instruction_details>