Редактировать резолюцию

Запрос позволяет внести изменения в резолюцию.

PATCH

https://api.tracker.yandex.net/v3/resolutions/<id_или_ключ_резолюции>?version=<version_резолюции>

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

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

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

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

PATCH /v3/resolutions/<id_или_ключ_резолюции>?version=<версия_резолюции>
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>
{
    "name": {
        "ru": "Моя резолюция",
        "en": "My resolution"
    },
    "description": "My resolution 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/resolutions Число или строка
Параметры запроса

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

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

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

Параметр Описание Тип данных
name Название резолюции. Объект
description Описание резолюции. Строка
order Вес резолюции. Параметр влияет на порядок отображения резолюции в интерфейсе. Число

Пример: Изменить название резолюции.

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

{
    "name": {
        "ru": "Не будет исправлено",
        "en": "Won't be fixed"
        },
    "description": "Issue won't be fixed"
}

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

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

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

    {
        "self": "https://api.tracker.yandex.net/v3/resolutions/9",
        "id": 9,
        "key": "myResolution",
        "version": 2,
        "name": "Не будет исправлено",
        "description": "Issue won't be fixed",
        "order": 90
    }
Параметры ответа
Параметр Описание Тип данных
self Адрес ресурса API, который содержит информацию о резолюции Строка
id Уникальный идентификатор резолюции в Трекере Число
key Ключ резолюции Строка
version Версия резолюции Число
name Название резолюции Строка
description Описание резолюции Строка
order Вес резолюции. Параметр влияет на порядок отображения резолюции в интерфейсе Число

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

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