Tasks: Overview of Methods

Tasks in Bitrix24 provide a unified space that helps organize team work: assigning small tasks and managing large projects. In tasks, you can track employee work progress, control deadlines, and distribute responsibilities.

Quick navigation: all methods and events

User documentation: Bitrix24 tasks

Features of Task MethodsFeatures of Task Methods

When using task methods, it is essential to follow the order of parameters in the request as specified in the parameter tables. Otherwise, the request will execute with errors.

Task Detail FormTask Detail Form

The task detail form can be divided into sections:

• description
• system and custom fields
• task chat
• history and time tracking

The task description contains information about what needs to be done. You can add checklists, files, and links to other tasks to the text.

Checklists help create a list of steps for completing the task. You can manage checklists using the group of methods task.checklistitem.*.

If you need to avoid manually filling in the same fields for recurring tasks, use task templates. A template allows you to save the title, description, participants, deadlines, project, checklist, and other parameters of the future task in advance.

Create links to tasks using the method task.dependence.add. Remove them using the method task.dependence.delete.

When creating a task, fill in the system fields: specify the executor, observers, deadline, tags, and so on.

If the system fields are insufficient, you can create your own custom fields. They allow you to store information in various data formats: string, number, date with time, and yes/no. You can create, modify, retrieve, or delete custom task fields using the group of methods task.item.userfield.*.

In the new task detail form, discussions take place in the task chat. Starting from version tasks 25.700.0, comments have been moved to the chat, so use the task chat and messenger methods to work with messages. For more details, see the article New Task Detail Form: Overview of Changes.

The outcome of the work on a task can be recorded in a comment and fixed as a result. Manage task results using the group of methods tasks.task.result.*.

Time tracking in tasks monitors the time spent by an employee on a task. You can work with time tracking records using the group of methods task.elapseditem.*.

All actions with the task are recorded and saved in the task history. To retrieve the history, use the method tasks.task.history.list.

Linking Tasks with Other ObjectsLinking Tasks with Other Objects

Parent Task. A task can have subtasks. In this case, it is considered a parent task. You can add a link to the parent task in the PARENT_ID parameter. You can obtain the task ID using the method for creating a task or getting a list of tasks.

Group or Project. A task is linked by the group ID GROUP_ID. You can obtain the ID using the method for creating a new group or the method for getting a list of groups.

User. A task is linked to users by numerical IDs in the fields:

• CREATED_BY — Creator
• RESPONSIBLE_ID — Executor
• ACCOMPLICES — Participants
• AUDITORS — Observers
• CHANGED_BY — Last user who modified the task
• STATUS_CHANGED_BY — Last user who changed the task status
• CLOSED_BY — User who completed the task

You can obtain the user ID using the method user.get.

CRM. You can link CRM objects to a task: contacts, companies, leads, deals, invoices, and SPAs. To link an object, specify its identifier with a prefix in the UF_CRM_TASK parameter. For example, C_3 for a contact with id = 3. You can obtain the identifier using the method for creating a new CRM item or the method for getting a list of items.

Email. A task can be linked to an email by its identifier through the UF_MAIL_MESSAGE parameter.

Drive FilesDrive Files

You can attach Drive files to the task description. In the UF_TASK_WEBDAV_FILES parameter, pass an array with the identifiers of the Drive files. Precede each identifier with the prefix n, for example: "UF_TASK_WEBDAV_FILES": ["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

Attach files to the task using the method tasks.task.files.attach if the task has already been created.

FlowsFlows

Flows are a tool that automates the distribution and execution of tasks. Employees do not need to search for who will perform the task. They place tasks in the department flow, and it automatically assigns an executor.

You can manage Flows using the group of methods tasks.flow.Flow.*.

Tasks in ScrumTasks in Scrum

Tasks in Scrum are standard Bitrix24 tasks with enhanced capabilities for working according to the Scrum methodology. In Scrum, the team can:

• estimate task complexity using story points
• attach tasks to epics
• place tasks in the backlog and sprints
• move tasks through sprint stages during work

For more details on Scrum and its methods, see the article Scrum: Overview of Methods.

Task Management ModesTask Management Modes

Kanban is a tool that helps visually represent task management in the form of columns and cards. Columns represent stages of work, and cards represent tasks. Kanban is used for managing tasks in groups and projects.

"My Plan" is a mode for managing your tasks in the form of a Kanban. Each employee will have their own stages in "My Plan."

You can manage the stages of Kanban and "My Plan" using the group of methods task.stages.*.

Tasks in "Plan for the Day"Tasks in "Plan for the Day"

"Plan for the Day" is a to-do list of tasks and meetings that you have scheduled for the workday. The method task.planner.getlist retrieves the list of tasks from "Plan for the Day."

WidgetsWidgets

You can embed an application into the task detail form. With embedding, you can use the application without leaving the detail form.

• Tab in the task detail form TASK_VIEW_TAB
• Right panel of the task detail form TASK_VIEW_SIDEBAR
• Link at the top of the task detail form TASK_VIEW_TOP_PANEL

You can embed an application in the task list:

• Context menu item in the list TASK_LIST_CONTEXT_MENU

In the task management modes Kanban or "My Plan," there are two additional special places for embedding:

• Main dropdown menu item TASK_USER_LIST_TOOLBAR, TASK_GROUP_LIST_TOOLBAR
• Main dropdown menu item near robot settings TASK_ROBOT_DESIGNER_TOOLBAR

Overview of Methods and EventsOverview of Methods and Events

Scope: task

Who can execute the method: depending on the method

MainMain

Task ResultTask Result

Method	Description
tasks.task.result.addFromCommentt	Adds a comment to the result
tasks.task.result.list	Retrieves a list of task results
tasks.task.result.deleteFromComment	Deletes a comment from the task result

ChecklistsChecklists

Method	Description
task.checklistitem.add	Adds a new checklist item to a task
task.checklistitem.update	Updates the data of a checklist item
task.checklistitem.get	Retrieves a checklist item by its id
task.checklistitem.getlist	Retrieves a list of checklist items in a task
task.checklistitem.moveafteritem	Moves a checklist item in the list after the specified one
task.checklistitem.complete	Marks a checklist item as completed
task.checklistitem.renew	Marks a completed checklist item as active again
task.checklistitem.delete	Deletes a checklist item
task.checklistitem.isactionallowed	Checks if an action is allowed for a checklist item
task.checklistitem.getmanifest	Retrieves a list of methods and their descriptions

CommentsComments

Method	Description
task.commentitem.add	Creates a new comment for a task
task.commentitem.update	Updates comment data
task.commentitem.get	Retrieves a comment for a task
task.commentitem.getlist	Retrieves a list of comments for a task
task.commentitem.delete	Deletes a comment

Time TrackingTime Tracking

Method	Description
task.elapseditem.add	Adds time spent to a task
task.elapseditem.update	Updates parameters of a time tracking record
task.elapseditem.get	Retrieves a time tracking record by its identifier
task.elapseditem.getlist	Retrieves a list of time tracking records for a task
task.elapseditem.delete	Deletes a time tracking record
task.elapseditem.isactionallowed	Checks if an action is allowed
task.elapseditem.getmanifest	Retrieves a list of methods and their descriptions

Custom FieldsCustom Fields

Method	Description
task.item.userfield.add	Creates a new field
task.item.userfield.update	Updates field parameters
task.item.userfield.get	Retrieves a field by its identifier
task.item.userfield.getlist	Retrieves a list of fields
task.item.userfield.delete	Deletes a field
task.item.userfield.gettypes	Retrieves all available data types
task.item.userfield.getfields	Retrieves all available fields of a custom field

Kanban and "My Plan" StagesKanban and "My Plan" Stages

Method	Description
task.stages.add	Adds stages to Kanban or "My Plan"
task.stages.update	Updates stages of Kanban or "My Plan"
task.stages.get	Retrieves stages of Kanban or "My Plan"
task.stages.canmovetask	Determines if the current user can move tasks in the specified object
task.stages.movetask	Moves tasks from one stage to another
task.stages.delete	Deletes stages of Kanban or "My Plan"

Tasks in "Plan for the Day"Tasks in "Plan for the Day"

Method	Description
task.planner.getList	Retrieves a list of tasks from "Plan for the Day"

FlowsFlows

Method	Description
tasks.flow.Flow.create	Creates a flow
tasks.flow.Flow.get	Retrieves a flow
tasks.flow.Flow.update	Modifies a flow
tasks.flow.Flow.delete	Deletes a flow
tasks.flow.Flow.isExists	Checks if a flow with that name exists
tasks.flow.Flow.activate	Enables or disables a flow