Редактировать спринт
Запрос позволяет изменить параметры спринта.
PATCH
https://api.tracker.yandex.net/v3/sprints/<идентификатор_спринта>
Формат запроса
Чтобы изменить параметры спринта, используйте HTTP-запрос с методом PATCH:
PATCH /v3/sprints/<идентификатор_спринта>
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
Content-Type: application/json
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>
If-Match: "<версия_спринта>"
{
"name": "Updated Sprint Name",
"startDate": "2024-01-15",
"endDate": "2024-01-29",
"status": "in_progress"
}
Заголовки
-
Host: адрес узла, предоставляющего API. -
Authorization: токен для авторизации в одном из форматов:-
OAuth <OAuth-токен>при авторизации по протоколу OAuth 2.0. Читать подробнее -
Bearer <IAM-токен>при авторизации с помощью IAM-токена — если к Трекеру привязана организация Yandex Cloud Organization. Читать подробнее
-
-
Content-Type: формат тела запроса. Должен иметь значениеapplication/json. -
X-Org-IDилиX-Cloud-Org-ID: идентификатор организации.-
если к Трекеру привязана организация Яндекс 360 для бизнеса, используйте заголовок
X-Org-ID, -
если к Трекеру привязана организация Yandex Cloud Organization, используйте заголовок
X-Cloud-Org-ID.
Чтобы узнать идентификатор организации, перейдите на страницу Администрирование → Организации и скопируйте значение поля идентификатор.
-
-
If-Match: версия спринта. Указывается, чтобы избежать потери изменений при одновременном редактировании. Значение параметраversionможно получить в ответе на запрос информации о спринте.
Ресурс
| Параметр | Описание | Тип данных |
|---|---|---|
| <идентификатор_спринта> | Идентификатор спринта. | Строка |
Параметры тела запроса
| Параметр | Описание | Тип данных |
|---|---|---|
| name | Название спринта. | Строка |
| startDate | Дата начала спринта в формате: YYYY-MM-DD |
Строка |
| endDate | Дата окончания спринта в формате: YYYY-MM-DD |
Строка |
| status | Статус спринта. Возможные статусы:
|
Строка |
Пример: Редактировать спринт
- Используется HTTP-метод PATCH.
- Изменяются параметры спринта с идентификатором 44**.
- Новое название спринта — «Обновленный спринт».
- Дата начала спринта — 2026-04-07.
- Дата окончания спринта — 2026-04-21.
- Статус спринта — «В работе».
- Версия спринта для предотвращения конфликтов — 2.
PATCH /v3/sprints/44** Host: api.tracker.yandex.net Authorization: OAuth y0__xAbc****** Content-Type: application/json X-Org-ID: 1234****** If-Match: "2" { "name": "Обновленный спринт", "startDate": "2026-04-07", "endDate": "2026-04-21", "status": "in_progress" }
Формат ответа
В случае успешного выполнения запроса API возвращает ответ с кодом 200 OK.
Тело ответа содержит JSON-объект с обновленными параметрами спринта.
{
"self": "https://api.tracker.yandex.net/v3/sprints/44**",
"id" : 44**,
"version" : 1435288720019,
"name" : "Updated Sprint Name",
"board" : {
"self": "https://api.tracker.yandex.net/v3/boards/3",
"id" : "3",
"display" : "My board"
},
"status" : "draft",
"archived" : false,
"createdBy" : {
"self": "https://api.tracker.yandex.net/v3/users/33********",
"id" : "33********",
"display" : "Имя Фамилия"
},
"createdAt" : "2024-08-22T21:49:33.570+0000",
"startDate" : "2026-04-07",
"endDate" : "2026-04-10",
"startDateTime": "2026-04-07T00:00:00.000+0000",
"endDateTime": "2026-04-10T00: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 | Отображаемое имя пользователя. | Строка |
Если запрос не был успешно обработан, ответное сообщение содержит информацию о возникших ошибках:
- 400
- Один или несколько параметров запроса имеют недопустимое значение.
- 403
- У вас не хватает прав на выполнение этого действия. Наличие прав можно перепроверить в интерфейсе Трекера — для выполнения действия при помощи API и через интерфейс требуются одинаковые права.
- 404
- Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.
- 500
- Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.
- 503
- Сервис API временно недоступен.