Retrieves the job work instruction checklist line with the specified key.
Request Information
URI Parameters :
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
The job work instruction checklist line id. |
globally unique identifier |
Required |
Body Parameters :
None.
Response Information
Resource Description :
IHttpActionResult containing the job work instruction checklist line, or 404 Not Found if it doesn't exist.
job_work_instruction_list| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Primary Key |
globally unique identifier | |
| jobs_id |
FK of a jobs |
globally unique identifier | |
| work_instruction_details_id |
Foreign key of the work instruction template step (see ) this outcome was recorded against. |
globally unique identifier | |
| user_id |
Foreign key of the user who recorded this outcome. |
globally unique identifier | |
| work_instruction_action_type_id |
Foreign key of the action type recorded for this step (see ). |
globally unique identifier | |
| work_instruction_action_type |
Display name of the action type (e.g. "repair", "change"), a denormalized copy of 's value. |
string | |
| name |
Name of the checklist step, copied from the work instruction step this outcome was recorded against. |
string | |
| status |
One of the constant value, can be Ok,NotOk,Replaced,NotApplicable |
string | |
| date_done |
When going to a status (like ok, not ok, replace , notapplicable) this date is set |
date | |
| remark |
Free-text remark entered by the technician about this outcome. |
string | |
| advise |
In case of a problem, an advice can be asked |
string | |
| sequence |
Order field, sequence asc (0 is first) |
integer | |
| work_instruction_id |
Foreign key of the job_work_instruction header record (see ) this step outcome belongs to. |
globally unique identifier | |
| job_work_instruction_details_id |
Foreign key of the job_work_instruction_details step (the per-job generated checklist step) this outcome belongs to. |
globally unique identifier | |
| modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date | |
| db_file_ids |
Comma-separated list of foreign keys of files attached as evidence for this outcome (e.g. photos taken by the technician). |
string | |
| db_report_id |
Foreign key of the filled in for this step, when requires one. |
globally unique identifier | |
| parent_id |
Foreign key of the parent job_work_instruction_list row when this step belongs to a group (see ). |
globally unique identifier | |
| is_group |
Indicates this row represents a group header for child steps (see ), rather than an actual outcome entry. |
boolean | |
| type |
Kind of checklist step this outcome represents (e.g. a simple check vs a measurement step), copied from the work instruction step's configuration. |
string | |
| db_report_type_id |
Foreign key of the report type required for this step, copied from the work instruction step's configuration (see for the resulting filled-in report). |
globally unique identifier | |
| instruction_document_count |
Number of reference documents attached to the work instruction step this outcome was recorded against. |
integer | |
| show_ok |
Indicates the "OK" outcome option was offered to the technician for this step. |
boolean | |
| show_nok |
Indicates the "Not OK" outcome option was offered to the technician for this step. |
boolean | |
| show_replaced |
Indicates the "Replaced" outcome option was offered to the technician for this step. |
boolean | |
| show_na |
Indicates the "Not Applicable" outcome option was offered to the technician for this step. |
boolean | |
| db_file_id |
Foreign key of a reference file/document attached to the work instruction step this outcome was recorded against. |
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 | |
| is_customized |
Indicates this step's details were manually customized rather than copied as-is from the work instruction template. |
boolean |
Response Formats
application/json, text/json
{
"id": "e475e7c6-63a5-4609-9517-f3a68781f866",
"jobs_id": "982bfd0f-7c98-45d7-a738-b5e94c3c05bb",
"work_instruction_details_id": "a9422c49-a4eb-46bc-95d4-9a8d50c919b2",
"user_id": "8074c3e5-5e9d-4221-ac7a-2fc6746e4c2d",
"work_instruction_action_type_id": "50f0e617-ba27-42b2-9836-18e272baacd4",
"work_instruction_action_type": "sample string 6",
"name": "sample string 7",
"status": "sample string 8",
"date_done": "2026-09-16T11:05:11.8234744+00:00",
"remark": "sample string 10",
"advise": "sample string 11",
"sequence": 12,
"work_instruction_id": "9e4385a4-72e6-4e3f-bb32-9682a6b23f19",
"job_work_instruction_details_id": "e5db3291-7777-4838-827f-b48ffb3f0b38",
"modified_dateutc": "2026-09-16T11:05:11.8234744+00:00",
"db_file_ids": "sample string 16",
"db_report_id": "d5a807d8-2f24-4060-963f-fa91cb8a1b5c",
"parent_id": "26a005e9-3338-4c50-b406-af6a83065556",
"is_group": true,
"type": "sample string 20",
"db_report_type_id": "ab459d06-b077-48ca-91f8-6cc5703205d1",
"instruction_document_count": 22,
"show_ok": true,
"show_nok": true,
"show_replaced": true,
"show_na": true,
"db_file_id": "bbf7c9d3-d88f-4636-811b-2a6ae2d82ebd",
"work_instruction_type_id": "132b3526-1aad-4f3a-8a52-46d0298285ca",
"show_options": "sample string 29",
"is_customized": true
}
application/xml, text/xml
<job_work_instruction_list xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <advise>sample string 11</advise> <date_done>2026-09-16T11:05:11.823Z</date_done> <db_file_id>bbf7c9d3-d88f-4636-811b-2a6ae2d82ebd</db_file_id> <db_file_ids>sample string 16</db_file_ids> <db_report_id>d5a807d8-2f24-4060-963f-fa91cb8a1b5c</db_report_id> <db_report_type_id>ab459d06-b077-48ca-91f8-6cc5703205d1</db_report_type_id> <id>e475e7c6-63a5-4609-9517-f3a68781f866</id> <instruction_document_count>22</instruction_document_count> <is_customized>true</is_customized> <is_group>true</is_group> <job_work_instruction_details_id>e5db3291-7777-4838-827f-b48ffb3f0b38</job_work_instruction_details_id> <jobs_id>982bfd0f-7c98-45d7-a738-b5e94c3c05bb</jobs_id> <modified_dateutc>2026-09-16T11:05:11.823Z</modified_dateutc> <name>sample string 7</name> <parent_id>26a005e9-3338-4c50-b406-af6a83065556</parent_id> <remark>sample string 10</remark> <sequence>12</sequence> <show_na>true</show_na> <show_nok>true</show_nok> <show_ok>true</show_ok> <show_options>sample string 29</show_options> <show_replaced>true</show_replaced> <status>sample string 8</status> <type>sample string 20</type> <user_id>8074c3e5-5e9d-4221-ac7a-2fc6746e4c2d</user_id> <work_instruction_action_type>sample string 6</work_instruction_action_type> <work_instruction_action_type_id>50f0e617-ba27-42b2-9836-18e272baacd4</work_instruction_action_type_id> <work_instruction_details_id>a9422c49-a4eb-46bc-95d4-9a8d50c919b2</work_instruction_details_id> <work_instruction_id>9e4385a4-72e6-4e3f-bb32-9682a6b23f19</work_instruction_id> <work_instruction_type_id>132b3526-1aad-4f3a-8a52-46d0298285ca</work_instruction_type_id> </job_work_instruction_list>