Documentation
Table of Contents
auditlog.get
Beschrijving
integer/array auditlog.get(objectparameters)
De methode maakt het mogelijk om auditlog records op te halen volgens de gegeven parameters.
Deze methode is alleen beschikbaar voor het gebruikerstype Super admin. Machtigingen om de methode aan te roepen kunnen worden ingetrokken in de instellingen van de gebruikersrol. Zie Gebruiker rollen voor meer informatie.
Parameters
(object) Parameters die de gewenste uitvoer definiëren.
De methode ondersteunt de volgende parameters.
| Parameter | Type | Omschrijving |
|---|---|---|
| auditids | string/array | Geeft alleen auditlogboeken terug met de opgegeven ID's. |
| userids | string/array | Geeft alleen auditlogboeken terug die zijn gemaakt door de opgegeven gebruikers. |
| time_from | timestamp | Geeft alleen auditlogboeken terug die zijn gemaakt na of op het opgegeven tijdstip. |
| time_till | timestamp | Geeft alleen auditlogboeken terug die zijn gemaakt vóór of op het opgegeven tijdstip. |
| sortfield | string/array | Sorteer het resultaat op basis van de opgegeven eigenschappen. Mogelijke waarden: auditid, userid, clock. |
| filter | object | Geeft alleen resultaten terug die exact overeenkomen met de opgegeven filter. Accepteert een array waarbij de sleutels eigenschapsnamen zijn en de waarden ofwel een enkele waarde zijn, ofwel een array van waarden om mee te vergelijken. |
| search | object | Zoeken naar deelstrings die niet hoofdlettergevoelig zijn in de inhoud van de velden: username, ip, resourcename, details. |
| countOutput | boolean | Deze parameters, die veel voorkomen bij alle get-methoden, worden beschreven in het referentiecommentaar. |
| excludeSearch | boolean | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
Retourwaarden
(integer/array) Retourneert ofwel:
- een reeks objecten;
- het aantal opgehaalde objecten, als de
countOutputparameter heeft gebruikt.
Voorbeelden
Auditlog ophalen
Haal de twee meest recente auditlogboekvermeldingen op.
{
"jsonrpc": "2.0",
"method": "auditlog.get",
"params": {
"output": "extend",
"sortfield": "clock",
"sortorder": "DESC",
"limit": 2
},
"id": 1
}Reactie:
{
"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
}Zie ook
Bron
CAuditLog::get() in ui/include/classes/api/services/CAuditLog.php.