Retrieves all work instruction detail steps, optionally filtered via OData query options.

Request Information

URI Parameters :

None.

Body Parameters :

None.

Response Information

Resource Description :

IHttpActionResult containing the list of work instruction detail steps.

work_instruction_details
NameDescriptionTypeAdditional 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

Sample: 
{
  "id": "2528376c-a352-4d3e-aa49-f578b9f4cab5",
  "work_instruction_id": "7b700fb2-4487-45b5-aa43-880cff097e01",
  "work_instruction_action_type_id": "3506b8da-8d20-4674-b427-dc50aaf4d281",
  "description": "sample string 4",
  "sequence": 5,
  "reference_back_office": "sample string 6",
  "modified_dateutc": "2026-11-12T14:28:35.8694393+00:00",
  "parent_id": "2ae8f468-5c76-4550-9a00-1d091a164c18",
  "is_group": true,
  "is_archived": true,
  "type": "sample string 11",
  "db_report_type_id": "dd2223ef-285e-4a48-be04-cb5876cdebd4",
  "instruction_document_count": 13,
  "show_ok": true,
  "show_nok": true,
  "show_replaced": true,
  "show_na": true,
  "db_file_id": "0c1f3869-cc00-4f6d-a5b1-286605699f95",
  "work_instruction_type_id": "a624c0fb-fd6e-49f4-9673-82b789fd6346",
  "show_options": "sample string 20"
}

application/xml, text/xml

Sample: 
<work_instruction_details xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <db_file_id>0c1f3869-cc00-4f6d-a5b1-286605699f95</db_file_id>
  <db_report_type_id>dd2223ef-285e-4a48-be04-cb5876cdebd4</db_report_type_id>
  <description>sample string 4</description>
  <id>2528376c-a352-4d3e-aa49-f578b9f4cab5</id>
  <instruction_document_count>13</instruction_document_count>
  <is_archived>true</is_archived>
  <is_group>true</is_group>
  <modified_dateutc>2026-11-12T14:28:35.869Z</modified_dateutc>
  <parent_id>2ae8f468-5c76-4550-9a00-1d091a164c18</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>3506b8da-8d20-4674-b427-dc50aaf4d281</work_instruction_action_type_id>
  <work_instruction_id>7b700fb2-4487-45b5-aa43-880cff097e01</work_instruction_id>
  <work_instruction_type_id>a624c0fb-fd6e-49f4-9673-82b789fd6346</work_instruction_type_id>
</work_instruction_details>