Documentation
Table of Contents
auditlog.get
Опис
integer/array auditlog.get(object parameters)
Метод дозволяє отримувати записи журналу аудиту за заданими параметрами.
Цей метод доступний лише для користувачів типу Суперадміністратор. Дозволи на виклик методу можна скасувати в налаштуваннях ролі користувача. Див. [Ролі користувача (/manual/web_interface/frontend_sections/administration/user_roles) для отримання додаткової інформації.
Параметри
(object) Параметри, що визначають бажаний результат.
Метод підтримує такі параметри.
| Параметр | Тип | Опис |
|---|---|---|
| auditids | рядок/масив | Повернути лише журнал аудиту з указаними ідентифікаторами. |
| ідентифікатори користувачів | рядок/масив | Повертає лише журнал аудиту, створений вказаними користувачами. |
| time_from | timestamp | Повертає лише записи журналу аудиту, які були створені після або в заданий час. |
| time_till | timestamp | Повертає лише записи журналу аудиту, які були створені до або в заданий час. |
| sortfield | рядок/масив | Відсортуйте результат за заданими властивостями. Можливі значення: auditid, userid, clock. |
| фільтр | об'єкт | Повертає лише результати, які точно відповідають заданому фільтру. Приймає масив, де ключі є іменами властивостей, а значення є або одним значенням, або масивом значень для порівняння.< br> Додатково підтримує фільтрацію за полями властивостей деталей: table_name, field_name. |
| search | object | Пошук підрядка без урахування регістру у вмісті полів: username, ip, resourcename, details. |
| countOutput | boolean | Ці параметри, які є спільними для всіх методів get, описані в довідковому коментарі. |
| excludeSearch | boolean | |
| ліміт | ціле | |
| вивід | запит | |
| preservekeys | boolean | |
| searchByAny | логічний | |
| увімкнено знаки підстановки | логічний | |
| порядок сортування | рядок/масив | |
| почати пошук | логічний |
Повернуті значення
(integer/array) Повертає або:
- масив об'єктів;
- кількість отриманих об'єктів, якщо використовувався параметр
countOutput.
Приклади
Отримати журнал аудиту
Отримати два останні записи журналу аудиту.
Запит:
{ "jsonrpc": "2.0", "method": "auditlog.get", "params": { "output": "extend", "sortfield": "clock", "sortorder": "DESC", "limit": 2 }, "auth": "038e1d7b1735c6a5436ee9eae095879e", "id": 1 }Відповідь:
{ "jsonrpc": "2.0", "result": [ { "auditid": "cksstgfam0001yhdcc41y20q2", "userid": "1", "username": "Admin", "clock": "1629975715", "ip": "127.0.0.1", "action": "1", "resourcetype": "0", "resourceid": "0", "resourcename": "Jim", "recordsetid": "cksstgfal0000yhdcso67ondl", "details": "{\"user.name\":[\"update\",\"Jim\",\"\"],\"user.medias[37]\":[\"add\"],\"user.medias[37].\":[\"add\"],\"user.medias[37].mediatypeid\":[\"add\",\"1\"],\"user.medias[37].sendto\":[\"add\",\"[email protected]\"]}" }, { "auditid": "ckssofl0p0001yhdcqxclsg8r", "userid": "1", "username": "Admin", "clock": "1629967278", "ip": "127.0.0.1", "action": "0", "resourcetype": "0", "resourceid": "20", "resourcename": "John", "recordsetid": "ckssofl0p0000yhdcpxyo1jgo", "details": "{\"user.username\":[\"add\",\"John\"], \"user.userid:\":[\"add\",\"20\"],\"user.usrgrps[28]\":[\"add\"],\"user.usrgrps[28].usrgrpid\":[\"add\", \"7\"]}" } ], "id": 1 }Дивись також
Джерело
CAuditLog::get() у ui/include/classes/api/services/CAuditLog.php.