Skip to content

Latest commit

 

History

History
194 lines (153 loc) · 5.45 KB

task-stages-add.md

File metadata and controls

194 lines (153 loc) · 5.45 KB
Raw

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

Scope: task

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

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

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

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

{% include Сноска об обязательных параметрах %}

#| || Название тип | Описание || || fields* object | Значения полей (подробное описание приведено ниже) для добавления новой стадии || || isAdmin boolean | Если установлено true, то проверки прав происходить не будет. При условии, что запрашивающий является администратором портала || |#

Параметр fields

{% include Сноска об обязательных параметрах %}

#| || Название тип | Описание || || TITLE* string | Заголовок стадии || || COLOR string | Цвет стадии в формате RGB || || AFTER_ID integer | Идентификатор стадии, после которой надо добавить новую стадию.

Если не указано или равно 0, то добавится в начало || || ENTITY_ID integer| Идентификатор объекта.

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

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

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

Примеры кода

{% include Сноска о примерах %}

{% list tabs %}

  • cURL (Webhook)

    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 (OAuth)

    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

  • JS

    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());
        }
    }
);

  • PHP

    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']);
}

{% endlist %}

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

HTTP-статус: 200

{
    "result": 1
}

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

#| || Название тип | Описание || || result integer | Идентификатор добавленной стадии || |#

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

HTTP-статус: 400

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

{% include notitle обработка ошибок %}

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

#| || Код | Описание || || EMPTY_TITLE | Не указан заголовок стадии || || ACCESS_DENIED | Вы не можете управлять стадиями || |#

{% include системные ошибки %}

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