метод REST scope: task

tasks.api.scrum.epic.add

Добавить эпик в Скрам

Кто может выполнять: любой пользователь, имеющий доступ к Скраму

Описание

Метод добавляет эпик в Скрам.

Параметры

fields object обязательный

Значения полей (подробное описание приведено ниже) для добавления нового эпика в виде структуры:

fields: {
    name: 'значение',
    groupId: 'значение',
    description: 'значение',
    color: 'значение',
    files: [
        'файл1',
        'файл2',
        ...
    ]

}

Параметр fields

name string обязательный

Название эпика

description string необязательный

Описание эпика

groupId integer обязательный

Идентификатор группы (скрама), к которой относится эпик

color string необязательный

Цвет эпика

files array необязательный

Массив файлов, привязанных к эпику.

В files можно передать массив значений с идентификаторами файлов, указав префикс n для каждого идентификатора

createdBy integer необязательный

Кем создан

modifiedBy integer необязательный

Кем изменен

Примеры запроса

curl -X POST \
-H "Content-Type: application/json" \
-d '{
"fields": {
    "name": "Epic 1",
    "groupId": 1,
    "description": "Description text",
    "color": "#69dafc",
    "files": ["n428", "n345"]
}
}' \
https://your-domain.bitrix24.com/rest/_USER_ID_/_CODE_/tasks.api.scrum.epic.add

Ответ

{
    "id": 4,
    "groupId": 1,
    "name": "Epic 1",
    "description": "Description text",
    "createdBy": 1,
    "modifiedBy": 1,
    "color": "#69dafc"
}

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

id integer

Идентификатор эпика

groupId integer

Идентификатор группы (скрама), к которой привязан эпик

name string

Название эпика

description string

Описание эпика

createdBy integer

Идентификатор пользователя, создавшего эпик

modifiedBy integer

Идентификатор пользователя, который последним изменял эпик

color string

Цвет эпика в формате HEX

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

HTTP-статус: 400

{
    "error": 0,
    "error_description": "Group is not found"
}
Код Описание Значение
0 Access denied Нет доступа к скраму
0 Epic not created Не удалось создать эпик
0 createdBy user not found Пользователь в поле «создатель» не найден
0 modifiedBy user not found Пользователь в поле «последний изменивший» не найден
0 Group is not found Не указан параметр GROUP_ID или группы с таким ID не существует
0 Name is not found Не указан параметр NAME

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.