метод REST scope: task

tasks.api.scrum.sprint.add

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

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

Описание

Метод tasks.api.scrum.sprint.add добавляет спринт в Скрам.

Параметры

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

Объект с данными спринта

Параметр fields

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

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

Идентификатор можно получить методом tasks.api.scrum.sprint.get для уже существующего спринта

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

Название спринта

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

Сортировка

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

Дата начала спринта. Доступные форматы: ISO 8601, timestamp

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

Дата окончания спринта. Доступные форматы: ISO 8601, timestamp

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

Статус спринта. Доступные значения: active, planned, completed

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

curl -X POST \
-H "Content-Type: application/json" \
-d '{
"fields": {
    "name": "Sprint 1",
    "groupId": 1,
    "createdBy": 1,
    "sort": 1,
    "status": "planned",
    "dateStart": "2021-11-22T00:00:00+02:00",
    "dateEnd": "2021-11-29T00:00:00+02:00"
}
}' \
https://your-domain.bitrix24.com/rest/_USER_ID_/_CODE_/tasks.api.scrum.sprint.add

Ответ

HTTP-статус: 200

{
    "result":
    {
        "id": 1,
        "groupId": 1,
        "entityType": "sprint",
        "name": "Sprint 1",
        "goal": "",
        "sort": 1,
        "createdBy": 1,
        "modifiedBy": 1,
        "dateStart": "2021-11-22T00:00:00+02:00",
        "dateEnd": "2021-11-29T00:00:00+02:00",
        "status": "planned"
    }
}

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

result object

Объект, содержащий данные о спринте

id integer

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

groupId integer

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

entityType string

Тип сущности (в данном случае sprint)

name string

Название спринта

goal string

Цель спринта. Устанавливается только в интерфейсе при запуске спринта

sort integer

Сортировка

createdBy integer

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

modifiedBy integer

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

dateStart string

Дата начала спринта в формате ISO 8601

dateEnd string

Дата окончания спринта в формате ISO 8601

status string

Статус спринта

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

HTTP-статус: 400

{
    "error": 0,
    "error_description": "Sprint not created"
}
Код Описание Значение
0 Access denied Нет доступа к скраму
0 Sprint not created Не удалось создать спринт
0 Incorrect dateStart format Неверный формат времени начала спринта
0 Incorrect dateEnd format Неверный формат времени окончания спринта
0 createdBy user not found Пользователь в поле «создатель» не найден
0 modifiedBy user not found Пользователь в поле «последний изменивший» не найден
100 Could not find value for parameter {fields} Неверно указано имя параметра или не задан параметр
100 Invalid value {stringValue} to match with parameter {fields}. Should be value of type array Неверный тип параметра

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

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