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": "859044e6-487c-4458-b9aa-eeef7f4d13aa",
"jobs_id": "62cc5a9c-603f-4916-b437-df21b27bba3d",
"work_instruction_details_id": "4d1e26a2-e431-44e3-bdbc-fa5fdaa1b367",
"user_id": "c336e6e5-9cca-47b5-b85f-18ae55724f98",
"work_instruction_action_type_id": "36395c85-be6c-4afc-ab10-1bb6e510b1af",
"work_instruction_action_type": "sample string 6",
"name": "sample string 7",
"status": "sample string 8",
"date_done": "2026-11-12T14:28:40.2757525+00:00",
"remark": "sample string 10",
"advise": "sample string 11",
"sequence": 12,
"work_instruction_id": "02836170-5a39-4fd9-9c87-b35f9e71f2ef",
"job_work_instruction_details_id": "1a8e7755-e405-46ef-bf93-23a2ab45d1e9",
"modified_dateutc": "2026-11-12T14:28:40.2757525+00:00",
"db_file_ids": "sample string 16",
"db_report_id": "f7117ae2-d4d9-41c2-aad4-319252151f5f",
"parent_id": "f2cbe0fc-4171-4463-8510-7d0ecf81171b",
"is_group": true,
"type": "sample string 20",
"db_report_type_id": "490f7d6a-30ed-4eff-aa4f-64e1b48c6b0b",
"instruction_document_count": 22,
"show_ok": true,
"show_nok": true,
"show_replaced": true,
"show_na": true,
"db_file_id": "36430634-1ec9-468b-b285-c0ad004dac32",
"work_instruction_type_id": "a6c2d25d-6cb6-4617-8563-107b1abafc43",
"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-11-12T14:28:40.275Z</date_done> <db_file_id>36430634-1ec9-468b-b285-c0ad004dac32</db_file_id> <db_file_ids>sample string 16</db_file_ids> <db_report_id>f7117ae2-d4d9-41c2-aad4-319252151f5f</db_report_id> <db_report_type_id>490f7d6a-30ed-4eff-aa4f-64e1b48c6b0b</db_report_type_id> <id>859044e6-487c-4458-b9aa-eeef7f4d13aa</id> <instruction_document_count>22</instruction_document_count> <is_customized>true</is_customized> <is_group>true</is_group> <job_work_instruction_details_id>1a8e7755-e405-46ef-bf93-23a2ab45d1e9</job_work_instruction_details_id> <jobs_id>62cc5a9c-603f-4916-b437-df21b27bba3d</jobs_id> <modified_dateutc>2026-11-12T14:28:40.275Z</modified_dateutc> <name>sample string 7</name> <parent_id>f2cbe0fc-4171-4463-8510-7d0ecf81171b</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>c336e6e5-9cca-47b5-b85f-18ae55724f98</user_id> <work_instruction_action_type>sample string 6</work_instruction_action_type> <work_instruction_action_type_id>36395c85-be6c-4afc-ab10-1bb6e510b1af</work_instruction_action_type_id> <work_instruction_details_id>4d1e26a2-e431-44e3-bdbc-fa5fdaa1b367</work_instruction_details_id> <work_instruction_id>02836170-5a39-4fd9-9c87-b35f9e71f2ef</work_instruction_id> <work_instruction_type_id>a6c2d25d-6cb6-4617-8563-107b1abafc43</work_instruction_type_id> </job_work_instruction_list>