Task Template Checklists: Overview of Methods

Task template checklists allow you to prepare a list of actions in advance for tasks that will be created based on the template.

The methods in this section work with the task template checklist. They enable you to add items, modify them, rearrange them, mark them as completed or return them to work, as well as add and remove attachments.

For checklists of existing tasks, use the methods from the Task Checklists section.

Quick navigation: all methods and events

User documentation: checklists in tasks

Getting StartedGetting Started

1. Create a task template using the tasks.template.add method. The identifier of the new template can be obtained in the response of the method. It is used in all methods of the section in the templateId parameter.
2. Create the checklist structure using the tasks.template.checklist.add method. If you need to create a nested item, pass the parent item's identifier in the PARENT_ID field.
3. Retrieve information about a checklist item using the tasks.template.checklist.get method if you need to check its parameters. Use this when you need to get a single item by its known checkListItemId.
4. Get the list of items using the tasks.template.checklist.list method if you need to check the checklist structure and obtain item identifiers.
5. Modify the content of an item using the tasks.template.checklist.update method if you need to adjust the name, description, or other parameters.
6. Change the order of items using the tasks.template.checklist.moveAfter and tasks.template.checklist.moveBefore methods if you need to rearrange an item relative to another item.
7. Change the status of an item using the tasks.template.checklist.complete and tasks.template.checklist.renew methods if you need to mark an item as completed or return it to work.
8. Add attachments using the tasks.template.checklist.addAttachmentByContent and tasks.template.checklist.addAttachmentsFromDisk methods if the item needs to contain files.
9. If attachments are no longer needed, remove them using the tasks.template.checklist.removeAttachments method.
10. If an item is no longer needed, delete it using the tasks.template.checklist.delete method.

Relationship with Other ObjectsRelationship with Other Objects

Task Template. All methods in this section work with the checklist of a specific task template. The template identifier is passed in the templateId parameter. You can obtain the identifier of the new template when creating it using the tasks.template.add method. To read template data by identifier, use tasks.template.get.

Files. You can attach files from Drive to the task template checklist item using the tasks.template.checklist.addAttachmentsFromDisk method. In the filesIds parameter, pass an array with the identifiers of the Drive files. Precede each identifier with the prefix n, for example: ["n428", "n345"]. You can obtain file identifiers in two ways.

Use one of the file upload methods:

• disk.storage.uploadfile
• disk.folder.uploadfile

Use one of the methods to get the list of files:

• disk.storage.getchildren
• disk.folder.getchildren

Overview of MethodsOverview of Methods

Scope: task

Who can perform the method: depending on the method

Core MethodsCore Methods

Method	Description
tasks.template.checklist.add	Adds a checklist item
tasks.template.checklist.update	Updates a checklist item
tasks.template.checklist.get	Retrieves a checklist item by identifier
tasks.template.checklist.list	Retrieves a list of checklist items
tasks.template.checklist.delete	Deletes a checklist item

Order and StatusOrder and Status

Method	Description
tasks.template.checklist.moveAfter	Moves an item after the specified one
tasks.template.checklist.moveBefore	Moves an item before the specified one
tasks.template.checklist.complete	Marks an item as completed
tasks.template.checklist.renew	Returns an item to an incomplete state

AttachmentsAttachments

Method	Description
tasks.template.checklist.addAttachmentByContent	Adds an attachment from content
tasks.template.checklist.addAttachmentsFromDisk	Adds attachments from Drive
tasks.template.checklist.removeAttachments	Removes attachments from the checklist item