Retrieves the work instruction type option with the specified key.

Request Information

URI Parameters :

NameDescriptionTypeAdditional information
id

The work instruction type option id.

 globally unique identifier

Required

Body Parameters :

None.

Response Information

Resource Description :

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

work_instruction_type_options
NameDescriptionTypeAdditional information
id

Primary Key

 globally unique identifier
work_instruction_type_id

Foreign key of the work instruction type this option belongs to.

 globally unique identifier
name

Internal name/code identifying this option.

 string
label

Display label shown to the technician for this option.

 string
fill_color

Display color (e.g. hex code) used to render this option in the UI.

 string
help_text

Help text shown to the technician to explain this option.

 string
text_1_enabled

Indicates a first free-text field should be shown when this option is selected.

 boolean
text_1_label

Display label of the first free-text field (see ).

 string
text_1_required

Indicates the first free-text field must be filled in when this option is selected.

 boolean
text_2_enabled

Indicates a second free-text field should be shown when this option is selected.

 boolean
text_2_label

Display label of the second free-text field (see ).

 string
text_2_required

Indicates the second free-text field must be filled in when this option is selected.

 boolean
archived

Indicates whether this option has been archived (no longer selectable).

 boolean
modified_dateutc

Readonly system field managed by database, filled with GetUtcDate when adding,updating

 date

Response Formats

application/json, text/json

Sample: 
{
  "id": "ac2805a3-189e-4b06-b366-a0fcbe180ee9",
  "work_instruction_type_id": "903be073-c8f4-4065-a348-5ced0140ff4a",
  "name": "sample string 3",
  "label": "sample string 4",
  "fill_color": "sample string 5",
  "help_text": "sample string 6",
  "text_1_enabled": true,
  "text_1_label": "sample string 8",
  "text_1_required": true,
  "text_2_enabled": true,
  "text_2_label": "sample string 11",
  "text_2_required": true,
  "archived": true,
  "modified_dateutc": "2026-09-16T09:23:55.8812107+00:00"
}

application/xml, text/xml

Sample: 
<work_instruction_type_options xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <archived>true</archived>
  <fill_color>sample string 5</fill_color>
  <help_text>sample string 6</help_text>
  <id>ac2805a3-189e-4b06-b366-a0fcbe180ee9</id>
  <label>sample string 4</label>
  <modified_dateutc>2026-09-16T09:23:55.881Z</modified_dateutc>
  <name>sample string 3</name>
  <text_1_enabled>true</text_1_enabled>
  <text_1_label>sample string 8</text_1_label>
  <text_1_required>true</text_1_required>
  <text_2_enabled>true</text_2_enabled>
  <text_2_label>sample string 11</text_2_label>
  <text_2_required>true</text_2_required>
  <work_instruction_type_id>903be073-c8f4-4065-a348-5ced0140ff4a</work_instruction_type_id>
</work_instruction_type_options>