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

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

GET

https://api.tracker.yandex.net/v3/queues/<id_очереди>/fields

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

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

Для получения обязательных полей очереди используйте HTTP-запрос с методом GET.

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

  • 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_очереди> Идентификатор или ключ очереди. Ключ очереди чувствителен к регистру символов. Строка или число

Пример: Получить обязательные поля очереди TEST.

  • Используется HTTP-метод GET.
GET https://api.tracker.yandex.net/v3/queues/TEST/fields

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

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

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

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

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

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

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

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

404
Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.
Предыдущая
Получить версии очереди
Следующая
Удалить очередь