Skip to main content

Автозаполнение команд

Метод и конечная точка​

GET /autocomplete/teams

Описание​

Возвращает список команд, чьи названия соответствуют заданному шаблону. Используется для функции автозаполнения в интерфейсе.

Параметры​

Перечень параметров представлен в таблице.

НазваниеОбязательныйТип данныхОписание
nameдаstringШаблон для поиска (часть названия команды)

Запрос​

curl -X 'GET' \
'https://im-<ENV>.<DEFAULT_DOMAIN>/api/v1/autocomplete/teams?name=<SEARCH_TEXT>' \
-H 'accept: application/json' \
-H 'X-User-Id: <USER_ID>' \
-H 'x-auth-token: <AUTH_TOKEN>'

Где:

  • <ENV> — окружение, на котором выполняется запрос;
  • <DEFAULT_DOMAIN> — домен сервера Squadus;
  • <USER_ID> — идентификатор пользователя, от имени которого выполняется запрос;
  • <AUTH_TOKEN> — токен аутентификации пользователя;
  • <SEARCH_TEXT> — текст для поиска.

Ответ​

200 — Teams — Список команд. Пример вывода:

{
"success": true,
"data": [
{
"_id": "team_123456",
"name": "Development Team",
"weight": 1
}
]
}