Task Status Changes: Overview of Methods

The methods in this section move a task between its main working statuses: they let you start work, pause work, defer a task, complete it, and return it to work after completion.

The task status reflects the current stage of work and affects the task card, change history, and actions available to participants.

Quick links: all methods

User documentation: List view in tasks

Getting StartedGetting Started

1. Create a task using tasks.task.add or get its identifier using tasks.task.list
2. Get current task data using tasks.task.get if you need to check the current status and available actions
3. Start work using tasks.task.start when the assignee begins execution
4. Pause work using tasks.task.pause if the task needs to be stopped temporarily
5. Defer the task using tasks.task.defer if you need to return to it later
6. Complete the task using tasks.task.complete when the work is done
7. Renew the task using tasks.task.renew if it needs to be returned to work after completion

Relation to Other ObjectsRelation to Other Objects

Task. All methods in this section work with an existing task by its identifier. Create a task using tasks.task.add, get task data using tasks.task.get, and get a task list using tasks.task.list.

Users. The ability to change status depends on the user's role in the task and access permissions. You can check access to the task using tasks.task.getaccess.

Task History. Status changes are recorded in the task history. You can get the change history using tasks.task.history.list.

Completion Control. If completion control is enabled in the task, after the task is moved to Completed, the creator can accept the result using tasks.task.approve or return the task to work using tasks.task.disapprove.

Overview of MethodsOverview of Methods

Scope: task

Who can execute the method: depends on the user's role in the task

Method	Description
tasks.task.start	Moves a task to In Progress status
tasks.task.pause	Stops task execution and moves it to Waiting status
tasks.task.defer	Moves a task to Deferred status
tasks.task.complete	Moves a task to Completed status
tasks.task.renew	Renews a task after completion