Подключиться
Yandex Tracker

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

Статья создана

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

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

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

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

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

  • Host

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

    https://api.tracker.yandex.net

  • Authorization

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

    OAuth 0c4181a7c2cf4521964a72ff57a34a07

  • X-Org-ID

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

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

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

  • Используется HTTP-метод GET.
GET /v2/queues/TEST/fields HTTP/1.1
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID: <идентификатор организации>

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

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

[
    {
        "self": "https://api.tracker.yandex.net/v2/fields/stand",
        "id": "stand",
        "name": "Стенд",
        "version": 1361890459119,
        "schema": {
            "type": "string",
            "required": false
        },
        "readonly": false,
        "options": true,
        "suggest": false,
        "optionsProvider": {
            "type": "QueueFixedListOptionsProvider",
            "values": {
                "DIRECT": [
                    "Не указано",
                    "Тестовый",
                    "Разработческий",
                    "Бета",
                    "Production",
                    "Trunk"
                ]
            },
            "defaults": [
                "Не указано",
                "Тестовый",
                "Разработческий",
                "Бета",
                "Production"
            ]
        },
        "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
Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.
В этой статье: