Получить обязательные поля очереди
Запрос позволяет получить информацию об обязательных полях очереди. Очередь выбирается при указании идентификатора или ключа.
Формат запроса
Для получения обязательных полей очереди используйте HTTP-запрос с методом GET
:
GET /v2/queues/<queue-id>/fields
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
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: <идентификатор организации>
Cache-Control: no-cache
Формат ответа
[
{
"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
},
....
]
true
— редактируемое поле.false
— нередактируемое поле.float
— числовое поле.string
— текстовое поле.true
— редактируемое поле.false
— нередактируемое поле.float
— числовое поле.string
— текстовое поле.
Параметр | Описание | Тип данных |
---|---|---|
self | Ссылка на объект поля. | Строка. |
id | Идентификатор поля. | Строка. |
name | Название поля. | Строка. |
version | Номер версии. | Число. |
schema | Объект с информацией о типе содержимого поля. | Объект. |
readonly | Признак возможности редактировать поле. Возможные значения: | Логический. |
options | Признак наличия вариантов заполнения поля. | Логический. |
suggest | Доступность подсказок при заполнении поля. | Логический. |
optionsProvider | Блок с информацией о наборе возможных значений в поле. | Объект. |
queryProvider | Информация о типе поля для query-запросов. | Объект. |
order | Вес поля при отображении в интерфейсе. Поля с меньшим весом отображаются выше полей с большим весом. | Число. |
Поля объекта schema | ||
type | Тип содержимого поля. Возможные значения: | Строка. |
required | Признак обязательности заполнения поля. | Логический. |
Поля объекта optionsProvider | ||
type | Информация о типе поля для query-запросов. | Строка. |
values | Массив с информацией о специальных значениях для очередей. | Объект |
defaults | Массив значений поля. | Массив. |
Параметр | Описание | Тип данных |
---|---|---|
self | Ссылка на объект поля. | Строка. |
id | Идентификатор поля. | Строка. |
name | Название поля. | Строка. |
version | Номер версии. | Число. |
schema | Объект с информацией о типе содержимого поля. | Объект. |
readonly | Признак возможности редактировать поле. Возможные значения: | Логический. |
options | Признак наличия вариантов заполнения поля. | Логический. |
suggest | Доступность подсказок при заполнении поля. | Логический. |
optionsProvider | Блок с информацией о наборе возможных значений в поле. | Объект. |
queryProvider | Информация о типе поля для query-запросов. | Объект. |
order | Вес поля при отображении в интерфейсе. Поля с меньшим весом отображаются выше полей с большим весом. | Число. |
Поля объекта schema | ||
type | Тип содержимого поля. Возможные значения: | Строка. |
required | Признак обязательности заполнения поля. | Логический. |
Поля объекта optionsProvider | ||
type | Информация о типе поля для query-запросов. | Строка. |
values | Массив с информацией о специальных значениях для очередей. | Объект |
defaults | Массив значений поля. | Массив. |
Возможные коды ответа
- 200
- Запрос выполнен успешно.
- 404
- Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.