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

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

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}}",
  "fieldChanges": <объект_или_массив>
}
Заголовки

  • Host: адрес узла, предоставляющего API.

  • Authorization: токен для авторизации в одном из форматов:

    • OAuth <OAuth-токен> при авторизации по протоколу OAuth 2.0. Читать подробнее

    • Bearer <IAM-токен> при авторизации с помощью IAM-токена — если к Tracker привязана организация Yandex Cloud Organization. Читать подробнее

  • X-Org-ID или X-Cloud-Org-ID: идентификатор организации.

    • Используйте заголовок X-Org-ID, если к Tracker привязана организация Яндекс 360 для бизнеса.

    • Используйте заголовок X-Cloud-Org-ID, если к Tracker привязана организация Yandex Cloud Organization.

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

Ресурс
Параметр Описание Тип данных
<id_очереди> Идентификатор или ключ очереди. Ключ очереди чувствителен к регистру символов. Строка
<id_макроса> Идентификатор макроса. Строка
Параметры тела запроса

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

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

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

Параметр Описание Тип данных
body Сообщение, которое будет создано при выполнении макроса. Формат: <текст_сообщения>\n<переменная>
где:
  • <текст_сообщения>— текст, который будет создан в поле Комментарий при выполнении макроса.
  • \n — символ переноса строки.
  • Переменная, которая может содержать:
    {{currentUser}} — имя пользователя, который выполнил макрос;
    {{currentDateTime.date}} — дату выполнения макроса;
    {{currentDateTime}} — дату и время выполнения макроса;
    {{issue.<ключ_поля>}} — ключ поля задачи, значение которого отразится в сообщении. Полный список полей задачи: https://tracker.yandex.ru/admin/fields
Чтобы удалить сообщение, используйте конструкцию "body": {"unset":1}		 Строка
fieldChanges Объект или массив с информацией о новых настройках действий макроса. Структура объекта отличается в зависимости от типа изменений. Объект или массив

Структура объекта fieldChanges

Добавить действие макроса. Параметр add позволяет добавить поле и его значение в список имеющихся.

"fieldChanges": {
      "add": [
               {
          "field": "tags", 
          "value": "tag2"
               },
                ...
              ]

Тело запроса

Параметр Описание Тип данных
fieldChanges Объект с информацией о новых настройках действий макроса. Объект

Объект массива fieldChanges

Параметр Описание Тип данных
add Массив с информацией о параметрах нового действия макроса. Массив

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

Параметр Описание Тип данных
field Идентификатор поля задачи.

Полный список полей задачи		 Строка
value Значение поля задачи. Строка

Заменить действие макроса на новое. Параметр replace позволяет заменить поле и его значение, заданные с помощью параметра target на новые, заданные с помощью параметра replacement.

"fieldChanges": {
         "replace": [
                      {
                "target": {
                    "field": "tags", 
                    "value": "tag2"
                          }, 
                "replacement": {
                    "field": "originalEstimation", 
                    "value": "PT2H"
                                }
                        }
                      ]
}

Тело запроса

Параметр Описание Тип данных
fieldChanges Объект с информацией о новых настройках действий макроса. Объект

Параметры объекта fieldChanges

Параметр Описание Тип данных
replace Массив с информацией о параметрах действия, которые нужно заменить на новые. Массив

Массив объекта replace

Параметр Описание Тип данных
target Объект с информацией о параметрах действия, которые нужно заменить. Объект
replacement Объект с информацией о новых параметрах действия. Объект

Параметры объектов target и replacement

Параметр Описание Тип данных
field Идентификатор поля задачи.

Полный список полей задачи		 Строка
value Значение поля задачи. Строка

Заменить все действия макроса на новые. Сохранятся только те поля и значения, которые указаны в массиве.

"fieldChanges": [
                          {
             "field": "tags", 
             "value": "tag2"
                          },
                          ...
]

Тело запроса

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

Параметры массива fieldChanges

Параметр Описание Тип данных
field Идентификатор поля задачи.

Полный список полей задачи		 Строка
value Значение поля задачи. Строка

Удалить действие макроса. Параметр replace позволяет удалить поле и его значение.

"fieldChanges": {
         "remove": [ 
                    {
                  "field": "tags", 
                  "value": "tag2"
                     },
                      ...
                    ]
}

Тело запроса

Параметр Описание Тип данных
fieldChanges Объект с информацией о новых настройках действий макроса. Объект

Поле объекта fieldChanges

Параметр Описание Тип данных
remove Массив с информацией о полях и значениях действия макроса, которые нужно удалить. Массив

Параметры массива remove

Параметр Описание Тип данных
field Идентификатор поля задачи.

Полный список полей задачи		 Строка
value Значение поля задачи. Строка

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

В случае успешного выполнения запроса 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": "Тестовая очередь"
       },
    "name": "Тестовый макрос 1",
    "body": "Тестовый комментарий\n{{currentDateTime}}\n{{issue.author}}",
    "fieldChanges": [
      {
        "field": {
           "self": "https://api.tracker.yandex.net/v3/fields/tags", 
           "id": "tags",
           "display": "Теги"
          },
        "value": [
                "tag1"
                 ]
      },
       ...
    ]
  }
Параметры ответа
Параметр Описание Тип данных
self Адрес ресурса API, который содержит параметры макроса. Строка
id Идентификатор макроса. Число
queue Объект с информацией об очереди, к задачам которой применяется макрос. Объект
name Название макроса. Строка
body Сообщение, которое будет создано при выполнении макроса. Формат: <текст_сообщения>\n<переменная>
где:
  • <текст_сообщения>— текст, который будет создан в поле Комментарий при выполнении макроса.
  • \n — символ переноса строки.
  • Переменная, которая может содержать:
    {{currentUser}} — имя пользователя, который выполнил макрос;
    {{currentDateTime.date}} — дату выполнения макроса;
    {{currentDateTime}} — дату и время выполнения макроса;
    {{issue.<ключ_поля>}} — ключ поля задачи, значение которого отразится в сообщении. Полный список полей задачи: https://tracker.yandex.ru/admin/fields
Чтобы удалить сообщение, используйте конструкцию "body": {"unset":1}		 Строка
fieldChanges Массив с информацией о полях задачи, изменения которых запустит макрос. Массив объектов

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

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

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

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

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

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

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

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