Получить подсказки для заполнения формы

Чтобы получить подсказки для заполнения формы, используйте HTTP-запрос с методом GET. Параметры запроса:

survey — код формы, ее слаг или комбинация кода формы и проверочного ключа.
question — слаг вопроса.
text — текст для поиска.
id — список идентификаторов подсказок. Идентификаторы должны быть разделены запятыми. Параметр позволяет получить объекты подсказок по их кодам.
parent_id — список идентификаторов объектов подсказок в Формах для бизнеса. Идентификаторы должны быть разделены запятыми.

Request

GET

https://api.forms.yandex.net/v1/surveys/{survey}/suggest

Path parameters

Name	Description
survey*	Type: string

Query parameters

Name	Description
id	Type: string Default: ``
parent_id	Type: string Default: ``
question	Type: string Default: ``
text	Type: string Default: ``

Responses

200 OK

Body

application/json

[
    {
        "id": "string",
        "layer": "country",
        "orig_id": "string",
        "text": "string"
    }
]

(SuggestCountryOut
or SuggestCityOut
or SuggestUniversityOut
or SuggestAddressOut
or SuggestGenderOut
or SuggestUserEmailOut
or SuggestWebMasterOut
or SuggestAbcServiceOut
or SuggestMusicGenreOut
or SuggestStaffOrganizationOut
or SuggestStaffOfficeOut
or SuggestStaffGroupOut
or SuggestStaffPersonOut
or SuggestStaffRoomOut
or SuggestWikiTableOut
or SuggestYtTableOut
or SuggestDirUserOut
or SuggestDirGroupOut
or SuggestDirDepartmentOut
or SuggestTrackerQueueOut
or SuggestTrackerProjectOut
or SuggestTrackerBoardOut
or SuggestTrackerSprintOut
or SuggestTrackerComponentOut
or SuggestTrackerIssueOut
or SuggestTrackerFieldOut)[]

SuggestCountryOut

Name	Description
id*	Type: string Код страны
orig_id*	Type: string Код страны в базе Яндекса
text*	Type: string Название страны
layer	Type: string Тип подсказки Default: `country` Enum: `country`

SuggestCityOut

Name	Description
id*	Type: string Код города
orig_id*	Type: string Код города в базе Яндекса
text*	Type: string Название города
country_id	Type: string Код страны
layer	Type: string Тип подсказки Default: `city` Enum: `city`
population	Type: integer Население города из базы Яндекса

SuggestUniversityOut

Name	Description
id*	Type: string Код университета
text*	Type: string Название университета
city	Type: string Город университета
layer	Type: string Тип подсказки Default: `university` Enum: `university`
region	Type: string Регион

SuggestAddressOut

Name	Description
id*	Type: string Адрес из подсказки
text*	Type: string Адрес из подсказки
layer	Type: string Тип подсказки Default: `address` Enum: `address`

SuggestGenderOut

Name	Description
id*	Type: string Слаг пола
text*	Type: string Пол
layer	Type: string Тип подсказки Default: `gender` Enum: `gender`

SuggestUserEmailOut

Name	Description
id*	Type: string Адрес электронной почты пользователя
text*	Type: string Адрес электронной почты пользователя
layer	Type: string Тип подсказки Default: `user_email_list` Enum: `user_email_list`

SuggestWebMasterOut

Name	Description
id*	Type: string Слаг домена сайта из Яндекс Вебмастера
text*	Type: string Домен сайта из Яндекс Вебмастера
layer	Type: string Тип подсказки Default: `web_master_site` Enum: `web_master_site`

SuggestAbcServiceOut

Name	Description
id*	Type: string Код сервиса в ABC
text*	Type: string Название сервиса
layer	Type: string Тип подсказки Default: `abc_service` Enum: `abc_service`

SuggestMusicGenreOut

Name	Description
id*	Type: string Слаг музыкального жанра
text*	Type: string Название музыкального жанра
layer	Type: string Тип подсказки Default: `music_genre` Enum: `music_genre`
tracks_count	Type: integer Количество треков в Яндекс Музыке

SuggestStaffOrganizationOut

Name	Description
id*	Type: string Код организации на Стаффе
text*	Type: string Название организации
layer	Type: string Тип подсказки Default: `staff_organization` Enum: `staff_organization`

SuggestStaffOfficeOut

Name	Description
id*	Type: string Код офиса на Стаффе
text*	Type: string Название офиса
address	Type: string Адрес офиса
layer	Type: string Default: `staff_office` Enum: `staff_office`

SuggestStaffGroupOut

Name	Description
id*	Type: string Код группы на Стаффе
text*	Type: string Название группы
layer	Type: string Тип подсказки Default: `staff_group` Enum: `staff_group`
role_scope	Type: string Скоуп группы
type	Type: string Тип группы
url	Type: string Слаг группы

SuggestStaffPersonOut

Name	Description
id*	Type: string Код сотрудника на Стаффе
text*	Type: string Имя сотрудника
avatar	Type: string Аватар сотрудника
department	Type: string Департамент сотрудника на Стаффе
email	Type: string Адрес электронной почты сотрудника
full_name	Type: string Имя сотрудника
group_id	Type: string Код группы на Стаффе
layer	Type: string Тип подсказки Default: `staff_login` Enum: `staff_login`
uid	Type: string Uid сотрудника в Яндекс ID
yandex_uid	Type: string Uid сотрудника в Яндекс ID

SuggestStaffRoomOut

Name	Description
id*	Type: string Код переговорки на Стаффе
text*	Type: string Название переговорки
floor_id	Type: string Код этажа
floor_number	Type: string Этаж
layer	Type: string Тип подсказки Default: `staff_room` Enum: `staff_room`
office_id	Type: string Код офиса

SuggestWikiTableOut

Name	Description
id*	Type: string Код записи для Вики-подсказки
orig_id*	Type: string Код записи в Вики
text*	Type: string Текст записи
display_text	Type: string Текст для отображения в интерфейсе
layer	Type: string Тип подсказки Default: `wiki_table_source` Enum: `wiki_table_source`
parent_id	Type: string Код записи в Вики для связанных подсказок
row_id	Type: string Универсальный код записи

SuggestYtTableOut

Name	Description
id*	Type: string Код записи для YT-подсказки
orig_id*	Type: string Код записи в YT
text*	Type: string Текст записи
display_text	Type: string Текст для отображения в интерфейсе
layer	Type: string Тип подсказки Default: `yt_table_source` Enum: `yt_table_source`
parent_id	Type: string Код записи в YT для связанных подсказок
row_id	Type: string Универсальный код записи

SuggestDirUserOut

Name	Description
id*	Type: string Id пользователя
text*	Type: string Имя пользователя
avatar	Type: string Аватар пользователя
cloud_uid	Type: string Uid пользователя в организации Yandex Cloud
email	Type: string Адрес электронной почты пользователя
layer	Type: string Тип подсказки Default: `dir_user` Enum: `dir_user`
login	Type: string Логин пользователя
uid	Type: string Uid пользователя в Яндекс ID
yandex_uid	Type: string Uid пользователя в Яндекс ID

SuggestDirGroupOut

Name	Description
id*	Type: string Код группы в организации Яндекс 360
text*	Type: string Название группы
layer	Type: string Тип подсказки Default: `dir_group` Enum: `dir_group`

SuggestDirDepartmentOut

Name	Description
id*	Type: string Код департамента в организации Яндекс 360
text*	Type: string Название департамента
layer	Type: string Тип подсказки Default: `dir_department` Enum: `dir_department`

SuggestTrackerQueueOut

Name	Description
id*	Type: string Ключ очереди в Трекере
text*	Type: string Название очереди
layer	Type: string Тип подсказки Default: `tracker_queue` Enum: `tracker_queue`

SuggestTrackerProjectOut

Name	Description
id*	Type: string Код проекта в Трекере
text*	Type: string Название проекта в Трекере
layer	Type: string Тип подсказки Default: `tracker_project` Enum: `tracker_project`

SuggestTrackerBoardOut

Name	Description
id*	Type: string Код Agile-доски в Трекере
text*	Type: string Название Agile-доски
layer	Type: string Тип подсказки Default: `tracker_board` Enum: `tracker_board`

SuggestTrackerSprintOut

Name	Description
board*	Type: string Название Agile-доски
id*	Type: string Код спринта в Трекере
text*	Type: string Название спринта
layer	Type: string Тип подсказки Default: `tracker_sprint` Enum: `tracker_sprint`

SuggestTrackerComponentOut

Name	Description
id*	Type: string Код компонента в Трекере
queue*	Type: string Очередь компонента
text*	Type: string Название компонента
layer	Type: string Тип подсказки Default: `tracker_component` Enum: `tracker_component`

SuggestTrackerIssueOut

Name	Description
id*	Type: string Код тикета в Трекере
queue*	Type: string Очередь тикета
status*	Type: string Статус тикета
text*	Type: string Заголовок тикета
layer	Type: string Тип подсказки Default: `tracker_issue` Enum: `tracker_issue`

SuggestTrackerFieldOut

Name	Description
id*	Type: string Код поля в Трекере (с учетом локальных полей)
slug*	Type: string Слаг поля
text*	Type: string Назавание поля
layer	Type: string Тип подсказки Default: `tracker_field` Enum: `tracker_field`
queue	Type: string Очередь поля (для локальных полей)

404 Not Found

Not Found

Body

application/json

{
    "code": "not_found",
    "detail": "string"
}

Name

Description

code*

Type: string

Код ошибки

Enum: not_found

detail*

Type: string

Текст ошибки

408 Request Timeout

Request Timeout

Body

application/json

{
    "code": "connect_timeout",
    "detail": "string"
}

Name

Description

code*

Type: string

Код ошибки

Enum: connect_timeout

detail*

Type: string

Текст ошибки

422 Unprocessable Entity

Unprocessable Entity

Body

application/json

{}

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

Отправить ответ на форму

Обзор