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": "d2cc3665-3db3-440e-babe-f5ede482d849",
"job_work_instruction_id": "ad5131ac-41ea-4f81-af29-0e28e971a71f",
"work_instruction_details_id": "d7611e61-814f-45b3-99eb-e30e2796aea3",
"work_instruction_action_type_id": "6473a8eb-df9d-4fb9-b6d9-adebdb683837",
"description": "sample string 5",
"sequence": 6,
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-16T10:16:17.7907315+00:00",
"parent_id": "8d6d1ee5-98c8-4530-9d14-a0eb1c6cbeee",
"is_group": true,
"is_archived": true,
"type": "sample string 12",
"db_report_type_id": "4afa837b-eb43-4713-ad97-c69e69c75fe2",
"instruction_document_count": 14,
"show_ok": true,
"show_nok": true,
"show_replaced": true,
"show_na": true,
"db_file_id": "cb44692e-fe52-4e11-abc9-5a323778506e",
"work_instruction_type_id": "f6d61f4c-d37d-40d3-9adb-590b88cd9897",
"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>cb44692e-fe52-4e11-abc9-5a323778506e</db_file_id> <db_report_type_id>4afa837b-eb43-4713-ad97-c69e69c75fe2</db_report_type_id> <description>sample string 5</description> <id>d2cc3665-3db3-440e-babe-f5ede482d849</id> <instruction_document_count>14</instruction_document_count> <is_archived>true</is_archived> <is_group>true</is_group> <job_work_instruction_id>ad5131ac-41ea-4f81-af29-0e28e971a71f</job_work_instruction_id> <modified_dateutc>2026-09-16T10:16:17.790Z</modified_dateutc> <parent_id>8d6d1ee5-98c8-4530-9d14-a0eb1c6cbeee</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>6473a8eb-df9d-4fb9-b6d9-adebdb683837</work_instruction_action_type_id> <work_instruction_details_id>d7611e61-814f-45b3-99eb-e30e2796aea3</work_instruction_details_id> <work_instruction_type_id>f6d61f4c-d37d-40d3-9adb-590b88cd9897</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": "c37a4f90-12c0-4f2d-903e-16c3053a221f",
"job_work_instruction_id": "4b31cc9d-1036-436d-ab54-d1e2f229a85b",
"work_instruction_details_id": "e2e21f2c-b7d9-44cb-84d3-d130a2aac74b",
"work_instruction_action_type_id": "8d52b219-1f79-48c6-aede-920db2726b58",
"description": "sample string 5",
"sequence": 6,
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-16T10:16:17.7907315+00:00",
"parent_id": "8f2d8bb0-67d8-443d-bc72-d3bd6d5a279e",
"is_group": true,
"is_archived": true,
"type": "sample string 12",
"db_report_type_id": "4cce468f-baef-4e16-94b9-0fe2cae3ed0b",
"instruction_document_count": 14,
"show_ok": true,
"show_nok": true,
"show_replaced": true,
"show_na": true,
"db_file_id": "65e49278-039b-476c-a35e-e586c68666b5",
"work_instruction_type_id": "ddf7c502-8c2f-4613-9bc6-dc53d2b3684b",
"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>65e49278-039b-476c-a35e-e586c68666b5</db_file_id> <db_report_type_id>4cce468f-baef-4e16-94b9-0fe2cae3ed0b</db_report_type_id> <description>sample string 5</description> <id>c37a4f90-12c0-4f2d-903e-16c3053a221f</id> <instruction_document_count>14</instruction_document_count> <is_archived>true</is_archived> <is_group>true</is_group> <job_work_instruction_id>4b31cc9d-1036-436d-ab54-d1e2f229a85b</job_work_instruction_id> <modified_dateutc>2026-09-16T10:16:17.790Z</modified_dateutc> <parent_id>8f2d8bb0-67d8-443d-bc72-d3bd6d5a279e</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>8d52b219-1f79-48c6-aede-920db2726b58</work_instruction_action_type_id> <work_instruction_details_id>e2e21f2c-b7d9-44cb-84d3-d130a2aac74b</work_instruction_details_id> <work_instruction_type_id>ddf7c502-8c2f-4613-9bc6-dc53d2b3684b</work_instruction_type_id> </job_work_instruction_details>