метод REST scope: task

tasks.api.scrum.epic.update

Обновить эпик в Скраме

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

Описание

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

Параметры

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

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

Получить идентификаторы эпиков можно методом tasks.api.scrum.epic.list

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

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

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

}

Параметр fields

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

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

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

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

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

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

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

Цвет эпика

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

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

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

Внимание

Если передать пустой массив — файлы удалятся

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

curl -X POST \
-H "Content-Type: application/json" \
-d '{
"fields": {
    "id": 1,
    "fields": {
        "name": "Updated epic name",
        "description": "Updated description text",
        "color": "#bbecf1",
        "files": ["n429", "n243"]
    }
},
}' \
https://your-domain.bitrix24.com/rest/_USER_ID_/_CODE_/tasks.api.scrum.epic.update

Ответ

{
    "id": 1,
    "groupId": 143,
    "name": "Updated epic name",
    "description": "Updated description text",
    "createdBy": 1,
    "modifiedBy": 1,
    "color": "#bbecf1"
}

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

id integer

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

groupId integer

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

name string

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

description string

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

createdBy integer

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

modifiedBy integer

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

color string

Цвет эпика

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

HTTP-статус: 400

{
    "error": 0,
    "error_description": "Epic not updated"
}
Код Описание Значение
0 Access denied Нет доступа для просмотра данных эпика
0 Epic not found Такого эпика не существует
0 Epic not updated Не удалось обновить эпик
0 createdBy user not found Пользователь в поле «создатель» не найден
0 modifiedBy user not found Пользователь в поле «последний изменивший» не найден
100 Could not find value for parameter {id} Неверно указано имя параметра или не задан параметр
100 Invalid value {stringValue} to match with parameter {id}. Should be value of type int. Неверный тип параметра

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

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