метод REST scope: task

tasks.api.scrum.sprint.get

Получить поля спринта по его идентификатору

Кто может выполнять: любой пользователь

Описание

Метод tasks.api.scrum.sprint.get возвращает значения полей спринта по его идентификатору.

Параметры

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

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

Идентификатор можно получить методом tasks.api.scrum.sprint.list

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

curl -X POST \
-H "Content-Type: application/json" \
-d '{
"id": 2
}' \
https://your-domain.bitrix24.com/rest/_USER_ID_/_CODE_/tasks.api.scrum.sprint.get

Ответ

HTTP-статус: 200

{
    "result":
    {
        "id": 2,
        "groupId": 143,
        "entityType": "sprint",
        "name": "Спринт 1",
        "goal": "",
        "sort": 1,
        "createdBy": 1,
        "modifiedBy": 1,
        "dateStart": "2024-07-19T15:03:01+00:00",
        "dateEnd": "2024-08-02T15:03:01+00:00",
        "status": "planned"
    }
}

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

result object

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

id integer

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

groupId integer

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

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 found"
}
Код Описание Значение
0 Access denied Нет доступа для просмотра данных спринта
0 Sprint 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 Неверный тип параметра

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

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