Creates or updates multiple job work instruction checklist lines in one call.
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": "71df3db0-0cac-4431-913a-d6a7d5cdfffe",
"jobs_id": "278bec89-5bf3-4e9e-8655-d674d76396f7",
"work_instruction_details_id": "11ea0110-c4bc-4c42-b836-23a48b177bdf",
"user_id": "97f36f12-b13a-4c0d-8ee5-5dda5b8d1a09",
"work_instruction_action_type_id": "ed2074ad-0bc9-4532-be29-e4ec9e646368",
"work_instruction_action_type": "sample string 6",
"name": "sample string 7",
"status": "sample string 8",
"date_done": "2026-11-12T14:27:35.6653729+00:00",
"remark": "sample string 10",
"advise": "sample string 11",
"sequence": 12,
"work_instruction_id": "65627121-d200-4614-ae88-b61fc9bf80eb",
"job_work_instruction_details_id": "a8f76a9c-c470-4024-a1a0-910638260ffb",
"modified_dateutc": "2026-11-12T14:27:35.6653729+00:00",
"db_file_ids": "sample string 16",
"db_report_id": "6a351beb-d417-4a79-bda9-d6be5848ff91",
"parent_id": "32f103f4-61d3-4e94-8aca-c5cc1a7e69a4",
"is_group": true,
"type": "sample string 20",
"db_report_type_id": "62f7952c-e494-4cb8-b969-e4383d54e467",
"instruction_document_count": 22,
"show_ok": true,
"show_nok": true,
"show_replaced": true,
"show_na": true,
"db_file_id": "6f082b0d-2b39-4d41-ba8d-e64c4018c5e0",
"work_instruction_type_id": "f3bac51c-64af-4d7c-92f8-1b2f4dc8be09",
"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:35.665Z</date_done> <db_file_id>6f082b0d-2b39-4d41-ba8d-e64c4018c5e0</db_file_id> <db_file_ids>sample string 16</db_file_ids> <db_report_id>6a351beb-d417-4a79-bda9-d6be5848ff91</db_report_id> <db_report_type_id>62f7952c-e494-4cb8-b969-e4383d54e467</db_report_type_id> <id>71df3db0-0cac-4431-913a-d6a7d5cdfffe</id> <instruction_document_count>22</instruction_document_count> <is_customized>true</is_customized> <is_group>true</is_group> <job_work_instruction_details_id>a8f76a9c-c470-4024-a1a0-910638260ffb</job_work_instruction_details_id> <jobs_id>278bec89-5bf3-4e9e-8655-d674d76396f7</jobs_id> <modified_dateutc>2026-11-12T14:27:35.665Z</modified_dateutc> <name>sample string 7</name> <parent_id>32f103f4-61d3-4e94-8aca-c5cc1a7e69a4</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>97f36f12-b13a-4c0d-8ee5-5dda5b8d1a09</user_id> <work_instruction_action_type>sample string 6</work_instruction_action_type> <work_instruction_action_type_id>ed2074ad-0bc9-4532-be29-e4ec9e646368</work_instruction_action_type_id> <work_instruction_details_id>11ea0110-c4bc-4c42-b836-23a48b177bdf</work_instruction_details_id> <work_instruction_id>65627121-d200-4614-ae88-b61fc9bf80eb</work_instruction_id> <work_instruction_type_id>f3bac51c-64af-4d7c-92f8-1b2f4dc8be09</work_instruction_type_id> </job_work_instruction_list>
Response Information
Resource Description :
IHttpActionResult containing the batch save result, or 200 OK with no body if the array was empty.
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": "569cb49e-6dbf-47e7-b868-fa1e0044a522",
"jobs_id": "acd41686-9a11-4716-8dd2-8cf28271b059",
"work_instruction_details_id": "7d5af78f-47cd-48d0-912a-b2e21444d80e",
"user_id": "4e9f21c7-45fe-4b52-9dab-65cafefcb044",
"work_instruction_action_type_id": "013ca9e2-0454-4b0d-a8dd-5053568263b3",
"work_instruction_action_type": "sample string 6",
"name": "sample string 7",
"status": "sample string 8",
"date_done": "2026-11-12T14:27:35.6653729+00:00",
"remark": "sample string 10",
"advise": "sample string 11",
"sequence": 12,
"work_instruction_id": "93e98ce4-fa7a-47db-89e9-d17fd324c82e",
"job_work_instruction_details_id": "dd1e5b20-99e6-48e0-ba48-a4e50542641d",
"modified_dateutc": "2026-11-12T14:27:35.6653729+00:00",
"db_file_ids": "sample string 16",
"db_report_id": "0c2479a0-b3ad-40df-960e-bd37baa241a3",
"parent_id": "bff6adf4-da52-4b73-9a54-b9539fcb68cb",
"is_group": true,
"type": "sample string 20",
"db_report_type_id": "64c1bad6-c72a-4ae8-9f3a-dd2f2c9c1641",
"instruction_document_count": 22,
"show_ok": true,
"show_nok": true,
"show_replaced": true,
"show_na": true,
"db_file_id": "6869de4e-91a8-4aa1-ba8c-6cf30dda17c4",
"work_instruction_type_id": "1622bf29-a699-46c9-99c2-7522771e564f",
"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:35.665Z</date_done> <db_file_id>6869de4e-91a8-4aa1-ba8c-6cf30dda17c4</db_file_id> <db_file_ids>sample string 16</db_file_ids> <db_report_id>0c2479a0-b3ad-40df-960e-bd37baa241a3</db_report_id> <db_report_type_id>64c1bad6-c72a-4ae8-9f3a-dd2f2c9c1641</db_report_type_id> <id>569cb49e-6dbf-47e7-b868-fa1e0044a522</id> <instruction_document_count>22</instruction_document_count> <is_customized>true</is_customized> <is_group>true</is_group> <job_work_instruction_details_id>dd1e5b20-99e6-48e0-ba48-a4e50542641d</job_work_instruction_details_id> <jobs_id>acd41686-9a11-4716-8dd2-8cf28271b059</jobs_id> <modified_dateutc>2026-11-12T14:27:35.665Z</modified_dateutc> <name>sample string 7</name> <parent_id>bff6adf4-da52-4b73-9a54-b9539fcb68cb</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>4e9f21c7-45fe-4b52-9dab-65cafefcb044</user_id> <work_instruction_action_type>sample string 6</work_instruction_action_type> <work_instruction_action_type_id>013ca9e2-0454-4b0d-a8dd-5053568263b3</work_instruction_action_type_id> <work_instruction_details_id>7d5af78f-47cd-48d0-912a-b2e21444d80e</work_instruction_details_id> <work_instruction_id>93e98ce4-fa7a-47db-89e9-d17fd324c82e</work_instruction_id> <work_instruction_type_id>1622bf29-a699-46c9-99c2-7522771e564f</work_instruction_type_id> </job_work_instruction_list>