Skip to main content

Чтение установленных параметров работы с событиями по объектам

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

GET /tenants/{tenant_name}/history_settings

Описание​

Выводит установленные значения параметров работы с событиями по объектам.

Параметры​

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

НазваниеОбязательныйТип данныхОписание
tenant_nameдаstringИмя тенанта

Запрос​

curl -X 'GET' $LOGIN_TOKEN \
"https://admin[-<ENV>].<DEFAULT_DOMAIN>/adminapi/\
tenants/<TENANT_NAME>/history_settings" \
-H 'accept: application/json'

где <TENANT_NAME> — имя настраиваемого тенанта.

Ответ​

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

  • 200 — Success — Успешно. Пример вывода:
{
"history_settings": {
"has_history_events": true,
"history_enabled": true,
"history_events_max_count": 0,
"history_expiration_period": 0,
"history_strategy": "string"
},
"id": "string",
"name": "string"
}
  • 401 — Auth header is not provided or token is invalid — Не указан параметр авторизации или некорректный токен. Пример вывода:
{
"message": "string"
}
  • 404 — Tenant not found — Тенант не найден. Пример вывода:
{
"message": "string"
}