Creates a new job work instruction checklist line.
Request Information
URI Parameters :
None.
Body Parameters :
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 |
Request Formats :
application/json, text/json
{
"id": "f544f004-9f6e-47fd-90df-e78db6d37ac4",
"jobs_id": "c6f00063-e0ea-48db-bf03-68203bca30be",
"work_instruction_details_id": "e468a58c-d960-401c-b449-884628cbdb05",
"user_id": "391549f0-cc71-441a-bf91-b57b0016cd02",
"work_instruction_action_type_id": "c07d8579-3a56-4903-bfe2-a0213cb63e00",
"work_instruction_action_type": "sample string 6",
"name": "sample string 7",
"status": "sample string 8",
"date_done": "2026-09-16T10:13:47.9417992+00:00",
"remark": "sample string 10",
"advise": "sample string 11",
"sequence": 12,
"work_instruction_id": "06f82bcc-64d3-45f2-adde-aa493b101326",
"job_work_instruction_details_id": "b4e33ebe-a85f-491a-84b7-7ab812d307af",
"modified_dateutc": "2026-09-16T10:13:47.9417992+00:00",
"db_file_ids": "sample string 16",
"db_report_id": "169edd40-7076-4546-8748-571891487dfb",
"parent_id": "0ecb16de-0fac-4528-a9b2-2440c402b915",
"is_group": true,
"type": "sample string 20",
"db_report_type_id": "f67a5ce9-5fc1-4e27-a803-b930e8de8607",
"instruction_document_count": 22,
"show_ok": true,
"show_nok": true,
"show_replaced": true,
"show_na": true,
"db_file_id": "9a8969fa-95df-4cb2-9808-087491be1c98",
"work_instruction_type_id": "949cbee6-2386-43c7-9068-a73ca3ac24bf",
"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-16T10:13:47.941Z</date_done> <db_file_id>9a8969fa-95df-4cb2-9808-087491be1c98</db_file_id> <db_file_ids>sample string 16</db_file_ids> <db_report_id>169edd40-7076-4546-8748-571891487dfb</db_report_id> <db_report_type_id>f67a5ce9-5fc1-4e27-a803-b930e8de8607</db_report_type_id> <id>f544f004-9f6e-47fd-90df-e78db6d37ac4</id> <instruction_document_count>22</instruction_document_count> <is_customized>true</is_customized> <is_group>true</is_group> <job_work_instruction_details_id>b4e33ebe-a85f-491a-84b7-7ab812d307af</job_work_instruction_details_id> <jobs_id>c6f00063-e0ea-48db-bf03-68203bca30be</jobs_id> <modified_dateutc>2026-09-16T10:13:47.941Z</modified_dateutc> <name>sample string 7</name> <parent_id>0ecb16de-0fac-4528-a9b2-2440c402b915</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>391549f0-cc71-441a-bf91-b57b0016cd02</user_id> <work_instruction_action_type>sample string 6</work_instruction_action_type> <work_instruction_action_type_id>c07d8579-3a56-4903-bfe2-a0213cb63e00</work_instruction_action_type_id> <work_instruction_details_id>e468a58c-d960-401c-b449-884628cbdb05</work_instruction_details_id> <work_instruction_id>06f82bcc-64d3-45f2-adde-aa493b101326</work_instruction_id> <work_instruction_type_id>949cbee6-2386-43c7-9068-a73ca3ac24bf</work_instruction_type_id> </job_work_instruction_list>
Response Information
Resource Description :
IHttpActionResult containing the created job work instruction checklist line.
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": "db3c7e98-8469-4749-bba2-2d88186551dd",
"jobs_id": "d4c179d8-9a1b-4f81-8562-fff31b8c1cec",
"work_instruction_details_id": "5c5608d2-ed01-46dd-b637-4a015054f21a",
"user_id": "7c537097-b003-41c3-b11b-4a58ac7e447e",
"work_instruction_action_type_id": "8f88ec64-1b95-4a6a-8334-b1e6631cf6c6",
"work_instruction_action_type": "sample string 6",
"name": "sample string 7",
"status": "sample string 8",
"date_done": "2026-09-16T10:13:47.9417992+00:00",
"remark": "sample string 10",
"advise": "sample string 11",
"sequence": 12,
"work_instruction_id": "618481e7-9ad2-41c5-bae1-bff52ce0972e",
"job_work_instruction_details_id": "68d7e7f3-3ab9-4cf4-b86a-85e474afb0e4",
"modified_dateutc": "2026-09-16T10:13:47.9417992+00:00",
"db_file_ids": "sample string 16",
"db_report_id": "2445bf9a-662d-4900-a14a-43c296cedfaf",
"parent_id": "76068a5b-f215-4584-acd2-a8f79789dfc0",
"is_group": true,
"type": "sample string 20",
"db_report_type_id": "7ce01f82-c53b-45a7-9461-61fbec305a5a",
"instruction_document_count": 22,
"show_ok": true,
"show_nok": true,
"show_replaced": true,
"show_na": true,
"db_file_id": "690799a9-ab69-4b60-a4f6-49c3c826aab5",
"work_instruction_type_id": "7817c2dd-7fcd-4e42-836c-e60df07caa9b",
"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-16T10:13:47.941Z</date_done> <db_file_id>690799a9-ab69-4b60-a4f6-49c3c826aab5</db_file_id> <db_file_ids>sample string 16</db_file_ids> <db_report_id>2445bf9a-662d-4900-a14a-43c296cedfaf</db_report_id> <db_report_type_id>7ce01f82-c53b-45a7-9461-61fbec305a5a</db_report_type_id> <id>db3c7e98-8469-4749-bba2-2d88186551dd</id> <instruction_document_count>22</instruction_document_count> <is_customized>true</is_customized> <is_group>true</is_group> <job_work_instruction_details_id>68d7e7f3-3ab9-4cf4-b86a-85e474afb0e4</job_work_instruction_details_id> <jobs_id>d4c179d8-9a1b-4f81-8562-fff31b8c1cec</jobs_id> <modified_dateutc>2026-09-16T10:13:47.941Z</modified_dateutc> <name>sample string 7</name> <parent_id>76068a5b-f215-4584-acd2-a8f79789dfc0</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>7c537097-b003-41c3-b11b-4a58ac7e447e</user_id> <work_instruction_action_type>sample string 6</work_instruction_action_type> <work_instruction_action_type_id>8f88ec64-1b95-4a6a-8334-b1e6631cf6c6</work_instruction_action_type_id> <work_instruction_details_id>5c5608d2-ed01-46dd-b637-4a015054f21a</work_instruction_details_id> <work_instruction_id>618481e7-9ad2-41c5-bae1-bff52ce0972e</work_instruction_id> <work_instruction_type_id>7817c2dd-7fcd-4e42-836c-e60df07caa9b</work_instruction_type_id> </job_work_instruction_list>