Updates the job work instruction checklist line with the specified key.

Request Information

URI Parameters :

NameDescriptionTypeAdditional information
id

The job work instruction checklist line id.

 globally unique identifier

Required

Body Parameters :

job_work_instruction_list
NameDescriptionTypeAdditional 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

Sample: 
{
  "id": "1050032d-f6ee-405c-a463-f88b4ddf98a4",
  "jobs_id": "d9546bde-a859-46bc-a77e-7925e7d9ea0e",
  "work_instruction_details_id": "10c624c2-3781-45af-9fbc-ae3608c05e40",
  "user_id": "c996f902-b7cf-47c6-9656-a5d9a0f5fd50",
  "work_instruction_action_type_id": "1d2f98de-be4d-4598-8a2b-05f4b4e62137",
  "work_instruction_action_type": "sample string 6",
  "name": "sample string 7",
  "status": "sample string 8",
  "date_done": "2026-09-16T10:16:32.7290957+00:00",
  "remark": "sample string 10",
  "advise": "sample string 11",
  "sequence": 12,
  "work_instruction_id": "816a607f-14a3-4cad-a50c-0e411ce090e3",
  "job_work_instruction_details_id": "ccb274ed-cfdb-4cfe-876b-eac9f24effc9",
  "modified_dateutc": "2026-09-16T10:16:32.7290957+00:00",
  "db_file_ids": "sample string 16",
  "db_report_id": "3edb8e30-4299-47ef-8c03-d22d72ee3972",
  "parent_id": "bc3bfad7-8b23-46cc-9d40-ca0332eba502",
  "is_group": true,
  "type": "sample string 20",
  "db_report_type_id": "da789ad3-fb35-4548-b8d9-5b7d6d4a545f",
  "instruction_document_count": 22,
  "show_ok": true,
  "show_nok": true,
  "show_replaced": true,
  "show_na": true,
  "db_file_id": "fd171330-1ff7-4e85-9dd1-e0cea2975873",
  "work_instruction_type_id": "553f96c5-6d23-42ce-aad4-0fcf1a872bea",
  "show_options": "sample string 29",
  "is_customized": true
}

application/xml, text/xml

Sample: 
<job_work_instruction_list xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <advise>sample string 11</advise>
  <date_done>2026-09-16T10:16:32.729Z</date_done>
  <db_file_id>fd171330-1ff7-4e85-9dd1-e0cea2975873</db_file_id>
  <db_file_ids>sample string 16</db_file_ids>
  <db_report_id>3edb8e30-4299-47ef-8c03-d22d72ee3972</db_report_id>
  <db_report_type_id>da789ad3-fb35-4548-b8d9-5b7d6d4a545f</db_report_type_id>
  <id>1050032d-f6ee-405c-a463-f88b4ddf98a4</id>
  <instruction_document_count>22</instruction_document_count>
  <is_customized>true</is_customized>
  <is_group>true</is_group>
  <job_work_instruction_details_id>ccb274ed-cfdb-4cfe-876b-eac9f24effc9</job_work_instruction_details_id>
  <jobs_id>d9546bde-a859-46bc-a77e-7925e7d9ea0e</jobs_id>
  <modified_dateutc>2026-09-16T10:16:32.729Z</modified_dateutc>
  <name>sample string 7</name>
  <parent_id>bc3bfad7-8b23-46cc-9d40-ca0332eba502</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>c996f902-b7cf-47c6-9656-a5d9a0f5fd50</user_id>
  <work_instruction_action_type>sample string 6</work_instruction_action_type>
  <work_instruction_action_type_id>1d2f98de-be4d-4598-8a2b-05f4b4e62137</work_instruction_action_type_id>
  <work_instruction_details_id>10c624c2-3781-45af-9fbc-ae3608c05e40</work_instruction_details_id>
  <work_instruction_id>816a607f-14a3-4cad-a50c-0e411ce090e3</work_instruction_id>
  <work_instruction_type_id>553f96c5-6d23-42ce-aad4-0fcf1a872bea</work_instruction_type_id>
</job_work_instruction_list>

Response Information

Resource Description :

IHttpActionResult containing the updated job work instruction checklist line.

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.