Point d’entrée des comportements

Dans le modèle de données d’expérience (XDM), les comportements définissent la nature des données décrites par un schéma. Chaque classe XDM doit faire référence à un comportement spécifique, dont tous les schémas qui utilisent cette classe hériteront. Pour la plupart des cas d’utilisation de Platform, il existe deux comportements disponibles :

  • Enregistrement : Fournit des informations sur les attributs d’un objet. Un sujet peut être une organisation ou un individu.
  • Série temporelle : Fournit un instantané du système au moment où une action a été entreprise directement ou indirectement par un sujet enregistré.
REMARQUE

Dans Platform, certains cas d’utilisation nécessitent l’utilisation d’un schéma qui n’emploie aucun des comportements ci-dessus. Pour ces cas, un troisième comportement "ad hoc" est disponible. Pour plus d’informations, consultez le tutoriel sur la création d’un schéma ad hoc .

Pour des informations plus générales sur les comportements de données en termes d’impact sur la composition des schémas, consultez le guide sur les bases de la composition des schémas.

Le point de terminaison /behaviors de l’API Schema Registry vous permet d’afficher les comportements disponibles dans le conteneur global.

Prise en main

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

Récupération d’une liste de comportements

Vous pouvez récupérer une liste de tous les comportements disponibles en envoyant une requête GET au point de terminaison /behaviors .

Format d’API

GET /global/behaviors

Requête

curl -X GET \
  https://platform.adobe.io/data/foundation/schemaregistry/global/behaviors \
  -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}' \
  -H 'Accept: application/vnd.adobe.xed-id+json'

Réponse

{
    "results": [
        {
            "$id": "https://ns.adobe.com/xdm/data/record",
            "meta:altId": "_xdm.data.record",
            "version": "1.16.4",
            "title": "Record Schema"
        },
        {
            "$id": "https://ns.adobe.com/xdm/data/adhoc",
            "meta:altId": "_xdm.data.adhoc",
            "version": "1.16.4",
            "title": "Ad Hoc Schema"
        },
        {
            "$id": "https://ns.adobe.com/xdm/data/time-series",
            "meta:altId": "_xdm.data.time-series",
            "version": "1.16.4",
            "title": "Time-series Schema"
        }
    ],
    "_page": {
        "orderby": "updated",
        "next": null,
        "count": 3
    },
    "_links": {
        "next": null
    }
}

Rechercher un comportement

Vous pouvez rechercher un comportement spécifique en fournissant son identifiant dans le chemin d’accès d’une requête de GET au point de terminaison /behaviors.

Format d’API

GET /global/behaviors/{BEHAVIOR_ID}
Paramètre Description
{BEHAVIOR_ID} meta:altId ou $id encodé URL du comportement que vous souhaitez rechercher.

Requête

La requête suivante récupère les détails du comportement de l’enregistrement en fournissant son meta:altId dans le chemin de la requête.

curl -X GET \
  https://platform.adobe.io/data/foundation/schemaregistry/global/behaviors/_xdm.data.record \
  -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}' \
  -H 'Accept: application/vnd.adobe.xed+json;version=1'

Réponse

Une réponse réussie renvoie les détails du comportement, y compris sa version, sa description et les attributs que le comportement fournit aux classes qui l’utilisent.

{
    "$id": "https://ns.adobe.com/xdm/data/record",
    "meta:altId": "_xdm.data.record",
    "meta:resourceType": "behaviors",
    "version": "1.16.4",
    "title": "Record Schema",
    "type": "object",
    "description": "Used to indicate the behavior of record data semantic when composed into data schemas.",
    "definitions": {
        "record": {
            "properties": {
                "_id": {
                    "title": "Identifier",
                    "type": "string",
                    "format": "uri-reference",
                    "description": "A unique identifier for the record.",
                    "meta:xdmType": "string",
                    "meta:xdmField": "@id"
                }
            }
        }
    },
    "allOf": [
        {
            "$ref": "#/definitions/record",
            "type": "object",
            "meta:xdmType": "object"
        },
        {
            "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context",
            "type": "object",
            "meta:xdmType": "object"
        }
    ],
    "meta:extensible": true,
    "meta:abstract": true,
    "meta:xdmType": "object",
    "meta:status": "stable",
    "$schema": "http://json-schema.org/draft-06/schema#",
    "meta:registryMetadata": {
        "repo:createdDate": 1606266789446,
        "repo:lastModifiedDate": 1606266789446,
        "eTag": "2cc114a54949a9668fe2ad046ccece59192e1bfa28f14e5ac7c893acb7820ba2",
        "meta:globalLibVersion": "1.16.4"
    }
}

Étapes suivantes

Ce guide couvre lʼutilisation du point d’entrée /behaviors dans lʼAPI Schema Registry Pour savoir comment attribuer un comportement à une classe à l’aide de l’API, consultez le guide de point de terminaison des classes.

Sur cette page