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

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

POST

https://api.tracker.yandex.net/v3/sprints

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

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

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

{
  "name": "New Sprint",
  "board": 
    {
      "id": "1"
    },
  "startDate": "2018-10-21",
  "endDate": "2018-10-24"
}
Заголовки

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

  • Authorization: токен для авторизации в одном из форматов:

    • OAuth <OAuth-токен> при авторизации по протоколу OAuth 2.0. Читать подробнее

    • Bearer <IAM-токен> при авторизации с помощью IAM-токена — если к Трекеру привязана организация Yandex Cloud Organization. Читать подробнее

  • X-Org-ID или X-Cloud-Org-ID: идентификатор организации.

    • Используйте заголовок X-Org-ID, если к Трекеру привязана организация Яндекс 360 для бизнеса.

    • Используйте заголовок X-Cloud-Org-ID, если к Трекеру привязана организация Yandex Cloud Organization.

    Чтобы узнать идентификатор организации, перейдите на страницу Администрирование → Организации и скопируйте значение поля идентификатор.

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

Обязательные параметры

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

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

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

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

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

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

{
  "self": "https://api.tracker.yandex.net/v3/sprints/44**",
  "id" : 44**,
  "version" : 1,
  "name" : "New Sprint",
  "board" : {
    "self": "https://api.tracker.yandex.net/v3/boards/3",
    "id" : "1",
    "display" : "My queue"
  },
  "status" : "draft",
  "archived" : false,
  "createdBy" : {
    "self": "https://api.tracker.yandex.net/v3/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
У вас не хватает прав на выполнение этого действия. Наличие прав можно перепроверить в интерфейсе Трекера — для выполнения действия при помощи API и через интерфейс требуются одинаковые права.
404
Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.
422
Ошибка валидации JSON, запрос отклонен.
500
Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.
503
Сервис API временно недоступен.
Предыдущая
Получить спринт
Следующая
Создать дашборд