Подключиться
Yandex Tracker

Создать спринт

Статья создана

Запрос позволяет создать спринт.

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

Чтобы создать спринт, используйте HTTP-запрос с методом POST:

POST /v2/sprints
Host: https://api.tracker.yandex.net
Authorization: OAuth <токен>
X-Org-ID: <идентификатор организации>

{
  "name": "Новый Спринт",
  "board": 
    {
      "id": "1"
    },
  "startDate": "2018-10-21",
  "endDate": "2018-10-24"
}

Заголовки

  • Host

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

    https://api.tracker.yandex.net

  • Authorization

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

    OAuth 0c4181a7c2cf4521964a72ff57a34a07

  • X-Org-ID

    Идентификатор организации.

Тело запроса

Тело запроса содержит обязательные параметры спринта.

Параметр Описание Тип данных
name Название спринта. Строка
board Объект с информацией о доске, к задачам которой относится спринт. Строка
startDate Дата начала спринта в формате: YYYY-MM-DD Строка
endDate Дата окончания спринта в формате: YYYY-MM-DD Строка

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

Параметр Описание Тип данных
id Идентификатор доски. Строка

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

В случае успешного выполнения запроса API возвращает ответ с кодом 200. Тело ответа содержит JSON-объект с параметрами созданного спринта.

Тело ответа

{
  "self" : "http://api.tracker.yandex.net/v2/sprints/4469",
  "id" : 4469,
  "version" : 1,
  "name" : "Новый Спринт",
  "board" : {
    "self" : "http://api.tracker.yandex.net/v2/boards/3",
    "id" : "1",
    "display" : "Тестирование"
  },
  "status" : "draft",
  "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 Статус спринта.
Возможные статусы:
  • 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 Отображаемое имя пользователя. Строка

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

HTTP-код ошибки Описание ошибки
400 Bad Request Один из параметров запроса имеет недопустимое значение или формат данных.
403 Forbidden У пользователя или приложения нет прав на доступ к ресурсу, запрос отклонен.
404 Not Found Запрашиваемый ресурс не найден.
422 Unprocessable Entity Ошибка валидации JSON, запрос отклонен.
500 Internal Server Error Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.
503 Service Unavailable Сервис API временно недоступен.
В этой статье: