{ "opencollection": "1.0.0", "info": { "name": "Limble API V2 Assets Instructions API", "version": "1.0.0" }, "request": { "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "items": [ { "info": { "name": "Instructions", "type": "folder" }, "items": [ { "info": { "name": "Instruction Options", "type": "http" }, "http": { "method": "GET", "url": "https://api.limblecmms.com/v2/tasks/:taskID/instructions/:instructionID/options", "params": [ { "name": "taskID", "value": "11429", "type": "path", "description": "taskID of the task you are getting the option/dropdown list." }, { "name": "instructionID", "value": "49343", "type": "path", "description": "instructionID of the option/dropdown list you are getting the options for." } ] }, "docs": "This request gets all the Options for an Instruction Option or Dropdown list associated with a Task." }, { "info": { "name": "New Instruction Option", "type": "http" }, "http": { "method": "POST", "url": "https://api.limblecmms.com/v2/tasks/:taskID/instructions/:instructionID/options", "params": [ { "name": "taskID", "value": "11429", "type": "path", "description": "taskID of the task you are getting the option/dropdown list." }, { "name": "instructionID", "value": "49343", "type": "path", "description": "instructionID of the option/dropdown list you are getting the options for." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This request will create a new Option for a Dropdown or Option instruction of a task.\n\nParameter: instruction, Type: string, Required?: Required, Description: The text that guides the User for selecting the option.\nParameter: instructionOptionOrder, Type: Int, Required?: Optional, Description: If this is set the option is created at that position of the list. This value cannot be greater than the total number of option present in the list. If not set the option is added to the end of the list." }, { "info": { "name": "Update Instruction Option", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.limblecmms.com/v2/tasks/instructions/:instructionID/options/:instructionOptionID", "params": [ { "name": "instructionID", "value": "49343", "type": "path", "description": "instructionID of the instruction whose option you are editing." }, { "name": "instructionOptionID", "value": "7097", "type": "path", "description": "instructionOptionID of the option you are editing." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Instruction Option" }, { "info": { "name": "Delete Instruction Option", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.limblecmms.com/v2/tasks/instructions/:instructionID/options/:instructionOptionID", "params": [ { "name": "instructionID", "value": "49343", "type": "path", "description": "instructionID of the instruction whose option you are editing." }, { "name": "instructionOptionID", "value": "7097", "type": "path", "description": "instructionOptionID of the option you are editing." } ] }, "docs": "This request will delete an option from a Dropdown or Option instruction." }, { "info": { "name": "Task Instructions", "type": "http" }, "http": { "method": "GET", "url": "https://api.limblecmms.com/v2/tasks/:taskID/instructions", "params": [ { "name": "taskID", "value": "80", "type": "path" }, { "name": "limit", "value": "2", "type": "query" }, { "name": "page", "value": "1", "type": "query" }, { "name": "cursor", "value": "0", "type": "query", "description": "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." } ] }, "docs": "This request gets all Task Instructions associated with a Task.\n\n**Note:** this endpoint supports pagination. Please refer to the [Pagination](#pagination) section for more information.\n\nReturn data description\n\nparentInstructionID | This is the instructionID of the Instruction's parent. If this value is 0 then this Instruction does not have a parent.\ninstruction | The text that guides a User on what to do on this Instruction.\ntype | The type of the Instruction. See the request Post New Task Ins" }, { "info": { "name": "New Task Instruction", "type": "http" }, "http": { "method": "POST", "url": "https://api.limblecmms.com/v2/tasks/:taskID/instructions", "params": [ { "name": "taskID", "value": "80", "type": "path" } ] }, "docs": "This request will create a new Instruction for a Task.\n\nParameter: type, Type: Int, Required?: Required, Description: The type of each checklist item., 1 = Check Box; 2 = Option List; 3 = Text Box; 4 = Dropdown List; 5 = Date Picker; 7 = Label; 9 = File or Picture Attachment; 11 = Deadline Date Picker; 13 = Number; 14 = Start WO; 15 = Capture Signature., Item types not listed here are not currently supported. If you would like another item type to be supported, please contact us at product@limbl" }, { "info": { "name": "Get Task Instruction by ID", "type": "http" }, "http": { "method": "GET", "url": "https://api.limblecmms.com/v2/tasks/instructions/:instructionID", "params": [ { "name": "instructionID", "value": "", "type": "path" } ] }, "docs": "This request retrieves a single Task Instruction by its instructionID.\n\n**Path Parameters:**\n- `instructionID` (required): The ID of the instruction to retrieve\n\n**Return data description:**\n\nReturns a single instruction object with the following properties:\n\n| Property | Description |\n|----------|-------------|\n| instructionID | The unique identifier for this instruction |\n| taskID | The ID of the task this instruction belongs to |\n| parentInstructionID | This is the instructionID of the Instru" }, { "info": { "name": "Update Task Instruction", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.limblecmms.com/v2/tasks/instructions/:instructionID", "params": [ { "name": "instructionID", "value": "", "type": "path" } ] }, "docs": "This request updates an Task Instruction.\n\nParameter: instruction, Type: string, Required?: Optional, Description: The text that guides a User on what to do on this Instruction.\nParameter: parentInstructionID, Type: Int, Required?: Optional, Description: If this is set this Instruction is a 'child' or sub-instruction. This value of parentInstructionID is the id of the Instruction's parent. A value of 0 means this Instruction does not have a parent Instruction." }, { "info": { "name": "Delete Task Instruction", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.limblecmms.com/v2/tasks/instructions/:instructionID", "params": [ { "name": "instructionID", "value": "", "type": "path" } ] }, "docs": "This request removes a Task Instruction from a Task." }, { "info": { "name": "Batch Task Instructions", "type": "http" }, "http": { "method": "GET", "url": "https://api.limblecmms.com/v2/tasks/instructions", "params": [ { "name": "tasks", "value": "1,2,3,4,5,6,7", "type": "query", "description": "CSV of task IDs " }, { "name": "limit", "value": "100", "type": "query", "description": "Page size (1..1000)" }, { "name": "page", "value": "1", "type": "query", "description": "Page-based pagination (mutually exclusive with cursor)" } ] }, "docs": "Retrieves instructions across multiple tasks, by taskID.\n\nReturn data description\n\nparentInstructionID | This is the instructionID of the Instruction's parent. If this value is 0 then this Instruction does not have a parent.\ninstruction | The text that guides a User on what to do on this Instruction.\ntype | The type of the Instruction. See the request Post New Task Instruction to see a list of possible types and their meaning.\ninstructionFiles | Array of objects that have a file name and a link " } ] } ], "bundled": true }