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

Scope: task

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

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

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

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

Принимает на вход id стадии. Стадия проверяется на достаточный уровень прав, а также на то, что в ней нет задач.

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

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

Название `тип`	Описание
id* `integer`	Идентификатор стадии, которую необходимо удалить
isAdmin `boolean`	Если установлено `true`, то проверки прав происходить не будет, при условии, что запрашивающий является администратором портала

Примеры кода

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

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -d '{
        "id": 5
        }' \
        https://your-domain.bitrix24.com/rest/_USER_ID_/_CODE_/task.stages.delete

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Authorization: YOUR_ACCESS_TOKEN" \
        -d '{
        "id": 5
        }' \
        https://your-domain.bitrix24.com/rest/task.stages.delete

try
        {
        	const response = await $b24.callMethod(
        		'task.stages.delete',
        		{
        			id: stageId,
        		}
        	);
        	
        	const result = response.getData().result;
        	console.log(result);
        }
        catch( error )
        {
        	console.error('Error:', error);
        }

try {
            $stageId = 5;
            $response = $b24Service
                ->core
                ->call(
                    'task.stages.delete',
                    [
                        'id' => $stageId,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            // Нужная вам логика обработки данных
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error deleting task stage: ' . $e->getMessage();
        }

const stageId = 5;
        BX24.callMethod(
            'task.stages.delete',
            {
                id: stageId,
            },
            function(res)
            {
                console.log(res);
            }
        );

require_once('crest.php'); // подключение CRest PHP SDK
        
        $stageId = 5;
        
        // выполнение запроса к REST API
        $result = CRest::call(
            'task.stages.delete',
            [
                'id' => $stageId
            ]
        );
        
        // Обработка ответа от Битрикс24
        if ($result['error']) {
            echo 'Error: '.$result['error_description'];
        } else {
            print_r($result['result']);
        }

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

HTTP-Статус: 200

{
            "result": true
        }

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

Название `тип`	Описание
result `boolean`	Возвращает `true` в случае успешного удаления стадии

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

HTTP-статус: 400

{
            "error": "CANT_DELETE_FIRST",
            "error_description": "Нельзя удалить первую стадию. Передвиньте стадию, чтобы удалить"
        }

Название `тип`	Описание
error `string`	Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания
error_description `error_description`	Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

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

Код	Описание
`ACCESS_DENIED`	Вы не можете управлять стадиями
`CANT_DELETE_FIRST`	Нельзя удалить первую стадию. Передвиньте стадию, чтобы удалить
`IS_SYSTEM`	Стадия, установленная по умолчанию, не может быть удалена
`NOT_FOUND`	Стадия не найдена

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

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

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

Переместить задачу из одной стадии в другую

Обзор методов

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

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

Примеры кодаПримеры кода

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

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

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

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

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

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