Skip to main content

Überwachungsprotokolle (Auditlogs): Endpunkt

Anmerkung

Diese Hilfeseite beschreibt die Verwendung eines Server-API-Endpunkts. Alles, was Sie für Ihre ersten Schritte mit der Server-API benötigen, finden Sie in der Server API-Übersicht.API-Übersicht

Server verfolgt Änderungen an diesen System-Entitäten:

  • AppInfo (Workflow)

  • Sammlung

  • Anmeldedaten

  • Abonnement

  • Benutzer

  • UserGroup

Protokollierte Ereignisse über die Server-API abrufen

Alle Aktualisierungen dieser Entitäten lösen einen Eintrag für ein Überwachungsereignis (AuditEvent) aus. Sie können diese Einträge über einen öffentlichen Admin-API-Endpunkt zurückgeben.

Auditprotokolle werden durch die folgenden Arten von Vorgängen (Ereignissen) ausgelöst: Aktualisierung, Einfügen und Löschen.

Endpunkt

Der Endpunkt für AuditEvents ist GET /admin/v1/auditlog/

Erforderliche Abfrageparameter

  • entity: (Zeichenfolge) die Überwachungsprotokoll-Entität, die Sie abfragen möchten.

  • page: (Ganzzahl) die Seite, die Sie zurückgeben möchten.

  • pageSize: (Ganzzahl) die Anzahl der Datensätze, die Sie auf jeder Seite zurückgeben möchten.

Die Antwort besteht aus einem Array von Einträgen der Überwachungsereignisse:

[ { "id": "", "entity": "", "entityId": "", "userId": "", "timestamp": "Date", "event": "", "oldValues": "", "newValues": "" } ]

Die zurückgegebenen Eigenschaften sind wie folgt definiert:

  • id: die Überwachungsereignis-ID.

  • entity: der Name der Entität.

  • entityId: die Entitäts-ID der Entität.

  • userId: die ID des Benutzers, der die Entität geändert hat.

  • timestamp: Datum und Uhrzeit der Datensatzerstellung für das Überwachungsereignis.

  • event: das aufgetretene Ereignis (Einfügen, Aktualisieren, Löschen).

  • oldValues: die Werte der aktualisierten Eigenschaften vor der Aktualisierung.

  • newValues: die Werte der aktualisierten Eigenschaften nach der Aktualisierung.