Skip to main content

Получение списка публичных ссылок

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

GET /tenants/{tenant_name}/public_links

Описание​

Возвращает список публичных ссылок в тенанте.

Параметры​

Параметры для метода указаны в таблице.

НазваниеОбязательныйТип данныхОписание
offsetнетstringПараметр настройки выдачи результатов поиска
limitнетstringОграничения поиска
sort_byнетstringСортировать по параметрам
ascнетstringПорядок сортировки результатов выдачи
tenant_nameдаstringИмя тенанта

Запрос​

curl -X 'GET' $LOGIN_TOKEN \
"https://admin[-<ENV>].<DEFAULT_DOMAIN>/adminapi/\
tenants/<TENANT_NAME>/public_links?offset=<OFFSET>&\
limit=<LIMIT>&sort_by=<SORT_BY>&asc=<ASC>" \
-H 'accept: application/json'

где:

  • <TENANT_NAME> — имя тенанта;

  • <OFFSET> — параметр настройки выдачи результатов поиска;

  • <LIMIT> — ограничения поиска;

  • <SORT_BY> — сортировка по параметрам;

  • <ASC> — сортировка результатов поиска.

Ответ​

Возможные варианты ответов:

  • 200 — Success — Успешно. Пример вывода:
{
"count": 0,{
"public_links": [
"end_time": 0,
"first_name": "string",
"is_password": true,
"key": 0,
"last_name": "string",
"object_name": "string",
"object_type": "string",
"owner_id": "string",
"start_time": "string",
"status": "string",
"type": "string",
}
]
}