---
metadata:
  - name: generator
    content: Diplodoc Platform v5.50.6
  - 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/queues/get-fields.md
  - https://yandex.ru/support/tracker/ru/api-ref/queues/get-fields.md
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/support/tracker/ru/llms.txt


# Получить обязательные поля очереди

Запрос позволяет получить информацию об обязательных полях очереди. Очередь выбирается при указании идентификатора или ключа.

<div class="request_example method_get yfm-clipboard">
    <p>GET</p>
    <pre><code>https://api.tracker.yandex.net/v3/queues/&lt;id_очереди>/fields</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`.

```
GET /v3/queues/<id_очереди>/fields
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 %}

> Пример: Получить обязательные поля очереди `TEST`.
>
> - Используется HTTP-метод `GET`.
>
> ```
> GET https://api.tracker.yandex.net/v3/queues/TEST/fields
> ```

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

{% list tabs %}

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

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

    ```json translate=no
    [
        {
            "self": "https://api.tracker.yandex.net/v3/fields/myfield",
            "id": "myfield",
            "name": "My field",
            "version": 1361890459119,
            "schema": {
                "type": "string",
                "required": false
            },
            "readonly": false,
            "options": true,
            "suggest": false,
            "optionsProvider": {
                "type": "QueueFixedListOptionsProvider",
                "values": {
                    "DIRECT": [
                        "First",
                        "Second",
                        "Third"
                    ]
                },
                "defaults": [
                    "First",
                    "Second",
                    "Third"
                ]
            },
            "queryProvider": {
                "type": "StringOptionalQueryProvider"
            },
            "order": 222
        },
        ....
    ]
    ```

    {% cut "Параметры ответа" %}

    Параметр | Описание | Тип данных
    ----- | ----- | -----
    self | Ссылка на объект поля. | Строка
    id | Идентификатор поля. | Строка
    name | Название поля. | Строка
    version | Номер версии. | Число
    [schema](#schema) | Объект с информацией о типе содержимого поля. | Объект
    readonly | Признак возможности редактировать поле. Возможные значения:<ul><li>`true` — редактируемое поле;</li><li>`false` — нередактируемое поле.</li></ul> | Логический
    options | Признак наличия вариантов заполнения поля. | Логический
    suggest | Доступность подсказок при заполнении поля. | Логический
    optionsProvider | Блок с информацией о наборе возможных значений в поле. | Объект
    queryProvider | Информация о типе поля для query-запросов. | Объект
    order | Вес поля при отображении в интерфейсе. Поля с меньшим весом отображаются выше полей с большим весом. | Число

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

    Параметр | Описание | Тип данных
    ----- | ----- | -----
    type | Тип содержимого поля. Возможные значения:<ul><li>`float` — числовое поле;</li><li>`string` — текстовое поле.</li></ul> | Строка
    required | Признак обязательности заполнения поля. | Логический

    **Поля объекта** `optionsProvider`

    Параметр | Описание | Тип данных
    ----- | ----- | -----
    type | Информация о типе поля для query-запросов | Строка
    values | Массив с информацией о специальных значениях для очередей | Объект
    defaults | Массив значений поля | Массив

    {% endcut %}

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

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

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

{% endlist %}