Creación de un esquema ad-hoc

En circunstancias específicas, puede que sea necesario crear un esquema Experience Data Model (XDM) con campos a los que sólo un conjunto de datos tiene un nombre para su uso. Esto se denomina esquema "ad-hoc". Los esquemas específicos se utilizan en diversos flujos de trabajo de ingestión de datos para Experience Platform, incluida la ingesta de archivos CSV y la creación de determinados tipos de conexiones de origen.

Este documento proporciona pasos generales para crear un esquema ad-hoc mediante la API del Registro de Esquema. Está diseñado para utilizarse junto con otros tutoriales Experience Platform que requieren la creación de un esquema ad-hoc como parte de su flujo de trabajo. Cada uno de esos documentos proporciona información detallada sobre cómo configurar correctamente un esquema ad-hoc para su caso de uso específico.

Primeros pasos

Este tutorial requiere un conocimiento práctico del sistema Experience Data Model (XDM). Antes de iniciar este tutorial, consulte la siguiente documentación de XDM:

Antes de iniciar este tutorial, consulte la guía para desarrolladores para obtener información importante que debe conocer a fin de realizar llamadas exitosas a la API Schema Registry. Esto incluye su {TENANT_ID}, el concepto de "contenedores" y los encabezados requeridos para realizar solicitudes (con especial atención al encabezado Accept y sus posibles valores).

Creación de una clase ad-hoc

El comportamiento de los datos de un esquema XDM viene determinado por su clase subyacente. El primer paso para crear un esquema ad-hoc es crear una clase basada en el comportamiento adhoc. Esto se realiza realizando una solicitud de POST al extremo /tenant/classes.

Formato API

POST /tenant/classes

Solicitud

La siguiente solicitud crea una nueva clase XDM, configurada por los atributos suministrados en la carga útil. Al proporcionar una propiedad $ref establecida en https://ns.adobe.com/xdm/data/adhoc en la matriz allOf, esta clase hereda el comportamiento adhoc. La solicitud también define un objeto _adhoc, que contiene los campos personalizados de la clase.

NOTA

Los campos personalizados definidos en _adhoc varían según el caso de uso del esquema ad-hoc. Consulte el flujo de trabajo específico en el tutorial correspondiente para los campos personalizados requeridos según el caso de uso.

curl -X POST \
  https://platform.adobe.io/data/foundation/schemaregistry/tenant/classes \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '{
        "title":"New ad-hoc class",
        "description": "New ad-hoc class description",
        "type":"object",
        "allOf": [
          {
            "$ref":"https://ns.adobe.com/xdm/data/adhoc"
          },
          {
            "properties": {
              "_adhoc": {
                "type":"object",
                "properties": {
                  "field1": {
                    "type":"string"
                  },
                  "field2": {
                    "type":"string"
                  }
                }
              }
            }
          }
        ]
      }'
Propiedad Descripción
$ref El comportamiento de los datos de la nueva clase. Para las clases ad-hoc, este valor debe establecerse en https://ns.adobe.com/xdm/data/adhoc.
properties._adhoc Objeto que contiene los campos personalizados de la clase, expresados como pares de clave-valor de los nombres de campo y los tipos de datos.

Respuesta

Una respuesta correcta devuelve los detalles de la nueva clase, reemplazando el nombre del objeto properties._adhoc por un GUID que es un identificador único de sólo lectura para la clase generado por el sistema. El atributo meta:datasetNamespace también se genera automáticamente y se incluye en la respuesta.

{
    "$id": "https://ns.adobe.com/{TENANT_ID}/classes/6395cbd58812a6d64c4e5344f7b9120f",
    "meta:altId": "_{TENANT_ID}.classes.6395cbd58812a6d64c4e5344f7b9120f",
    "meta:resourceType": "classes",
    "version": "1.0",
    "title": "New Class",
    "description": "New class description",
    "type": "object",
    "allOf": [
        {
            "$ref": "https://ns.adobe.com/xdm/data/adhoc"
        },
        {
            "properties": {
                "_6395cbd58812a6d64c4e5344f7b9120f": {
                    "type": "object",
                    "properties": {
                        "field1": {
                            "type": "string",
                            "meta:xdmType": "string"
                        },
                        "field2": {
                            "type": "string",
                            "meta:xdmType": "string"
                        }
                    },
                    "meta:xdmType": "object"
                }
            },
            "type": "object",
            "meta:xdmType": "object"
        }
    ],
    "meta:abstract": true,
    "meta:extensible": true,
    "meta:extends": [
        "https://ns.adobe.com/xdm/data/adhoc"
    ],
    "meta:containerId": "tenant",
    "meta:datasetNamespace": "_6395cbd58812a6d64c4e5344f7b9120f",
    "imsOrg": "{IMS_ORG}",
    "meta:xdmType": "object",
    "meta:registryMetadata": {
        "repo:createdDate": 1557527784822,
        "repo:lastModifiedDate": 1557527784822,
        "xdm:createdClientId": "{CREATED_CLIENT}",
        "xdm:lastModifiedClientId": "{MODIFIED_CLIENT}",
        "eTag": "Jggrlh4PQdZUvDUhQHXKx38iTQo="
    }
}
Propiedad Descripción
$id URI que sirve como identificador único de sólo lectura generado por el sistema para la nueva clase ad-hoc. Este valor se utiliza en el siguiente paso de la creación de un esquema ad-hoc.

Creación de un esquema ad-hoc

Una vez que haya creado una clase ad-hoc, puede crear un nuevo esquema que implemente esa clase realizando una solicitud de POST al extremo /tenant/schemas.

Formato API

POST /tenant/schemas

Solicitud

La siguiente solicitud crea un nuevo esquema, que proporciona una referencia ($ref) a $id de la clase ad-hoc creada previamente en su carga útil.

curl -X POST \
  https://platform.adobe.io/data/foundation/schemaregistry/tenant/schemas \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '{
        "title":"New Schema",
        "description": "New schema description.",
        "type":"object",
        "allOf": [
          {
            "$ref":"https://ns.adobe.com/{TENANT_ID}/classes/6395cbd58812a6d64c4e5344f7b9120f"
          }
        ]
      }'

Respuesta

Una respuesta correcta devuelve los detalles del esquema recién creado, incluido su $id de sólo lectura generado por el sistema.

{
    "$id": "https://ns.adobe.com/{TENANT_ID}/schemas/26f6833e55db1dd8308aa07a64f2042d",
    "meta:altId": "_{TENANT_ID}.schemas.26f6833e55db1dd8308aa07a64f2042d",
    "meta:resourceType": "schemas",
    "version": "1.0",
    "title": "New Schema",
    "description": "New schema description.",
    "type": "object",
    "allOf": [
        {
            "$ref": "https://ns.adobe.com/{TENANT_ID}/classes/6395cbd58812a6d64c4e5344f7b9120f"
        }
    ],
    "meta:datasetNamespace": "_6395cbd58812a6d64c4e5344f7b9120f",
    "meta:class": "https://ns.adobe.com/{TENANT_ID}/classes/6395cbd58812a6d64c4e5344f7b9120f",
    "meta:abstract": false,
    "meta:extensible": false,
    "meta:extends": [
        "https://ns.adobe.com/{TENANT_ID}/classes/6395cbd58812a6d64c4e5344f7b9120f",
        "https://ns.adobe.com/xdm/data/adhoc"
    ],
    "meta:containerId": "tenant",
    "imsOrg": "{IMS_ORG}",
    "meta:xdmType": "object",
    "meta:registryMetadata": {
        "repo:createdDate": 1557528570542,
        "repo:lastModifiedDate": 1557528570542,
        "xdm:createdClientId": "{CREATED_CLIENT}",
        "xdm:lastModifiedClientId": "{MODIFIED_CLIENT}",
        "eTag": "Jggrlh4PQdZUvDUhQHXKx38iTQo="
    }
}

Vista del esquema ad hoc completo

NOTA

Este paso es opcional. Si no desea inspeccionar la estructura de campo de su esquema ad-hoc, puede saltar a la sección siguientes pasos al final de este tutorial.

Una vez creado el esquema ad-hoc, puede realizar una solicitud de búsqueda (GET) para vista del esquema en su formulario ampliado. Esto se lleva a cabo utilizando el encabezado Accept adecuado en la solicitud de GET, como se muestra a continuación.

Formato API

GET /tenant/schemas/{SCHEMA_ID}
Parámetro Descripción
{SCHEMA_ID} El URI $id con codificación URL o meta:altId del esquema ad-hoc al que desea acceder.

Solicitud

La siguiente solicitud utiliza el encabezado Accept application/vnd.adobe.xed-full+json; version=1, que devuelve la forma expandida del esquema. Tenga en cuenta que al recuperar un recurso específico desde Schema Registry, el encabezado Accept de la solicitud debe incluir una versión principal del recurso en cuestión.

curl -X GET \
  https://platform.adobe.io/data/foundation/schemaregistry/tenant/schemas/_{TENANT_ID}.schemas.26f6833e55db1dd8308aa07a64f2042d \
  -H 'Accept: application/vnd.adobe.xed-full+json; version=1' \
  -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}' \

Respuesta

Una respuesta correcta devuelve los detalles del esquema, incluidos todos los campos anidados en properties.

{
    "$id": "https://ns.adobe.com/{TENANT_ID}/schemas/26f6833e55db1dd8308aa07a64f2042d",
    "meta:altId": "_{TENANT_ID}.schemas.26f6833e55db1dd8308aa07a64f2042d",
    "meta:resourceType": "schemas",
    "version": "1.0",
    "title": "New Schema",
    "description": "New schema description.",
    "type": "object",
    "meta:datasetNamespace": "_6395cbd58812a6d64c4e5344f7b9120f",
    "meta:class": "https://ns.adobe.com/{TENANT_ID}/classes/6395cbd58812a6d64c4e5344f7b9120f",
    "meta:abstract": false,
    "meta:extensible": false,
    "meta:extends": [
        "https://ns.adobe.com/{TENANT_ID}/classes/6395cbd58812a6d64c4e5344f7b9120f",
        "https://ns.adobe.com/xdm/data/adhoc"
    ],
    "meta:containerId": "tenant",
    "imsOrg": "{IMS_ORG}",
    "meta:xdmType": "object",
    "properties": {
        "_6395cbd58812a6d64c4e5344f7b9120f": {
            "type": "object",
            "meta:xdmType": "object",
            "properties": {
                "field1": {
                    "type": "string",
                    "meta:xdmType": "string"
                },
                "field2": {
                    "type": "string",
                    "meta:xdmType": "string"
                }
            }
        }
    },
    "meta:registryMetadata": {
        "repo:createdDate": 1557528570542,
        "repo:lastModifiedDate": 1557528570542,
        "xdm:createdClientId": "{CREATED_CLIENT}",
        "xdm:lastModifiedClientId": "{MODIFIED_CLIENT}",
        "eTag": "bTogM1ON2LO/F7rlcc1iOWmNVy0="
    }
}

Pasos siguientes

Siguiendo este tutorial, ha creado correctamente un nuevo esquema ad-hoc. Si ha sido traído a este documento como parte de otro tutorial, ahora puede utilizar el $id de su esquema ad-hoc para completar el flujo de trabajo como se le ha indicado.

Para obtener más información sobre cómo trabajar con la API Schema Registry, consulte la guía para desarrolladores.

En esta página

Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free