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

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

PATCH

https://api.tracker.yandex.net/v3/issuetypes/<id_или_ключ_типа_задачи>?version=<версия_типа_задачи>

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

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

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

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

PATCH /v3/issuetypes/<id_или_ключ_типа_задачи>?version=<версия_типа_задачи>
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>

{
    "name": {
        "ru": "Покупатель",
        "en": "Customer"
    }
}

Чтобы узнать параметры типа задачи, такие как 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_или_ключ_типа_задачи Уникальный идентификатор типа задачи в Трекере или ключ типа задачи. Число или строка
Параметры запроса

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

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

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

Параметр Описание Тип данных
name Название типа задачи. Строка

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

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

[
    {
        "name": {
            "ru": "Покупатель",
            "en": "Customer"
        }
    }
]

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

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

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

[
    {
        "self": "https://api.tracker.yandex.net/v3/issuetypes/23",
        "id": 23,
        "version": 2,
        "key": "client",
        "name": "Покупатель"
    }
]
Параметры ответа
Параметр Описание Тип данных
self Адрес ресурса API, который содержит информацию о типе задачи Строка
id Уникальный идентификатор типа задачи в Трекере Число
version Версия типа задачи Число
key Ключ типа задачи Строка
name Название типа задачи Строка

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

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