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": "fa34e964-85c6-482b-89a6-a7c029f961ad",
"jobs_id": "2aa017c8-e0af-44a5-b078-efa01cf65e42",
"work_instruction_details_id": "e6b36fde-9d5d-4e07-bcbc-3ee4cc1e7418",
"user_id": "5e6db561-869b-4d24-bc2b-7a6b82bb995c",
"work_instruction_action_type_id": "e8815993-8d62-4880-968c-d5430a4e2bd5",
"work_instruction_action_type": "sample string 6",
"name": "sample string 7",
"status": "sample string 8",
"date_done": "2026-09-16T10:12:54.1482978+00:00",
"remark": "sample string 10",
"advise": "sample string 11",
"sequence": 12,
"work_instruction_id": "23ea1fb7-28df-4b67-bb86-657c040cb820",
"job_work_instruction_details_id": "723d649e-b7da-412e-a0a8-afdf14446778",
"modified_dateutc": "2026-09-16T10:12:54.1658482+00:00",
"db_file_ids": "sample string 16",
"db_report_id": "0f8c1d78-afd5-4157-ba0a-6fdb25ca5fca",
"parent_id": "e041ef43-0803-4579-be83-8c77af346ae9",
"is_group": true,
"type": "sample string 20",
"db_report_type_id": "a3bbe01e-e209-4ec3-8459-bfe5f7503c86",
"instruction_document_count": 22,
"show_ok": true,
"show_nok": true,
"show_replaced": true,
"show_na": true,
"db_file_id": "69d1d9bd-7e4f-431d-8e7a-3c65a4a9b9d9",
"work_instruction_type_id": "41d95768-c2aa-42c3-b7d0-a179c972e28f",
"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:12:54.148Z</date_done> <db_file_id>69d1d9bd-7e4f-431d-8e7a-3c65a4a9b9d9</db_file_id> <db_file_ids>sample string 16</db_file_ids> <db_report_id>0f8c1d78-afd5-4157-ba0a-6fdb25ca5fca</db_report_id> <db_report_type_id>a3bbe01e-e209-4ec3-8459-bfe5f7503c86</db_report_type_id> <id>fa34e964-85c6-482b-89a6-a7c029f961ad</id> <instruction_document_count>22</instruction_document_count> <is_customized>true</is_customized> <is_group>true</is_group> <job_work_instruction_details_id>723d649e-b7da-412e-a0a8-afdf14446778</job_work_instruction_details_id> <jobs_id>2aa017c8-e0af-44a5-b078-efa01cf65e42</jobs_id> <modified_dateutc>2026-09-16T10:12:54.165Z</modified_dateutc> <name>sample string 7</name> <parent_id>e041ef43-0803-4579-be83-8c77af346ae9</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>5e6db561-869b-4d24-bc2b-7a6b82bb995c</user_id> <work_instruction_action_type>sample string 6</work_instruction_action_type> <work_instruction_action_type_id>e8815993-8d62-4880-968c-d5430a4e2bd5</work_instruction_action_type_id> <work_instruction_details_id>e6b36fde-9d5d-4e07-bcbc-3ee4cc1e7418</work_instruction_details_id> <work_instruction_id>23ea1fb7-28df-4b67-bb86-657c040cb820</work_instruction_id> <work_instruction_type_id>41d95768-c2aa-42c3-b7d0-a179c972e28f</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": "d4ccaf6d-84d2-42f2-9bfb-4799acf0abdb",
"jobs_id": "049a1eda-f7b7-430c-b766-516ec8cc3d66",
"work_instruction_details_id": "65b93cc7-f647-4013-a2b3-cc5e4e3cdc34",
"user_id": "cfc33e61-e3b5-43cd-a101-c6fe5b6f84dc",
"work_instruction_action_type_id": "a77e0306-2657-40c4-9cc4-7fbbc60b9613",
"work_instruction_action_type": "sample string 6",
"name": "sample string 7",
"status": "sample string 8",
"date_done": "2026-09-16T10:12:54.2143724+00:00",
"remark": "sample string 10",
"advise": "sample string 11",
"sequence": 12,
"work_instruction_id": "ee643f75-4f17-4baf-a455-2737949e995d",
"job_work_instruction_details_id": "36e37298-d0fb-48e4-9c2e-b6fb60557525",
"modified_dateutc": "2026-09-16T10:12:54.2143724+00:00",
"db_file_ids": "sample string 16",
"db_report_id": "8e866932-781c-4562-8145-a31790f65d12",
"parent_id": "369364f7-7684-4618-bee9-e4b5034a7926",
"is_group": true,
"type": "sample string 20",
"db_report_type_id": "c7214c15-676c-4067-bb98-37d91dc0828a",
"instruction_document_count": 22,
"show_ok": true,
"show_nok": true,
"show_replaced": true,
"show_na": true,
"db_file_id": "730c253a-289e-4d02-84f0-c23da36727a4",
"work_instruction_type_id": "13571cc8-a330-4867-83c2-1ba8fc8bd838",
"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:12:54.214Z</date_done> <db_file_id>730c253a-289e-4d02-84f0-c23da36727a4</db_file_id> <db_file_ids>sample string 16</db_file_ids> <db_report_id>8e866932-781c-4562-8145-a31790f65d12</db_report_id> <db_report_type_id>c7214c15-676c-4067-bb98-37d91dc0828a</db_report_type_id> <id>d4ccaf6d-84d2-42f2-9bfb-4799acf0abdb</id> <instruction_document_count>22</instruction_document_count> <is_customized>true</is_customized> <is_group>true</is_group> <job_work_instruction_details_id>36e37298-d0fb-48e4-9c2e-b6fb60557525</job_work_instruction_details_id> <jobs_id>049a1eda-f7b7-430c-b766-516ec8cc3d66</jobs_id> <modified_dateutc>2026-09-16T10:12:54.214Z</modified_dateutc> <name>sample string 7</name> <parent_id>369364f7-7684-4618-bee9-e4b5034a7926</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>cfc33e61-e3b5-43cd-a101-c6fe5b6f84dc</user_id> <work_instruction_action_type>sample string 6</work_instruction_action_type> <work_instruction_action_type_id>a77e0306-2657-40c4-9cc4-7fbbc60b9613</work_instruction_action_type_id> <work_instruction_details_id>65b93cc7-f647-4013-a2b3-cc5e4e3cdc34</work_instruction_details_id> <work_instruction_id>ee643f75-4f17-4baf-a455-2737949e995d</work_instruction_id> <work_instruction_type_id>13571cc8-a330-4867-83c2-1ba8fc8bd838</work_instruction_type_id> </job_work_instruction_list>