Creates a new job work instruction detail.
Request Information
URI Parameters :
None.
Body Parameters :
job_work_instruction_details| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Primary Key |
globally unique identifier | |
| job_work_instruction_id |
Ref job workinstuction |
globally unique identifier | |
| work_instruction_details_id |
Ref work instruction details |
globally unique identifier | |
| work_instruction_action_type_id |
Ref work instruction type |
globally unique identifier | |
| description |
Description |
string | |
| sequence |
Sequence |
integer | |
| reference_back_office |
Ref back office |
string | |
| modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date | |
| parent_id |
Parent id |
globally unique identifier | |
| is_group |
is_group flag |
boolean | |
| is_archived |
is_archived flag |
boolean | |
| type |
Kind of checklist step this represents (e.g. a simple check vs a measurement step), controlling how it is rendered. |
string | |
| db_report_type_id |
Foreign key of the report type to use when this step requires filling in a report. |
globally unique identifier | |
| instruction_document_count |
Number of reference documents attached to this instruction step. |
integer | |
| show_ok |
Indicates the "OK" outcome option is offered to the technician for this step. |
boolean | |
| show_nok |
Indicates the "Not OK" outcome option is offered to the technician for this step. |
boolean | |
| show_replaced |
Indicates the "Replaced" outcome option is offered to the technician for this step. |
boolean | |
| show_na |
Indicates the "Not Applicable" outcome option is offered to the technician for this step. |
boolean | |
| db_file_id |
Foreign key of a reference file/document attached to this instruction step. |
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 |
Request Formats :
application/json, text/json
{
"id": "b0d69a58-f7ef-4598-8621-5875c23a1894",
"job_work_instruction_id": "c1bdefbe-f9c7-46d5-bcf2-a0324ad04d44",
"work_instruction_details_id": "db7b56d8-1ca7-4162-b7ca-61fa9e638b17",
"work_instruction_action_type_id": "8f447873-83dd-4e1e-ba22-64ff82019971",
"description": "sample string 5",
"sequence": 6,
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-11-12T14:28:35.9319382+00:00",
"parent_id": "331b5216-0891-4a09-833d-89e4fa164d79",
"is_group": true,
"is_archived": true,
"type": "sample string 12",
"db_report_type_id": "a89953f8-c27a-4409-b8ce-24da13cef233",
"instruction_document_count": 14,
"show_ok": true,
"show_nok": true,
"show_replaced": true,
"show_na": true,
"db_file_id": "ada600a1-10bc-43e3-8474-04739852b21d",
"work_instruction_type_id": "b2c75f43-1aeb-477c-a711-63cda8754614",
"show_options": "sample string 21"
}
application/xml, text/xml
<job_work_instruction_details xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <db_file_id>ada600a1-10bc-43e3-8474-04739852b21d</db_file_id> <db_report_type_id>a89953f8-c27a-4409-b8ce-24da13cef233</db_report_type_id> <description>sample string 5</description> <id>b0d69a58-f7ef-4598-8621-5875c23a1894</id> <instruction_document_count>14</instruction_document_count> <is_archived>true</is_archived> <is_group>true</is_group> <job_work_instruction_id>c1bdefbe-f9c7-46d5-bcf2-a0324ad04d44</job_work_instruction_id> <modified_dateutc>2026-11-12T14:28:35.931Z</modified_dateutc> <parent_id>331b5216-0891-4a09-833d-89e4fa164d79</parent_id> <reference_back_office>sample string 7</reference_back_office> <sequence>6</sequence> <show_na>true</show_na> <show_nok>true</show_nok> <show_ok>true</show_ok> <show_options>sample string 21</show_options> <show_replaced>true</show_replaced> <type>sample string 12</type> <work_instruction_action_type_id>8f447873-83dd-4e1e-ba22-64ff82019971</work_instruction_action_type_id> <work_instruction_details_id>db7b56d8-1ca7-4162-b7ca-61fa9e638b17</work_instruction_details_id> <work_instruction_type_id>b2c75f43-1aeb-477c-a711-63cda8754614</work_instruction_type_id> </job_work_instruction_details>
Response Information
Resource Description :
IHttpActionResult containing the created job work instruction detail.
job_work_instruction_details| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Primary Key |
globally unique identifier | |
| job_work_instruction_id |
Ref job workinstuction |
globally unique identifier | |
| work_instruction_details_id |
Ref work instruction details |
globally unique identifier | |
| work_instruction_action_type_id |
Ref work instruction type |
globally unique identifier | |
| description |
Description |
string | |
| sequence |
Sequence |
integer | |
| reference_back_office |
Ref back office |
string | |
| modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date | |
| parent_id |
Parent id |
globally unique identifier | |
| is_group |
is_group flag |
boolean | |
| is_archived |
is_archived flag |
boolean | |
| type |
Kind of checklist step this represents (e.g. a simple check vs a measurement step), controlling how it is rendered. |
string | |
| db_report_type_id |
Foreign key of the report type to use when this step requires filling in a report. |
globally unique identifier | |
| instruction_document_count |
Number of reference documents attached to this instruction step. |
integer | |
| show_ok |
Indicates the "OK" outcome option is offered to the technician for this step. |
boolean | |
| show_nok |
Indicates the "Not OK" outcome option is offered to the technician for this step. |
boolean | |
| show_replaced |
Indicates the "Replaced" outcome option is offered to the technician for this step. |
boolean | |
| show_na |
Indicates the "Not Applicable" outcome option is offered to the technician for this step. |
boolean | |
| db_file_id |
Foreign key of a reference file/document attached to this instruction step. |
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 |
Response Formats
application/json, text/json
{
"id": "ac79a8ff-8abb-4215-92ff-d891297ee714",
"job_work_instruction_id": "bb345f80-e2fa-465c-811c-94905bf5c402",
"work_instruction_details_id": "48b82914-896e-466c-9b68-6d768cb39030",
"work_instruction_action_type_id": "f8578812-521b-4311-af2d-0a526b434b56",
"description": "sample string 5",
"sequence": 6,
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-11-12T14:28:35.9319382+00:00",
"parent_id": "69ac2680-f77a-49f8-a991-938293401abf",
"is_group": true,
"is_archived": true,
"type": "sample string 12",
"db_report_type_id": "20e3428d-4291-479f-a8d0-88042a4a868a",
"instruction_document_count": 14,
"show_ok": true,
"show_nok": true,
"show_replaced": true,
"show_na": true,
"db_file_id": "0739d38f-7082-468a-b953-b0098a7a6047",
"work_instruction_type_id": "547eb82a-845f-4d4a-9bcc-1882da8f99b7",
"show_options": "sample string 21"
}
application/xml, text/xml
<job_work_instruction_details xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <db_file_id>0739d38f-7082-468a-b953-b0098a7a6047</db_file_id> <db_report_type_id>20e3428d-4291-479f-a8d0-88042a4a868a</db_report_type_id> <description>sample string 5</description> <id>ac79a8ff-8abb-4215-92ff-d891297ee714</id> <instruction_document_count>14</instruction_document_count> <is_archived>true</is_archived> <is_group>true</is_group> <job_work_instruction_id>bb345f80-e2fa-465c-811c-94905bf5c402</job_work_instruction_id> <modified_dateutc>2026-11-12T14:28:35.931Z</modified_dateutc> <parent_id>69ac2680-f77a-49f8-a991-938293401abf</parent_id> <reference_back_office>sample string 7</reference_back_office> <sequence>6</sequence> <show_na>true</show_na> <show_nok>true</show_nok> <show_ok>true</show_ok> <show_options>sample string 21</show_options> <show_replaced>true</show_replaced> <type>sample string 12</type> <work_instruction_action_type_id>f8578812-521b-4311-af2d-0a526b434b56</work_instruction_action_type_id> <work_instruction_details_id>48b82914-896e-466c-9b68-6d768cb39030</work_instruction_details_id> <work_instruction_type_id>547eb82a-845f-4d4a-9bcc-1882da8f99b7</work_instruction_type_id> </job_work_instruction_details>