Добавить стадию канбана или «Моего плана» task.stages.add

Scope: task

Кто может выполнять метод:

  • любой пользователь для стадий «Моего плана»
  • любой пользователь с доступом к группе для стадий канбана

Метод добавляет стадию канбана или «Моего плана».

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

fields*
object

Значения полей (подробное описание приведено ниже) для добавления новой стадии

isAdmin
boolean

Если установлено true, то проверки прав происходить не будет. При условии, что запрашивающий является администратором портала

Параметр fields

Обязательные параметры отмечены *

Название
тип

Описание

TITLE*
string

Заголовок стадии

COLOR
string

Цвет стадии в формате RGB

AFTER_ID
integer

Идентификатор стадии, после которой надо добавить новую стадию.

Если не указано или равно 0, то добавится в начало

ENTITY_ID
integer

Идентификатор объекта.

Может равняться ID группы, тогда стадия добавится в канбан группы.

Если равняется 0 или отсутствует, то стадия добавляется в «Мой план» текущего пользователя.

При недостаточном уровне прав выводится ошибка доступа

Примеры кода

Как использовать примеры в документации

curl -X POST \
        -H "Content-Type: application/json" \
        -d '{
        "fields": {
            "TITLE": "Название стадии",
            "COLOR": "#FFAAEE",
            "AFTER_ID": 1,
            "ENTITY_ID": 1
        },
        "isAdmin": false
        }' \
        https://your-domain.bitrix24.com/rest/_USER_ID_/_CODE_/task.stages.add
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Authorization: YOUR_ACCESS_TOKEN" \
        -d '{
        "fields": {
            "TITLE": "Название стадии",
            "COLOR": "#FFAAEE",
            "AFTER_ID": 1,
            "ENTITY_ID": 1
        },
        "isAdmin": false
        }' \
        https://your-domain.bitrix24.com/rest/task.stages.add
        
try
        {
        	const response = await $b24.callMethod(
        		'task.stages.add',
        		{
        			fields: {
        				TITLE: 'Название стадии',
        				COLOR: '#FFAAEE',
        				AFTER_ID: 1,
        				ENTITY_ID: 1
        			},
        			isAdmin: false,
        		}
        	);
        	
        	const result = response.getData().result;
        	console.info(result);
        }
        catch( error )
        {
        	console.error(error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'task.stages.add',
                    [
                        'fields' => [
                            'TITLE'    => 'Название стадии',
                            'COLOR'    => '#FFAAEE',
                            'AFTER_ID' => 1,
                            'ENTITY_ID' => 1
                        ],
                        'isAdmin' => false,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            // Нужная вам логика обработки данных
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error adding task stage: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'task.stages.add',
            {
                fields: {
                    TITLE: 'Название стадии',
                    COLOR: '#FFAAEE',
                    AFTER_ID: 1,
                    ENTITY_ID: 1
                },
                isAdmin: false,
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.info(result.data());
                }
            }
        );
        
require_once('crest.php'); // подключение CRest PHP SDK
        
        $fields = [
            "TITLE" => "Название стадии",
            "COLOR" => "#FFAAEE",
            "AFTER_ID" => 1,
            "ENTITY_ID" => 1
        ];
        
        // выполнение запроса к REST API
        $result = CRest::call(
            'task.stages.add',
            [
                'fields' => $fields,
                'isAdmin' => false
            ]
        );
        
        // Обработка ответа от Битрикс24
        if ($result['error']) {
            echo 'Error: '.$result['error_description'];
        } else {
            print_r($result['result']);
        }

Обработка ответа

HTTP-статус: 200

{
            "result": 1
        }

Возвращаемые данные

Название
тип

Описание

result
integer

Идентификатор добавленной стадии

Обработка ошибок

HTTP-статус: 400

{
            "error": "EMPTY_TITLE",
            "error_description": "Не указан заголовок стадии"
        }

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Код

Описание

EMPTY_TITLE

Не указан заголовок стадии

ACCESS_DENIED

Вы не можете управлять стадиями

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Предыдущая
Обзор методов
Следующая
Обновить стадию канбана или «Моего плана»