Documentation

Kanban Item

Methods for working with Kanban stages.

Table of stages

Parameter Description
ID Stage ID
TITLE Title
SORT Soting index (read only)
COLOR Color in RGB format, for example: FFAAEE.
SYSTEM_TYPE System code, presently it can be either 'null' or 'NEW' - signifying that this stage is the stage by-default (read only)
ENTITY_TYPE Entity type, to which the stage (G - group, U - user) belongs (read only, also specified when adding)
ENTITY_ID Entity ID, to which the stage (group or user) belongs (read only)

Methods

Method Description Available from version
task.stages.add Adds stages for Kanban/Planner.
task.stages.canmovetask Defines if current user can move tasks in the specified entity
task.stages.delete Deletes stages for Kanban/Planner.
task.stages.get Gets stages for Kanban/Planner.
task.stages.movetask Moves tasks from one stage to another.
task.stages.update Updates stages for Kanban/Planner.

Tasks selection

Selection of tasks from stages is performed via the task.stages.get method. However, there are some specifics: they are provided below.

  1. Selection from the Kanban of workgroup. Pass the STAGE_ID in the array of the filter with the ID of the stage that we need. However, if you select tasks from the by default stage (it is listed first), you will be required to pass an array of values for STAGE_ID, consisting of 0 as well as your stage ID ([0, ]). Additionally, such selection shall be filtered by the workgroup as well.
  2. Selection from the Planner. The STAGES_ID key is passed in the array of the filter with ID of the stage you require. No need to pass array of vales.


© «Bitrix24», 2001-2024
Up