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": "7b35291e-f90f-4a65-a40a-b5458dd8ae47",
"jobs_id": "b54e034d-16f7-487b-a68f-1ae541b29aa9",
"work_instruction_details_id": "f99172ab-2bd2-4277-81ab-5cbe01cb5419",
"user_id": "cbf66fcb-5157-4c15-ab37-2a6ded0e0f7e",
"work_instruction_action_type_id": "62ccc1cb-c90d-4294-9e37-366ba8fd27f6",
"work_instruction_action_type": "sample string 6",
"name": "sample string 7",
"status": "sample string 8",
"date_done": "2026-11-12T14:27:57.1657093+00:00",
"remark": "sample string 10",
"advise": "sample string 11",
"sequence": 12,
"work_instruction_id": "0b18211c-4d6e-4dcc-80f5-7a37b1d70dd3",
"job_work_instruction_details_id": "ff874fb5-d06c-4d3c-9a27-acd18492fd13",
"modified_dateutc": "2026-11-12T14:27:57.1657093+00:00",
"db_file_ids": "sample string 16",
"db_report_id": "440c0f8a-42ba-44ff-a7d7-f1f66841a7aa",
"parent_id": "a9f8cf2d-2c66-4d1c-891a-6bf9428273bf",
"is_group": true,
"type": "sample string 20",
"db_report_type_id": "9a30689b-1d9b-4074-bd9d-cfe50a7ab05a",
"instruction_document_count": 22,
"show_ok": true,
"show_nok": true,
"show_replaced": true,
"show_na": true,
"db_file_id": "e0483f3c-c682-46a0-8a17-697a709ebc70",
"work_instruction_type_id": "abcca452-e5e0-4773-ac2e-59a01a8344f2",
"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:27:57.165Z</date_done> <db_file_id>e0483f3c-c682-46a0-8a17-697a709ebc70</db_file_id> <db_file_ids>sample string 16</db_file_ids> <db_report_id>440c0f8a-42ba-44ff-a7d7-f1f66841a7aa</db_report_id> <db_report_type_id>9a30689b-1d9b-4074-bd9d-cfe50a7ab05a</db_report_type_id> <id>7b35291e-f90f-4a65-a40a-b5458dd8ae47</id> <instruction_document_count>22</instruction_document_count> <is_customized>true</is_customized> <is_group>true</is_group> <job_work_instruction_details_id>ff874fb5-d06c-4d3c-9a27-acd18492fd13</job_work_instruction_details_id> <jobs_id>b54e034d-16f7-487b-a68f-1ae541b29aa9</jobs_id> <modified_dateutc>2026-11-12T14:27:57.165Z</modified_dateutc> <name>sample string 7</name> <parent_id>a9f8cf2d-2c66-4d1c-891a-6bf9428273bf</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>cbf66fcb-5157-4c15-ab37-2a6ded0e0f7e</user_id> <work_instruction_action_type>sample string 6</work_instruction_action_type> <work_instruction_action_type_id>62ccc1cb-c90d-4294-9e37-366ba8fd27f6</work_instruction_action_type_id> <work_instruction_details_id>f99172ab-2bd2-4277-81ab-5cbe01cb5419</work_instruction_details_id> <work_instruction_id>0b18211c-4d6e-4dcc-80f5-7a37b1d70dd3</work_instruction_id> <work_instruction_type_id>abcca452-e5e0-4773-ac2e-59a01a8344f2</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": "1f725231-a844-432e-8bb2-f6479ba5ccba",
"jobs_id": "7e61fc03-b05e-4000-b57a-fdca7eb63cb7",
"work_instruction_details_id": "f432ea72-98ad-4827-b329-861b7c2d9a02",
"user_id": "bc06d2a5-8bdc-42d4-9f56-ba36d17aea2c",
"work_instruction_action_type_id": "35d4e18a-e9d4-4a02-9f45-82366803fb38",
"work_instruction_action_type": "sample string 6",
"name": "sample string 7",
"status": "sample string 8",
"date_done": "2026-11-12T14:27:57.1657093+00:00",
"remark": "sample string 10",
"advise": "sample string 11",
"sequence": 12,
"work_instruction_id": "787c3399-aa5f-47ec-a6ac-47862f3c09d5",
"job_work_instruction_details_id": "78144755-989f-429e-893d-9bd51ceaef76",
"modified_dateutc": "2026-11-12T14:27:57.1657093+00:00",
"db_file_ids": "sample string 16",
"db_report_id": "d46a81d3-7563-4a91-bac9-638f1cd070af",
"parent_id": "1e108667-bfd6-48d5-854d-37f1b29a94ba",
"is_group": true,
"type": "sample string 20",
"db_report_type_id": "dd3b749d-8c64-4a52-8d8b-a2a07b7d5912",
"instruction_document_count": 22,
"show_ok": true,
"show_nok": true,
"show_replaced": true,
"show_na": true,
"db_file_id": "aa9cb845-c7e8-484c-89e4-40559d8753b1",
"work_instruction_type_id": "1c55dcc9-5ea4-4cd9-9152-0e50ffe74f7d",
"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:27:57.165Z</date_done> <db_file_id>aa9cb845-c7e8-484c-89e4-40559d8753b1</db_file_id> <db_file_ids>sample string 16</db_file_ids> <db_report_id>d46a81d3-7563-4a91-bac9-638f1cd070af</db_report_id> <db_report_type_id>dd3b749d-8c64-4a52-8d8b-a2a07b7d5912</db_report_type_id> <id>1f725231-a844-432e-8bb2-f6479ba5ccba</id> <instruction_document_count>22</instruction_document_count> <is_customized>true</is_customized> <is_group>true</is_group> <job_work_instruction_details_id>78144755-989f-429e-893d-9bd51ceaef76</job_work_instruction_details_id> <jobs_id>7e61fc03-b05e-4000-b57a-fdca7eb63cb7</jobs_id> <modified_dateutc>2026-11-12T14:27:57.165Z</modified_dateutc> <name>sample string 7</name> <parent_id>1e108667-bfd6-48d5-854d-37f1b29a94ba</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>bc06d2a5-8bdc-42d4-9f56-ba36d17aea2c</user_id> <work_instruction_action_type>sample string 6</work_instruction_action_type> <work_instruction_action_type_id>35d4e18a-e9d4-4a02-9f45-82366803fb38</work_instruction_action_type_id> <work_instruction_details_id>f432ea72-98ad-4827-b329-861b7c2d9a02</work_instruction_details_id> <work_instruction_id>787c3399-aa5f-47ec-a6ac-47862f3c09d5</work_instruction_id> <work_instruction_type_id>1c55dcc9-5ea4-4cd9-9152-0e50ffe74f7d</work_instruction_type_id> </job_work_instruction_list>