Получить спринт
Запрос позволяет получить параметры спринта.
Формат запроса
Чтобы получить параметры спринта, используйте HTTP-запрос с методом GET
:
GET /v2/sprints/<sprint-id>
Host: https://api.tracker.yandex.net
Authorization: OAuth <токен>
X-Org-ID: <идентификатор организации>
Ресурс
-
<sprint-id>
Идентификатор спринта.
Заголовки
-
Host
Адрес узла, предоставляющего API:
https://api.tracker.yandex.net
-
Authorization
OAuth-токен в формате
OAuth <значение токена>
, например:OAuth 0c4181a7c2cf4521964a72ff57a34a07
-
X-Org-ID
Идентификатор организации.
Формат ответа
Запрос выполнен успешно
Запрос выполнен с ошибкой
В случае успешного выполнения запроса API возвращает ответ с кодом 200. Тело ответа содержит JSON-объект с параметрами спринта.
Тело ответа
{
"self" : "http://api.tracker.yandex.net/v2/sprints/4469",
"id" : 4469,
"version" : 1435288720018,
"name" : "спринт1",
"board" : {
"self" : "http://api.tracker.yandex.net/v2/boards/3",
"id" : "3",
"display" : "Тестирование"
},
"status" : "in_progress",
"archived" : false,
"createdBy" : {
"self" : "http://api.tracker.yandex.net/v2/users/1120000000014425",
"id" : "1120000000014425",
"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 | Статус спринта. Возможные статусы:
|
Строка. |
archived | Нахождение спринта в архиве:
|
Логический. |
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 | Отображаемое имя пользователя. | Строка. |
Если запрос не был успешно обработан, ответное сообщение содержит информацию о возникших ошибках:
HTTP-код ошибки | Описание ошибки |
---|---|
400 Bad Request | Один из параметров запроса имеет недопустимое значение или формат данных. |
403 Forbidden | У пользователя или приложения нет прав на доступ к ресурсу, запрос отклонен. |
404 Not Found | Запрашиваемый ресурс не найден. |
500 Internal Server Error | Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время. |
503 Service Unavailable | Сервис API временно недоступен. |