Перейти к содержанию

Получение спринта

Возвращает конкретный спринт.

GET /tasks/rest/api/v1/workspaces/{workspace}/sprints/{sprintId}

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

workspace (обязательный)

Ключ или идентификатор пространства
workspaces/TS/sprints/{sprintId}
workspaces/f5ce1753-ced5-4992-beb9-7408c1a56cf8/sprints/{sprintId}

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

Идентификатор спринта
sprints/c310f5b2-2ecd-4e9d-bc0b-170fe6c1e5e7

Тело успешного ответа 200

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "description": "string",
  "startDate": "2024-10-29T16:57:02.999Z",
  "endDate": "2024-10-29T16:57:02.999Z",
  "state": "New",
  "workdays": 0,
  "isBacklog": true,
  "team": [
    {
      "user": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "displayName": "string",
        "username": "string",
        "email": "string",
        "providerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      },
      "hoursPerDay": 0,
      "daysOff": 0
    }
  ]
}

Описание возвращаемой модели спринта

id

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

name

Название спринта
?name=Спринт 1

description

Описание спринта

startDate

Дата начала спринта

endDate

Дата завершения спринта

state

Статус спринта (Новый, Активный, Завершенный)

workdays

Кол-во рабочих дней в спринте

isBacklog

Флаг бэклога. True - элемент является бэклогом, False - элемент является спринтом.

team

Команда спринта. Список участников с указанием количества рабочих часов в дне и количества дней отпуска.

[
    {
      "user": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "displayName": "string",
        "username": "string",
        "email": "string",
        "providerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      },
      "hoursPerDay": 0,
      "daysOff": 0
    }
]

Описание модели участника команды

user

Пользователь (см. описание модели пользователя)

hoursPerDay

Количество рабочих часов в дне

daysOff

Количество дней отпуска (выходных) у пользователя в спринте

Ошибки

400 (Bad Request)

Неправильный (несуществующий) параметр запроса

401 (Unauthorized)

Неавторизованный запрос

403 (Forbidden)

Отказ доступа к объекту

404 (Not Found)

Несуществующее расположение

500 (Server Error)

Внутренняя ошибка сервиса