---
metadata:
  - name: generator
    content: Diplodoc Platform v5.54.2
  - property: og:type
    content: article
  - property: article:section
    content: Справочник API
  - property: og:title
    content: Получить макросы очереди
  - property: article:tag
    content: Техническая инструкция
alternate:
  - https://yandex.ru/support/tracker/en/api-ref/get-macroses.md
  - https://yandex.ru/support/tracker/ru/api-ref/get-macroses.md
  - href: ru/api-ref/get-macroses.md
    type: text/markdown
    title: Markdown version
  - href: ../llms.txt
    type: text/markdown
    title: llms.txt
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/support/tracker/ru/llms.txt


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

Запрос позволяет получить параметры всех макросов очереди. [Что такое макрос](https://yandex.ru/support/tracker/manager/create-macroses.html)

<div class="request_example method_get yfm-clipboard">
    <p>GET</p>
    <pre><code>https://api.tracker.yandex.net/v3/queues/&lt;id_очереди>/macros</code></pre>
    <button class="yfm-clipboard-button"><svg width="16" height="16" viewBox="0 0 24 24" class="yfm-clipboard-icon" data-animation="15">
    <path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path>
    <path stroke="currentColor" fill="transparent" strokewidth="1.5" d="M9.5 13l3 3l5 -5" visibility="hidden">
        <animate id="visibileAnimation-15" attributeName="visibility" from="hidden" to="visible" dur="0.2s" fill="freeze" begin=""></animate>
        <animate id="hideAnimation-15" attributeName="visibility" from="visible" to="hidden" dur="1s" begin="visibileAnimation-15.end+1" fill="freeze"></animate>
    </path>
</svg>
</button>
</div>

<!-- source: ru/api-ref/_assets/style/methods.md -->

<!-- endsource: ru/api-ref/_assets/style/methods.md -->

## Формат запроса {#query}

Перед выполнением запроса [получите доступ к API](https://yandex.ru/support/tracker/ru/api-ref/access.md).

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

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

<!-- source: ru/api-ref/_includes/headings-no-body.md -->
{% cut "Заголовки" %}

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

* <!-- source: ru/api-ref/_includes/authorization.md -->
  `Authorization`: токен для авторизации в одном из форматов:

    - `OAuth <OAuth-токен>` при авторизации по протоколу OAuth 2.0. [Читать подробнее](https://yandex.ru/support/tracker/ru/api-ref/access.md#about_OAuth)

    - `Bearer <IAM-токен>` при авторизации с помощью IAM-токена — если к Трекеру привязана организация Yandex Identity Hub. [Читать подробнее](https://yandex.ru/support/tracker/ru/api-ref/access.md#iam-token)
  <!-- endsource: ru/api-ref/_includes/authorization.md -->


* <!-- source: ru/api-ref/_includes/org-id.md -->
  `X-Org-ID` или `X-Cloud-Org-ID`: идентификатор организации.

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

  - если к Трекеру привязана организация Yandex Identity Hub, используйте заголовок `X-Cloud-Org-ID`.
  <!-- endsource: ru/api-ref/_includes/org-id.md -->

  <!-- source: ru/api-ref/_includes/org-id.md -->
  Чтобы узнать идентификатор организации, перейдите на страницу **Администрирование** → [**Организации**](https://tracker.yandex.ru/admin/orgs) и скопируйте значение поля **идентификатор**.
  <!-- endsource: ru/api-ref/_includes/org-id.md -->


{% endcut %}
<!-- endsource: ru/api-ref/_includes/headings-no-body.md -->

{% cut "Ресурс" %}

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

{% endcut %}


## Формат ответа {#answer}

{% list tabs %}

- Запрос выполнен успешно

    <!-- source: ru/api-ref/_includes/answer-200.md -->
    В случае успешного выполнения запроса API возвращает ответ с кодом `200 OK`.
    <!-- endsource: ru/api-ref/_includes/answer-200.md -->

    Тело ответа содержит JSON-массив с параметрами всех макросов очереди.

    ```json translate=no
    [
      {
        "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": "My macro",
        "body": "Test comment\n{{currentUser}}{{currentDateTime.date}}{{currentDateTime}}\n{{issue.author}}",
        "issueUpdate": [
          {
            "field": {
               "self": "https://api.tracker.yandex.net/v3/fields/tags",
               "id": "tags",
               "display": "Теги"
              },
            "update": {
                "add": ["tag 1", "tag 2"]
            }
          },
           ...
        ]
      },
       ...
    ]
    ```
    {% cut "Параметры ответа" %}

    Параметр | Описание | Тип данных
    ----- | ----- | -----
    self | Адрес ресурса API, который содержит параметры макроса. | Строка
    id | Идентификатор макроса. | Число
    [queue](#queue) | Объект с информацией об очереди, к задачам которой применяется макрос. | Объект
    name | Название макроса. | Строка
    body | Комментарий, который будет создан при выполнении макроса.  | Строка
    [issueUpdate](#issueUpdate) | Массив с информацией о полях задачи, изменения которых запустит макрос. | Массив объектов

    **Поля объекта** `queue` {#queue}

    <!-- source: ru/api-ref/_includes/queue.md -->
    Параметр | Описание | Тип данных
    ----- | ----- | -----
    self | Адрес ресурса API, который содержит информацию об очереди. | Строка
    id | Идентификатор очереди. | Строка
    key | Ключ очереди. | Строка
    display | Отображаемое название очереди. | Строка
    <!-- endsource: ru/api-ref/_includes/queue.md -->

    <!-- source: ru/api-ref/_includes/answer-macro-issue-update.md -->
    **Объекты массива** `issueUpdate` {#issueUpdate}

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

    **Поля объекта** `field` {#field}

    Параметр | Описание | Тип данных
    -------- | -------- | ---------- 
    self | Адрес ресурса API, который содержит информацию о поле задачи. | Строка
    id | Идентификатор поля задачи. | Строка
    display | Отображаемое название поля задачи. | Строка
    <!-- endsource: ru/api-ref/_includes/answer-macro-issue-update.md -->

    {% endcut %}

- Запрос выполнен с ошибкой

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

    <!-- source: ru/api-ref/_includes/answer-error-400.md -->
    400
    :   Один или несколько параметров запроса имеют недопустимое значение.
    <!-- endsource: ru/api-ref/_includes/answer-error-400.md -->

    <!-- source: ru/api-ref/_includes/answer-error-403.md -->
    403
    :   У вас не хватает прав на выполнение этого действия. Наличие прав можно перепроверить в интерфейсе Трекера — для выполнения действия при помощи API и через интерфейс требуются одинаковые права.
    <!-- endsource: ru/api-ref/_includes/answer-error-403.md -->

    <!-- source: ru/api-ref/_includes/answer-error-404.md -->
    404
    :   Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.
    <!-- endsource: ru/api-ref/_includes/answer-error-404.md -->

    <!-- source: ru/api-ref/_includes/answer-error-500.md -->
    500
    :   Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.
    <!-- endsource: ru/api-ref/_includes/answer-error-500.md -->

    <!-- source: ru/api-ref/_includes/answer-error-503.md -->
    503
    :   Сервис API временно недоступен.    
    <!-- endsource: ru/api-ref/_includes/answer-error-503.md -->

{% endlist %}