Связаться с намиПодключиться

Получить все спринты доски

Статья создана
Обновлена 26 августа 2024 г.

Запрос позволяет получить параметры спринтов доски.

Формат запроса

Чтобы получить параметры всех спринтов доски, используйте HTTP-запрос с методом GET:

GET /v2/boards/<идентификатор_доски>/sprints
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>
Заголовки

  • Host

    Адрес узла, предоставляющего API:

    api.tracker.yandex.net

  • Authorization

    OAuth-токен в формате OAuth <OAuth-токен>, например:

    OAuth 0c4181a7c2cf4521964a72ff********

  • X-Org-ID или X-Cloud-Org-ID

    Идентификатор организации. Узнать его можно на странице организаций Tracker.

    • Если к Tracker привязана только организация Яндекс 360 для бизнеса, используется заголовок X-Org-ID.
    • Если к Tracker привязана только организация Yandex Cloud Organization, используется заголовок X-Cloud-Org-ID.
    • Если к Tracker одновременно привязаны организации Яндекс 360 для бизнеса и Yandex Cloud Organization, используется заголовок X-Org-ID и идентификатор организации Яндекс 360 для бизнеса.
Ресурс
Параметр Описание Тип данных
<идентификатор_доски> Идентификатор доски. Строка

Формат ответа

В случае успешного выполнения запроса API возвращает ответ с кодом 200 OK.

Тело ответа содержит JSON-массив с параметрами спринтов доски.

[ 
  {
  "self" : "https://api.tracker.yandex.net/v2/sprints/44**",
  "id" : 44**,
  "version" : 1435288720018,
  "name" : "спринт1",
  "board" : {
    "self" : "https://api.tracker.yandex.net/v2/boards/3",
    "id" : "3",
    "display" : "Тестирование"
  },
  "status" : "in_progress",
  "archived" : false,
  "createdBy" : {
    "self" : "https://api.tracker.yandex.net/v2/users/33********",
    "id" : "33********",
    "display" : "Виктор Булдаков"
  },
  "createdAt" : "2015-06-23T17:03:24.799+0000",
  "startDate" : "2015-06-01",
  "endDate" : "2015-06-14",
  "startDateTime": "2015-06-01T07:00:00.000+0000",
  "endDateTime": "2015-06-14T07:00:00.000+0000"
  },
   ...
]
Параметры ответа
Параметр Описание Тип данных
self Адрес ресурса API, который содержит параметры спринта. Строка
id Идентификатор спринта. Число
version Версия спринта. Каждое изменение спринта увеличивает номер версии. Число
name Название спринта. Строка
board Объект с информацией о доске, к задачам которой относится спринт. Строка
status Статус спринта.
Возможные статусы:
  • draft — открыт;
  • in_progress — в работе;
  • released — решен;
  • archived — в архиве.
 Строка
archived Нахождение спринта в архиве:
  • true— спринт находится в архиве;
  • false— спринт активен.
 Логический
createdBy Объект с информацией о создателе спринта. Объект
createdAt Дата и время создания спринта в формате: YYYY-MM-DDThh:mm:ss.sss±hhmm Строка
startDate Дата начала спринта в формате: YYYY-MM-DD Строка
endDate Дата окончания спринта в формате: YYYY-MM-DD Строка
startDateTime Дата и время фактического начала спринта в формате: YYYY-MM-DDThh:mm:ss.sss±hhmm Строка
endDateTime Дата и время фактического окончания спринта в формате: YYYY-MM-DDThh:mm:ss.sss±hhmm Строка

Поля объекта board

Параметр Описание Тип данных
self Адрес ресурса API, который содержит информацию о доске. Строка
id Идентификатор доски. Строка
display Отображаемое название доски. Строка

Поля объекта createdBy

Параметр Описание Тип данных
self Адрес ресурса API, который содержит информацию о пользователе. Строка
id Идентификатор пользователя. Строка
display Отображаемое имя пользователя. Строка

Если запрос не был успешно обработан, ответное сообщение содержит информацию о возникших ошибках:

400
Один или несколько параметров запроса имеют недопустимое значение.
403
У вас не хватает прав на выполнение этого действия. Наличие прав можно перепроверить в интерфейсе Tracker — для выполнения действия при помощи API и через интерфейс требуются одинаковые права.
404
Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.
500
Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.
503
Сервис API временно недоступен.
Предыдущая
Удалить колонку
Следующая
Получить спринт