Routes
Tasks
Instructions
Task Instructions
Changed onThis request gets all Task Instructions associated with a Task.
Note: this endpoint supports pagination. Please refer to the Pagination section for more information.
Return data description
| Property | Description |
|---|---|
| parentInstructionID | This is the instructionID of the Instruction's parent. If this value is 0 then this Instruction does not have a parent. |
| instruction | The text that guides a User on what to do on this Instruction. |
| type | The type of the Instruction. See the request Post New Task Instruction to see a list of possible types and their meaning. |
| instructionFiles | Array of objects that have a file name and a link you can use to download that file. All links are only valid for 15 minutes, a new call will generate a new link. |
| options | Array of objects that have an itemOptionID, itemOptionOrder, and itemOptionText. |
| response | This field is the "response" of an instruction i.e. what a user filled out when doing this instruction. The return value changes based on the instruction type:, 1 Check Box - true/false, 2 Radio List - if no option is selected, this will be 0. If an option is selected, this will be a number that maps to the itemOptionID of one of the members of the options array., 3 Text Box - string, 4 Dropdown Box - if no option is selected, this will be 0. If an option is selected, this will be a number that maps to the itemOptionID of one of the members of the options array., 5 Date Picker - unix time stamp, 7 Label - labels will never have a user response, 9 File or Picture Attachment - Array of objects that have a file name and a link you can use to download that image. All links are only valid for 15 minutes, a new call will generate a new link., 10 Assign PM - not supported yet., 13 Number - integer, 14 Start WO - not supported yet., 15 Capture Signature - Array of objects that have a file name and a link you can use to download that image. All links are only valid for 15 minutes, a new call will generate a new link., 16 Request Approval - Array of objects that have a file name and a link you can use to download that image. All links are only valid for 15 minutes, a new call will generate a new link., |
| meta | This property is useful to get more information related to the Task Instructions. Different instruction types may have different properties in the meta section., Instruction Type:, 14 Start WO - If this instruction is completed on the task, the meta property would have an "associatedTask" property on it. The associatedTask gives the route for the task created by this instruction. For example, if task 2 was created by a "Start WO" instruction on task 1. In GET Task Instruction for task 1, this instruction would have a meta associatedTask property pointing to task 2. |
get/v2/tasks/{taskID}/instructions
Request
- Base URL{{server}}:{{port}}
- AuthHTTP basic
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
limitinteger
pageinteger
cursorinteger
This parameter is a cursor that selects what partID you want to start receiving results at. e.g. passing 137 here will only get you parts with an id greater than 137.
Response
Pagination using Page & Limit
Changes
- warning
for the
queryrequest parameterlimit, the max was set to1000.00 - warning
for the
queryrequest parameterlimit, the min was set to1.00 - info
added the non-success response with the status
- warning