Получить макросы очереди

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

  1. Формат запроса
  2. Формат ответа

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

Чтобы получить параметры всех макросов очереди, используйте HTTP-запрос с методом GET:

GET/v2/queues/<queue-id>/macros
Host:https://api.tracker.yandex.net
Authorization: OAuth <токен>
X-Org-ID: <идентификатор организации>
Ресурс
<queue-id>
Ключ очереди.
Заголовки
Host

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

https://api.tracker.yandex.net
Authorization

OAuth-токен в формате OAuth <значение токена>, например:

OAuth 0c4181a7c2cf4521964a72ff57a34a07
X-Org-ID

Идентификатор организации.

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

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

[
  {
    "self": "https://api.tracker.yandex.net/v2/queues/TEST/macros/3",
    "id": 3,
    "queue": {
      "self": "https://api.tracker.yandex.net/v2/queues/TEST", 
      "id": "1",
      "key": "TEST",
      "display": "Тестовая очередь"
       },
    "name": "Тестовый макрос",
    "body": "Тестовое сообщение\n{{currentUser}}{{currentDateTime.date}}{{currentDateTime}}\n{{issue.author}}",
    "fieldChanges": [
      {
        "field": {
           "self": "https://api.tracker.yandex.net/v2/fields/tags", 
           "id": "tags",
           "display": "Теги"
          },
        "value": [
                "tag1", "tag2"
                 ]
      },
       ...
    ]
  },
   ...
]
Параметры ответа
Параметр Описание Тип данных
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 Отображаемое название поля задачи. Строка.
Параметр Описание Тип данных
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 Отображаемое название поля задачи. Строка.