Получить глобальные поля

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

Обновлена 26 августа 2024 г.

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

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

Чтобы получить все глобальные поля организации, используйте HTTP-запрос с методом GET:

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

Заголовки

Host

Адрес узла, предоставляющего API:
```
api.tracker.yandex.net
```
Authorization

OAuth-токен в формате OAuth <OAuth-токен>, например:
```
OAuth 0c4181a7c2cf4521964a72ff********
```
X-Org-ID или X-Cloud-Org-ID

Идентификатор организации. Узнать его можно на странице организаций Tracker.
- Если к Tracker привязана только организация Яндекс 360 для бизнеса, используется заголовок X-Org-ID.
- Если к Tracker привязана только организация Yandex Cloud Organization, используется заголовок X-Cloud-Org-ID.
- Если к Tracker одновременно привязаны организации Яндекс 360 для бизнеса и Yandex Cloud Organization, используется заголовок X-Org-ID и идентификатор организации Яндекс 360 для бизнеса.

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

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

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

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

Тело ответа содержит информацию о всех глобальных полях организации в формате JSON.

{
    "self": "https://api.tracker.yandex.net/v2/fields/standard_field_key",
    "id": "standard_field_key",
    "name": "standard_field_name",
    "key": "standard_field_key",
    "version": 0,
    "schema": {
        "type": "string",
        "required": true
    },
    "readonly": true,
    "options": true,
    "suggest": true,
    "suggestProvider": {
        "type": "QueueSuggestProvider"
    },
    "optionsProvider": {
        "type": "QueueOptionsProvider"
    },
    "queryProvider": {
        "type": "QueueQueryProvider"
    },
    "order": 1,
    "category": {
        "self": "https://api.tracker.yandex.net/v2/fields/categories/0000000000000001********",
        "id": "0000000000000001********",
        "display": "Системные"
    },
    "type": "standard"
},
...

Параметры ответа

Параметр	Описание	Тип данных
self	Адрес ресурса API, который содержит информацию о поле.	Строка
id	Идентификатор поля.	Строка
name	Название поля.	Строка
key	Ключ поля.	Строка
version	Версия поля. Каждое изменение поля увеличивает номер версии.	Число
schema	Объект с информацией о типе данных значения поля.	Объект
readonly	Возможность редактировать значение поля: `true` — значение поля нельзя изменить; `false` — значение поля можно изменить.	Логический
options	Ограничение списка значений: `true` — список значений не ограничен, можно задать любое значение; `false` — список значений ограничен настройками организации.	Логический
suggest	Наличие подсказки при вводе значения поля: `true` — при вводе значения появляется поисковая подсказка; `false` — функция поисковой подсказки отключена.	Логический
suggestProvider	Объект с информацией о классе поисковой подсказки. Класс подсказки невозможно изменить с помощью API.	Объект
optionsProvider	Объект с информацией о допустимых значениях поля.	Объект
queryProvider	Объект с информацией о классе языка запроса. Класс невозможно изменить с помощью API.	Объект
order	Порядковый номер в списке полей организации: https://tracker.yandex.ru/admin/fields	Число
category	Объект с информацией о категории поля. Чтобы получить список всех категорий, используйте HTTP запрос: `GET /v2/fields/categories`	Объект
type	Тип поля.	Строка

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

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

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

Параметр	Описание	Тип данных
type	Класс поисковой подсказки.	Строка

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

Параметр	Описание	Тип данных
type	Тип значений поля.	Строка
values	Массив со значениями поля.	Массив

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

Параметр	Описание	Тип данных
type	Тип языка запроса.	Строка

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

Параметр	Описание	Тип данных
self	Адрес ресурса API, который содержит информацию о категории поля.	Строка
id	Идентификатор категории поля.	Строка
display	Отображаемое название категории.	Строка

Если запрос не был успешно обработан, ответное сообщение содержит информацию о возникших ошибках:

400: Один или несколько параметров запроса имеют недопустимое значение.

403: У вас не хватает прав на выполнение этого действия. Наличие прав можно перепроверить в интерфейсе Tracker — для выполнения действия при помощи API и через интерфейс требуются одинаковые права.

404: Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.

500: Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.

503: Сервис API временно недоступен.

Получить глобальные поля

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

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

Была ли статья полезна?

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

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