Редактировать статус задачи

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

PATCH

https://api.tracker.yandex.net/v3/statuses/<id_или_ключ_статуса>?version=<version_статуса>

Для выполнения запроса требуются права администратора.

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

Перед выполнением запроса получите доступ к API.

Чтобы отредактировать статус задачи, используйте HTTP-запрос с методом PATCH. В теле запроса укажите параметры в формате JSON.

PATCH /v3/statuses/<id_или_ключ_статуса>?version=<версия_статуса>
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>
{
    "name": {
        "ru": "Мой статус",
        "en": "My status"
    },
    "description": "My status description",
    "order": 350
}

Чтобы узнать параметры статуса задачи, такие как id, key или version, выполните запрос «Получить список статусов».

Заголовки

  • 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.

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

Ресурс
Параметр Описание Тип данных
id_или_ключ_статуса Уникальный идентификатор статуса задачи в Трекере или ключ статуса. Список статусов можно найти на странице https://tracker.yandex.ru/admin/statuses Число или строка
Параметры запроса

Дополнительные параметры

Параметр Описание Тип данных
version Версия статуса задачи. Изменения вносятся только в текущую версию задачи. Число
Параметры тела запроса

Дополнительные параметры

Параметр Описание Тип данных
name Название статуса. Строка
description Описание статуса. Строка
order Вес статуса. Параметр влияет на порядок отображения статуса в интерфейсе. Число
type Тип статуса. Допустимые значения:
  • new;
  • inProgress;
  • paused;
  • done;
  • cancelled.
 Строка

Пример: Изменить название статуса задачи.

  • Используется HTTP-метод PATCH.
  • Редактируется статус с id = 29.
  • Новое название статуса задачи: «Приостановлен».
PATCH /v3/issues/TEST-1
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>

{
    "name": {
        "ru": "Приостановлен",
        "en": "On pause"
        },
    "description": "Issue is paused"
}

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

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

Тело ответа содержит информацию об отредактированном статусе задаче в формате JSON.

[
    {
        "self": "https://api.tracker.yandex.net/v3/statuses/29",
        "id": 29,
        "version": 2,
        "key": "pause",
        "name": "On pause",
        "description": "Issue is paused",
        "order": 350,
        "type": "paused"
    }
]
Параметры ответа
Параметр Описание Тип данных
self Адрес ресурса API, который содержит информацию о типе задачи Строка
id Уникальный идентификатор статуса задачи в Трекере Число
version Версия статуса задачи Число
key Ключ статуса Строка
name Название статуса Строка
description Описание статуса Строка
order Вес статуса. Параметр влияет на порядок отображения статуса в интерфейсе Число
type Тип статуса. Допустимые значения:
  • new;
  • inProgress;
  • paused;
  • done;
  • cancelled
 Строка

Если запрос не был успешно обработан, API возвращает ответ с кодом ошибки:

401
Пользователь не авторизован. Проверьте, были ли выполнены действия, описанные в разделе Доступ к API.
403
У вас не хватает прав на выполнение этого действия. Наличие прав можно перепроверить в интерфейсе Трекера — для выполнения действия при помощи API и через интерфейс требуются одинаковые права.
404
Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.
409
При редактировании объекта возник конфликт. Возможно, ошибка возникла из-за неправильно указанной версии изменений.
423
Редактирование объекта заблокировано. Возможно, превышено допустимое значение параметра version — количество обновлений объекта. Максимальное значение версии составляет 10100 для роботов и 11100 для пользователей.
Предыдущая
Создать статус задачи
Следующая
Получить список резолюций