Point d’entrée du journal d’audit

Pour chaque ressource du modèle de données d’expérience (XDM), le Schema Registry conserve un journal de toutes les modifications qui se sont produites entre différentes mises à jour. Le point d’entrée /auditlog de l’API Schema Registry vous permet de récupérer un journal d’audit pour n’importe quelle classe, groupe de champs de schéma, type de données ou schéma spécifié par l’ID.

Prise en main

Le point d’entrée utilisé dans ce guide fait partie de l’API 🔗. Schema Registry Avant de continuer, consultez le guide de prise en main pour obtenir des liens vers la documentation associée, un guide de lecture des exemples d’appels API dans ce document et des informations importantes sur les en-têtes requis pour réussir des appels vers n’importe quelle API d’Experience Platform.

Le point d’entrée /auditlog fait partie des appels de procédure distante (RPC) pris en charge par le Schema Registry. Contrairement aux autres points d’entrée de l’API Schema Registry, les points d’entrée RPC ne nécessitent pas d’en-têtes supplémentaires tels que Accept ou Content-Type, et n’utilisent pas de CONTAINER_ID. Ils doivent plutôt utiliser l’espace de noms /rpc, comme illustré dans l’appel API ci-dessous.

Récupération d’un journal d’audit pour une ressource

Vous pouvez récupérer un journal d’audit pour n’importe quelle classe, groupe de champs, type de données ou schéma de la bibliothèque de schémas en spécifiant l’identifiant de la ressource dans le chemin d’accès d’une requête GET au point d’entrée /auditlog.

Format d’API

GET /rpc/auditlog/{RESOURCE_ID}
Paramètre
Description
{RESOURCE_ID}
$id codée en meta:altId ou en URL de la ressource dont vous souhaitez récupérer le journal d’audit.

Requête

La requête suivante récupère le journal d’audit d’un schéma.

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

Réponse

Une réponse réussie renvoie une liste chronologique des modifications apportées à la ressource, du plus récent au moins récent.

[
  {
    "id": "https://ns.adobe.com/{TENANT_ID}/schemas/50649eb1b040bf042d6400a0335901cd2a97d31a4eac4330",
    "updatedUser": "{USER_ID}",
    "imsOrg": "{ORG_ID}",
    "updatedTime": "02-19-2021 05:43:56",
    "requestId": "a14NMF0jd6BIfyXaHdTDl4bC4R0r9rht",
    "clientId": "{CLIENT_ID}",
    "sandBoxId": "28e74200-e3de-11e9-8f5d-7f27416c5f0d",
    "updates": [
      {
        "id": "https://ns.adobe.com/{TENANT_ID}/schemas/50649eb1b040bf042d6400a0335901cd2a97d31a4eac4330",
        "xdmType": "schemas",
        "action": "remove",
        "path": "/meta:usageCount",
        "value": 0
      }
    ]
  },
  {
    "id": "https://ns.adobe.com/{TENANT_ID}/schemas/50649eb1b040bf042d6400a0335901cd2a97d31a4eac4330",
    "updatedUser": "{USER_ID}",
    "imsOrg": "{ORG_ID}",
    "updatedTime": "02-19-2021 05:43:56",
    "requestId": "pFQbgmWrdbJrNB9GdxTSGECpXYWspu68",
    "clientId": "{CLIENT_ID}",
    "sandBoxId": "28e74200-e3de-11e9-8f5d-7f27416c5f0d",
    "updates": [
      {
        "id": "https://ns.adobe.com/{TENANT_ID}/classes/11052164b588f0c29584bf6ae1a6663a59aa65426c82389f",
        "xdmType": "classes",
        "action": "remove",
        "path": "/definitions/customFields/properties/_{TENANT_ID}/properties/loyaltySunday_ABC",
        "value": {
          "title": "LoyaltySundayABC",
          "description": "",
          "type": "string",
          "isRequired": false,
          "required": [],
          "meta:xdmType": "string"
        }
      },
      {
        "id": "https://ns.adobe.com/{TENANT_ID}/classes/11052164b588f0c29584bf6ae1a6663a59aa65426c82389f",
        "xdmType": "classes",
        "action": "remove",
        "path": "/definitions/customFields/properties/_{TENANT_ID}/properties/loyaltyMoxee_XYZ",
        "value": {
          "title": "LoyaltyMoxeeXYZ",
          "description": "",
          "type": "string",
          "isRequired": false,
          "required": [],
          "meta:xdmType": "string"
        }
      }
    ]
  }
]
Propriété
Description
updates
Tableau d’objets, où chaque objet représente une modification apportée à la ressource spécifiée ou à l’une de ses ressources dépendantes.
id
$id de la ressource qui a été modifiée. Cette valeur représente généralement la ressource spécifiée dans le chemin d’accès de la requête, mais peut représenter une ressource dépendante si c’est la source de la modification.
xdmType
Type de ressource qui a été modifié.
action
Type de changement qui a été apporté.
path
Chaîne pointeur JSON indiquant le chemin d’accès au champ spécifique qui a été modifié ou ajouté.
value
Valeur affectée au champ nouveau ou mis à jour.
recommendation-more-help
experience-platform-help-xdm