Endpunkt des Auditprotokolls

Für jede Experience-Datenmodell (XDM)-Ressource verwaltet das Schema Registry ein Protokoll aller Änderungen, die zwischen verschiedenen Aktualisierungen aufgetreten sind. Mit dem Endpunkt /auditlog in der API Schema Registry können Sie ein Auditprotokoll für jede Klasse, Schemafeldgruppe, jeden Datentyp oder jedes Schema abrufen, die durch eine ID angegeben wurde.

Erste Schritte

Der in diesem Handbuch verwendete API-Endpunkt ist Teil der Schema Registry . Bevor Sie fortfahren, lesen Sie zunächst das Erste-Schritte-Handbuch , um Links zur zugehörigen Dokumentation zu erhalten, eine Anleitung zum Lesen der Beispiel-API-Aufrufe in diesem Dokument und wichtige Informationen zu erforderlichen Kopfzeilen, die für das erfolgreiche Aufrufen von Experience Platform-APIs benötigt werden.

Der Endpunkt /auditlog ist Teil der Remote-Prozeduraufrufe (RPCs), die von Schema Registry unterstützt werden. Im Gegensatz zu anderen Endpunkten in der Schema Registry-API erfordern RPC-Endpunkte keine zusätzlichen Kopfzeilen wie Accept oder Content-Type und verwenden keine CONTAINER_ID. Stattdessen müssen sie den Namespace /rpc verwenden, wie im API-Aufruf unten dargestellt.

Abrufen eines Auditprotokolls für eine Ressource

Sie können ein Prüfprotokoll für jede Klasse, Feldergruppe, jeden Datentyp oder jedes Schema in der Schemabibliothek abrufen, indem Sie die Kennung der Ressource im Pfad einer GET-Anfrage an den Endpunkt /auditlog angeben.

API-Format

GET /rpc/auditlog/{RESOURCE_ID}
Parameter Beschreibung
{RESOURCE_ID} Die meta:altId oder URL-kodierte $id der Ressource, deren Auditprotokoll Sie abrufen möchten.

Anfrage

Mit der folgenden Anfrage wird das Auditprotokoll für eine Feldergruppe Restaurant abgerufen.

curl -X GET \
  https://platform.adobe.io/data/foundation/schemaregistry/rpc/auditlog/_{TENANT_ID}.mixins.922a56b58c6b4e4aeb49e577ec82752106ffe8971b23b4d9 \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

Antwort

Eine erfolgreiche Antwort gibt eine chronologische Liste der Änderungen zurück, die von der letzten zur letzten vorgenommen wurden.

[
  {
    "id": "https://ns.adobe.com/{TENANT_ID}/mixins/922a56b58c6b4e4aeb49e577ec82752106ffe8971b23b4d9",
    "auditTrails": [
      {
        "id": "https://ns.adobe.com/{TENANT_ID}/mixins/922a56b58c6b4e4aeb49e577ec82752106ffe8971b23b4d9",
        "xdmType": "mixins",
        "action": "add",
        "path": "/definitions/customFields/properties/_{TENANT_ID}/properties/brand",
        "value": {
          "title": "Brand",
          "description": "",
          "type": "string",
          "isRequired": false,
          "meta:xdmType": "string"
        }
      },
      {
        "id": "https://ns.adobe.com/{TENANT_ID}/mixins/922a56b58c6b4e4aeb49e577ec82752106ffe8971b23b4d9",
        "xdmType": "mixins",
        "action": "add",
        "path": "/meta:usageCount",
        "value": 0
      }
    ],
    "updatedUser": "{USER_ID}",
    "imsOrg": "{IMS_ORG}",
    "updated": 1606255582281,
    "clientId": "{CLIENT_ID}",
    "sandBoxId": "{SANDBOX_ID}"
  }
]
Eigenschaft Beschreibung
auditTrails Ein Array von Objekten, wobei jedes Objekt eine Änderung an der angegebenen Ressource oder an einer der abhängigen Ressourcen darstellt.
id Die $id der Ressource, die geändert wurde. Dieser Wert stellt normalerweise die im Anfragepfad angegebene Ressource dar, kann jedoch eine abhängige Ressource darstellen, wenn dies die Quelle der Änderung ist.
action Die Art der Änderung, die vorgenommen wurde.
path Eine JSON Pointer-Zeichenfolge, die den Pfad zum spezifischen Feld angibt, das geändert oder hinzugefügt wurde.
value Der Wert, der dem neuen oder aktualisierten Feld zugewiesen wurde.

Auf dieser Seite