Редактировать макрос

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

PATCH

https://api.tracker.yandex.net/v3/queues/<id_очереди>/macros/<id_макроса>

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

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

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

PATCH /v3/queues/<id_очереди>/macros/<id_макроса>
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>

{
  "name": "<имя_макроса>",
  "body": "<текст_комментария>\n{{currentDateTime}}\n{{issue.author}}",
  "issueUpdate": {
       "description": "Новая задача",
       "tags": { "add": "Новый тег" },
       "resolution": null
   }
}
Заголовки
  • 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_очереди> Идентификатор или ключ очереди. Ключ очереди чувствителен к регистру символов. Строка
<id_макроса> Идентификатор макроса. Строка
Параметры тела запроса

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

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

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

Параметр Описание Тип данных
body Сообщение, которое будет создано при выполнении макроса. Для оформления текста сообщения используйте правила форматирования.
Чтобы удалить сообщение, используйте конструкцию "body": {"unset":1}
Строка
issueUpdate Объект со списком полей задачи, которые требуется изменить. Полный список полей задачи

Чтобы очистить поле, укажите значение null.
Также допустимо использовать операторы set, add, remove (см. Редактирование параметров)
Объект

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

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

Тело ответа содержит JSON-объект со всеми параметрами макроса, включая измененные.

  {
    "self": "https://api.tracker.yandex.net/v3/queues/TEST/macros/3",
    "id": 3,
    "queue": {
      "self": "https://api.tracker.yandex.net/v3/queues/TEST", 
      "id": "1",
      "key": "TEST",
      "display": "My queue"
       },
    "name": "Test macro 1",
    "body": "Test comment\n{{currentDateTime}}\n{{issue.author}}",
    "issueUpdate": [
      {
        "field": {
           "self": "https://api.tracker.yandex.net/v3/fields/tags", 
           "id": "tags",
           "display": "Теги"
          },
        "update": {
            "add": ["tag 1", "tag 2"]
        }
      },
       ...
    ]
  }
Параметры ответа
Параметр Описание Тип данных
self Адрес ресурса API, который содержит параметры макроса. Строка
id Идентификатор макроса. Число
queue Объект с информацией об очереди, к задачам которой применяется макрос. Объект
name Название макроса. Строка
body Комментарий, который будет создан при выполнении макроса. Строка
issueUpdate Массив с информацией о полях задачи, изменения которых запустит макрос. Массив объектов

Поля объекта queue

Параметр Описание Тип данных
self Адрес ресурса API, который содержит информацию об очереди. Строка
id Идентификатор очереди. Строка
key Ключ очереди. Строка
display Отображаемое название очереди. Строка

Объекты массива issueUpdate

Параметр Описание Тип данных
field Объект с информацией о поле задачи. Объект
update Объект с информацией об обновлении поля задачи. Объект

Поля объекта field

Параметр Описание Тип данных
self Адрес ресурса API, который содержит информацию о поле задачи. Строка
id Идентификатор поля задачи. Строка
display Отображаемое название поля задачи. Строка

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

400
Один или несколько параметров запроса имеют недопустимое значение.
403
У вас не хватает прав на выполнение этого действия. Наличие прав можно перепроверить в интерфейсе Трекера — для выполнения действия при помощи API и через интерфейс требуются одинаковые права.
404
Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.
422
Ошибка валидации JSON, запрос отклонен.
500
Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.
503
Сервис API временно недоступен.
Предыдущая
Следующая