Retrieves the job work instruction detail with the specified key.

Request Information

URI Parameters :

NameDescriptionTypeAdditional information
id

The job work instruction detail id.

 globally unique identifier

Required

Body Parameters :

None.

Response Information

Resource Description :

IHttpActionResult containing the job work instruction detail, or 404 Not Found if it doesn't exist.

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

Sample: 
{
  "id": "c41d5c31-4369-47ba-98ef-6a8488acc2c4",
  "job_work_instruction_id": "7fb6d3c0-e69c-4c2f-93cf-8baa85e8c3df",
  "work_instruction_details_id": "9c7b5ce0-421a-41c4-a988-6ef61d64482e",
  "work_instruction_action_type_id": "cca9fd66-a3fa-4808-bd7f-a31806a5f155",
  "description": "sample string 5",
  "sequence": 6,
  "reference_back_office": "sample string 7",
  "modified_dateutc": "2026-09-16T09:25:00.7994728+00:00",
  "parent_id": "63a2f844-e87c-427a-9300-22733b6dec93",
  "is_group": true,
  "is_archived": true,
  "type": "sample string 12",
  "db_report_type_id": "4ba82577-acb4-400b-9d5b-69e5e62dc5ef",
  "instruction_document_count": 14,
  "show_ok": true,
  "show_nok": true,
  "show_replaced": true,
  "show_na": true,
  "db_file_id": "dbf807a6-e36d-4cb9-a108-d1fde0033570",
  "work_instruction_type_id": "c49d0f82-bbac-4ef3-beb1-e64a27d61521",
  "show_options": "sample string 21"
}

application/xml, text/xml

Sample: 
<job_work_instruction_details xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <db_file_id>dbf807a6-e36d-4cb9-a108-d1fde0033570</db_file_id>
  <db_report_type_id>4ba82577-acb4-400b-9d5b-69e5e62dc5ef</db_report_type_id>
  <description>sample string 5</description>
  <id>c41d5c31-4369-47ba-98ef-6a8488acc2c4</id>
  <instruction_document_count>14</instruction_document_count>
  <is_archived>true</is_archived>
  <is_group>true</is_group>
  <job_work_instruction_id>7fb6d3c0-e69c-4c2f-93cf-8baa85e8c3df</job_work_instruction_id>
  <modified_dateutc>2026-09-16T09:25:00.799Z</modified_dateutc>
  <parent_id>63a2f844-e87c-427a-9300-22733b6dec93</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>cca9fd66-a3fa-4808-bd7f-a31806a5f155</work_instruction_action_type_id>
  <work_instruction_details_id>9c7b5ce0-421a-41c4-a988-6ef61d64482e</work_instruction_details_id>
  <work_instruction_type_id>c49d0f82-bbac-4ef3-beb1-e64a27d61521</work_instruction_type_id>
</job_work_instruction_details>