Todos los esquemas del Modelo de datos de experiencia (XDM) deben basarse en una clase. Una clase determina la estructura base de las propiedades comunes que deben contener todos los esquemas basados en esa clase, así como los grupos de campos de esquema que pueden utilizarse en esos esquemas. Además, la clase de un esquema determina los aspectos de comportamiento de los datos que contendrá un esquema, de los cuales hay dos tipos:
Para obtener más información sobre los comportamientos de los datos en términos de cómo afectan a la composición del esquema, consulte la conceptos básicos de la composición del esquema.
La variable /classes
en la variable Schema Registry La API le permite administrar clases mediante programación dentro de la aplicación de experiencia.
El extremo utilizado en esta guía forma parte de la Schema Registry API de . Antes de continuar, revise la guía de introducción para ver vínculos a documentación relacionada, una guía para leer las llamadas de API de ejemplo en este documento e información importante sobre los encabezados necesarios para realizar llamadas correctamente a cualquier API de Experience Platform.
Puede enumerar todas las clases en la sección global
o tenant
contenedor realizando una solicitud de GET a /global/classes
o /tenant/classes
, respectivamente.
Al enumerar recursos, el Registro de esquemas limita los conjuntos de resultados a 300 elementos. Para devolver recursos más allá de este límite, debe utilizar parámetros de paginación. También se recomienda utilizar parámetros de consulta adicionales para filtrar los resultados y reducir el número de recursos devueltos. Consulte la sección sobre parámetros de consulta en el documento del apéndice para obtener más información.
Formato de API
GET /{CONTAINER_ID}/classes?{QUERY_PARAMS}
Parámetro | Descripción |
---|---|
{CONTAINER_ID} |
El contenedor desde el que desea recuperar las clases: global para clases creadas por Adobe o tenant para clases propiedad de su organización. |
{QUERY_PARAMS} |
Parámetros de consulta opcionales para filtrar los resultados por. Consulte la documento apéndice para obtener una lista de los parámetros disponibles. |
Solicitud
La siguiente solicitud recupera una lista de clases de la variable tenant
contenedor, utilizando un orderby
parámetro de consulta para ordenar las clases por sus title
atributo.
curl -X GET \
https://platform.adobe.io/data/foundation/schemaregistry/tenant/classes?orderby=title \
-H 'Accept: application/vnd.adobe.xed-id+json' \
-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}'
El formato de respuesta depende de la variable Accept
encabezado enviado en la solicitud. Lo siguiente Accept
los encabezados están disponibles para las clases de lista:
Accept header |
Descripción |
---|---|
application/vnd.adobe.xed-id+json |
Devuelve un breve resumen de cada recurso. Este es el encabezado recomendado para listar recursos. (Límite: 300) |
application/vnd.adobe.xed+json |
Devuelve la clase JSON completa para cada recurso, con el original $ref y allOf incluido. (Límite: 300) |
Respuesta
La solicitud anterior utilizaba la variable application/vnd.adobe.xed-id+json
Accept
encabezado, por lo tanto, la respuesta solo incluye la variable title
, $id
, meta:altId
y version
atributos para cada clase. Uso del otro Accept
encabezado (application/vnd.adobe.xed+json
) devuelve todos los atributos de cada clase. Seleccione el Accept
según la información que necesite en su respuesta.
{
"results": [
{
"$id": "https://ns.adobe.com/{TENANT_ID}/classes/01b7b1745e8ac4ed1e8784ec91b6afa7",
"meta:altId": "_{TENANT_ID}.classes.01b7b1745e8ac4ed1e8784ec91b6afa7",
"version": "1.0",
"title": "Hotel"
},
{
"$id": "https://ns.adobe.com/{TENANT_ID}/classes/d43b86253676af50da3f671ecdd26ff9",
"meta:altId": "_{TENANT_ID}.classes.d43b86253676af50da3f671ecdd26ff9",
"version": "1.1",
"title": "Property"
},
{
"$id": "https://ns.adobe.com/{TENANT_ID}/classes/366f015dbfea802455fbc46c3b27f771",
"meta:altId": "_{TENANT_ID}.classes.366f015dbfea802455fbc46c3b27f771",
"version": "1.0",
"title": "Subscription"
}
],
"_page": {
"orderby": "title",
"next": null,
"count": 3
},
"_links": {
"next": null,
"global_schemas": {
"href": "https://platform.adobe.io/data/foundation/schemaregistry/global/classes"
}
}
}
Puede buscar una clase específica incluyendo el ID de la clase en la ruta de una solicitud de GET.
Formato de API
GET /{CONTAINER_ID}/classes/{CLASS_ID}
Parámetro | Descripción |
---|---|
{CONTAINER_ID} |
El contenedor que alberga la clase que desea recuperar: global para una clase creada por Adobe o tenant para una clase propiedad de su organización. |
{CLASS_ID} |
La variable meta:altId o con codificación de URL $id de la clase que desea buscar. |
Solicitud
La siguiente solicitud recupera una clase mediante su meta:altId
en la ruta.
curl -X GET \
https://platform.adobe.io/data/foundation/schemaregistry/tenant/classes/_{TENANT_ID}.classes.f579a0b5f992c69458ea408ec36571f7da9de15901bab116 \
-H 'Accept: application/vnd.adobe.xed+json' \
-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}'
El formato de respuesta depende de la variable Accept
encabezado enviado en la solicitud. Todas las solicitudes de búsqueda requieren un version
se incluya en el Accept
encabezado. Lo siguiente Accept
los encabezados están disponibles:
Accept header |
Descripción |
---|---|
application/vnd.adobe.xed+json; version=1 |
Sin procesar con $ref y allOf , tiene títulos y descripciones. |
application/vnd.adobe.xed-full+json; version=1 |
$ref y allOf resuelto, tiene títulos y descripciones. |
application/vnd.adobe.xed-notext+json; version=1 |
Sin procesar con $ref y allOf , sin títulos ni descripciones. |
application/vnd.adobe.xed-full-notext+json; version=1 |
$ref y allOf resuelto, sin títulos ni descripciones. |
application/vnd.adobe.xed-full-desc+json; version=1 |
$ref y allOf resuelto, incluidos los descriptores. |
Respuesta
Una respuesta correcta devuelve los detalles de la clase. Los campos devueltos dependen de la variable Accept
encabezado enviado en la solicitud. Experimento con diferentes Accept
para comparar las respuestas y determinar qué encabezado es el mejor para su caso de uso.
{
"$id":"https://ns.adobe.com/{TENANT_ID}/classes/f8bbdc3c49d49eae62d1c17e867230ac3de6b5b63b0615ce",
"meta:altId":"_{TENANT_ID}.classes.f8bbdc3c49d49eae62d1c17e867230ac3de6b5b63b0615ce",
"meta:resourceType":"classes",
"version":"1.1",
"title":"Hotel",
"type":"object",
"description":"Base class for the Hotels schema",
"definitions":{
"customFields":{
"type":"object",
"properties":{
"_{TENANT_ID}":{
"type":"object",
"properties":{
"Address":{
"title":"Address",
"description":"",
"isRequired":false,
"$ref":"https://ns.adobe.com/xdm/common/address",
"type":"object",
"meta:xdmType":"object"
},
"phoneNumber":{
"title":"Phone Number",
"description":"",
"isRequired":false,
"$ref":"https://ns.adobe.com/xdm/context/phonenumber",
"type":"object",
"meta:xdmType":"object"
},
"brand":{
"title":"Brand",
"description":"",
"type":"string",
"isRequired":false,
"meta:xdmType":"string"
},
"hotelId":{
"title":"Hotel ID",
"description":"",
"type":"string",
"isRequired":false,
"meta:xdmType":"string"
}
},
"meta:xdmType":"object"
}
},
"meta:xdmType":"object"
}
},
"allOf":[
{
"$ref":"https://ns.adobe.com/xdm/data/record",
"type":"object",
"meta:xdmType":"object"
},
{
"$ref":"#/definitions/customFields",
"type":"object",
"meta:xdmType":"object"
}
],
"imsOrg":"{ORG_ID}",
"meta:extensible":true,
"meta:abstract":true,
"meta:extends":[
"https://ns.adobe.com/xdm/data/record"
],
"meta:xdmType":"object",
"meta:registryMetadata":{
"repo:createdDate":1593643258779,
"repo:lastModifiedDate":1597246362579,
"xdm:createdClientId":"{CLIENT_ID}",
"xdm:lastModifiedClientId":"{CLIENT_ID}",
"xdm:createdUserId":"{USER_ID}",
"xdm:lastModifiedUserId":"{USER_ID}",
"eTag":"502f89ee16b8ab2e6b4ea09ecf0ab1e5614907db755051c1f3c65a273001d725",
"meta:globalLibVersion":"1.15.4"
},
"meta:containerId":"tenant",
"meta:tenantNamespace":"_{TENANT_ID}"
}
Puede definir una clase personalizada en la sección tenant
al realizar una solicitud de POST.
Al componer un esquema basado en una clase personalizada que defina, no podrá utilizar grupos de campos estándar. Cada grupo de campos define las clases con las que son compatibles en sus meta:intendedToExtend
atributo. Una vez que comience a definir grupos de campos compatibles con la nueva clase (mediante la función $id
de su nueva clase en el meta:intendedToExtend
del grupo de campos), podrá reutilizar esos grupos de campos cada vez que defina un esquema que implemente la clase definida. Consulte las secciones de creación de grupos de campos y creación de esquemas en sus respectivas guías de punto final para obtener más información.
Si planea utilizar esquemas basados en clases personalizadas en el perfil del cliente en tiempo real, también es importante tener en cuenta que los esquemas de unión solo se construyen en función de esquemas que comparten la misma clase. Si desea incluir un esquema de clase personalizada en la unión para otra clase como Perfil individual XDM o XDM ExperienceEvent, debe establecer una relación con otro esquema que emplee esa clase. Consulte el tutorial en establecimiento de una relación entre dos esquemas en la API para obtener más información.
Formato de API
POST /tenant/classes
Solicitud
La solicitud para crear (POST) una clase debe incluir un allOf
que contiene un $ref
a uno de dos valores: https://ns.adobe.com/xdm/data/record
o https://ns.adobe.com/xdm/data/time-series
. Estos valores representan el comportamiento en el que se basa la clase (registro o serie temporal, respectivamente). Para obtener más información sobre las diferencias entre los datos de registros y los datos de series temporales, consulte la sección sobre tipos de comportamiento dentro de la variable conceptos básicos de la composición del esquema.
Al definir una clase, también puede incluir grupos de campos o campos personalizados en la definición de la clase. Esto haría que los grupos de campos y campos añadidos se incluyeran en todos los esquemas que implementan la clase. En el siguiente ejemplo de solicitud se define una clase denominada "Propiedad", que captura información sobre las distintas propiedades que posee y gestiona una empresa. Incluye un propertyId
campo que se incluirá cada vez que se utilice la clase.
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: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '{
"title":"Property",
"description":"Properties owned and operated by the company.",
"type":"object",
"definitions": {
"property": {
"properties": {
"_{TENANT_ID}": {
"type": "object",
"properties": {
"property": {
"title": "Property Information",
"type": "object",
"description": "Information about different owned and operated properties.",
"properties": {
"propertyId": {
"title": "Property Identification Number",
"type": "string",
"description": "Unique Property identification number"
}
}
}
}
}
},
"type": "object"
}
},
"allOf": [
{
"$ref": "https://ns.adobe.com/xdm/data/record"
},
{
"$ref": "#/definitions/property"
}
]
}'
Propiedad | Descripción |
---|---|
_{TENANT_ID} |
La variable TENANT_ID espacio de nombres para su organización. Todos los recursos creados por su organización deben incluir esta propiedad para evitar conflictos con otros recursos en Schema Registry. |
allOf |
Una lista de recursos cuyas propiedades va a heredar la nueva clase. Uno de los $ref Los objetos de la matriz definen el comportamiento de la clase. En este ejemplo, la clase hereda el comportamiento "record". |
Respuesta
Una respuesta correcta devuelve el estado HTTP 201 (Creado) y una carga útil que contiene los detalles de la clase recién creada, incluida la variable $id
, meta:altId
y version
. Estos tres valores son de solo lectura y son asignados por la variable Schema Registry.
{
"title": "Property",
"description": "Properties owned and operated by the company.",
"type": "object",
"definitions": {
"property": {
"properties": {
"_{TENANT_ID}": {
"type": "object",
"properties": {
"property": {
"title": "Property Information",
"type": "object",
"description": "Information about different owned and operated properties.",
"properties": {
"propertyId": {
"title": "Property Identification Number",
"type": "string",
"description": "Unique Property identification number",
"meta:xdmType": "string"
}
},
"meta:xdmType": "object"
}
},
"meta:xdmType": "object"
}
},
"type": "object",
"meta:xdmType": "object"
}
},
"allOf": [
{
"$ref": "https://ns.adobe.com/xdm/data/record"
},
{
"$ref": "#/definitions/property"
}
],
"meta:abstract": true,
"meta:extensible": true,
"meta:extends": [
"https://ns.adobe.com/xdm/data/record"
],
"meta:containerId": "tenant",
"imsOrg": "{ORG_ID}",
"meta:altId": "_{TENANT_ID}.classes.19e1d8b5098a7a76e2c10a81cbc99590",
"meta:xdmType": "object",
"$id": "https://ns.adobe.com/{TENANT_ID}/classes/19e1d8b5098a7a76e2c10a81cbc99590",
"version": "1.0",
"meta:resourceType": "classes",
"meta:registryMetadata": {
"repo:createDate": 1552086405448,
"repo:lastModifiedDate": 1552086405448,
"xdm:createdClientId": "{CREATED_CLIENT}",
"xdm:repositoryCreatedBy": "{CREATED_BY}"
}
}
Realización de una solicitud de GET a enumerar todas las clases en el tenant
El contenedor ahora incluiría la clase Property . También puede realizar una solicitud de búsqueda (GET) uso de la codificación URL $id
para ver la nueva clase directamente.
Puede reemplazar una clase completa a través de una operación de PUT, básicamente reescribiendo el recurso. Al actualizar una clase a través de una solicitud de PUT, el cuerpo debe incluir todos los campos necesarios cuando creación de una nueva clase en una solicitud del POST.
Si solo desea actualizar parte de una clase en lugar de reemplazarla por completo, consulte la sección de actualización de una parte de una clase.
Formato de API
PUT /tenant/classes/{CLASS_ID}
Parámetro | Descripción |
---|---|
{CLASS_ID} |
La variable meta:altId o con codificación de URL $id de la clase que desea reescribir. |
Solicitud
La siguiente solicitud reescribe una clase existente, cambiando su description
y title
de uno de sus campos.
curl -X PUT \
https://platform.adobe.io/data/foundation/schemaregistry/tenant/classes/_{TENANT_ID}.classes.19e1d8b5098a7a76e2c10a81cbc99590 \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '{
"title": "Property",
"description": "Base class for properties operated by a company.",
"type": "object",
"definitions": {
"property": {
"properties": {
"_{TENANT_ID}": {
"type": "object",
"properties": {
"property": {
"title": "Property Information",
"type": "object",
"description": "Information about different owned and operated properties.",
"properties": {
"propertyId": {
"title": "Property ID",
"type": "string",
"description": "Unique Property ID string."
}
}
}
}
}
},
"type": "object"
}
},
"allOf": [
{
"$ref": "https://ns.adobe.com/xdm/data/record"
},
{
"$ref": "#/definitions/property"
}
]
}'
Respuesta
Una respuesta correcta devuelve los detalles de la clase actualizada.
{
"title": "Property",
"description": "Base class for properties operated by a company.",
"type": "object",
"definitions": {
"property": {
"properties": {
"_{TENANT_ID}": {
"type": "object",
"properties": {
"property": {
"title": "Property Information",
"type": "object",
"description": "Information about different owned and operated properties.",
"properties": {
"propertyId": {
"title": "Property ID",
"type": "string",
"description": "Unique Property ID string",
"meta:xdmType": "string"
}
},
"meta:xdmType": "object"
}
},
"meta:xdmType": "object"
}
},
"type": "object",
"meta:xdmType": "object"
}
},
"allOf": [
{
"$ref": "https://ns.adobe.com/xdm/data/record"
},
{
"$ref": "#/definitions/property"
}
],
"meta:abstract": true,
"meta:extensible": true,
"meta:extends": [
"https://ns.adobe.com/xdm/data/record"
],
"meta:containerId": "tenant",
"imsOrg": "{ORG_ID}",
"meta:altId": "_{TENANT_ID}.classes.19e1d8b5098a7a76e2c10a81cbc99590",
"meta:xdmType": "object",
"$id": "https://ns.adobe.com/{TENANT_ID}/classes/19e1d8b5098a7a76e2c10a81cbc99590",
"version": "1.0",
"meta:resourceType": "classes",
"meta:registryMetadata": {
"repo:createDate": 1552086405448,
"repo:lastModifiedDate": 1552086405448,
"xdm:createdClientId": "{CREATED_CLIENT}",
"xdm:repositoryCreatedBy": "{CREATED_BY}"
}
}
Puede actualizar una parte de una clase utilizando una solicitud de PATCH. La variable Schema Registry admite todas las operaciones estándar de parches de JSON, incluidas add
, remove
y replace
. Para obtener más información sobre el parche JSON, consulte la Guía de fundamentos de API.
Si desea reemplazar un recurso completo con valores nuevos en lugar de actualizar campos individuales, consulte la sección de sustitución de una clase mediante una operación de PUT.
Formato de API
PATCH /tenant/class/{CLASS_ID}
Parámetro | Descripción |
---|---|
{CLASS_ID} |
La dirección URL codificada $id URI o meta:altId de la clase que desea actualizar. |
Solicitud
La solicitud de ejemplo siguiente actualiza el description
de una clase existente, y title
de uno de sus campos.
El cuerpo de la solicitud adopta la forma de una matriz, y cada objeto de la lista representa un cambio específico en un campo individual. Cada objeto incluye la operación que se va a realizar (op
), que campo debe realizarse en (path
) y qué información debe incluirse en esa operación (value
).
curl -X PATCH \
https://platform.adobe.io/data/foundation/schemaregistry/tenant/classes/_{TENANT_ID}.classes.19e1d8b5098a7a76e2c10a81cbc99590 \
-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}' \
-H 'content-type: application/json' \
-d '[
{ "op": "replace", "path": "/description", "value": "Base class for properties operated by a company."},
{ "op": "replace", "path": "/definitions/property/properties/_{TENANT_ID}/properties/property/properties/propertyId/title", "value": "Unique Property ID string" }
]'
Respuesta
La respuesta muestra que ambas operaciones se realizaron correctamente. La variable description
se ha actualizado, junto con la variable title
del propertyId
campo .
{
"title": "Property",
"description": "Base class for properties operated by a company.",
"type": "object",
"definitions": {
"property": {
"properties": {
"_{TENANT_ID}": {
"type": "object",
"properties": {
"property": {
"title": "Property Information",
"type": "object",
"description": "Information about different owned and operated properties.",
"properties": {
"propertyId": {
"title": "Property ID",
"type": "string",
"description": "Unique Property ID string",
"meta:xdmType": "string"
}
},
"meta:xdmType": "object"
}
},
"meta:xdmType": "object"
}
},
"type": "object",
"meta:xdmType": "object"
}
},
"allOf": [
{
"$ref": "https://ns.adobe.com/xdm/data/record"
},
{
"$ref": "#/definitions/property"
}
],
"meta:abstract": true,
"meta:extensible": true,
"meta:extends": [
"https://ns.adobe.com/xdm/data/record"
],
"meta:containerId": "tenant",
"imsOrg": "{ORG_ID}",
"meta:altId": "_{TENANT_ID}.classes.19e1d8b5098a7a76e2c10a81cbc99590",
"meta:xdmType": "object",
"$id": "https://ns.adobe.com/{TENANT_ID}/classes/19e1d8b5098a7a76e2c10a81cbc99590",
"version": "1.0",
"meta:resourceType": "classes",
"meta:registryMetadata": {
"repo:createDate": 1552086405448,
"repo:lastModifiedDate": 1552086405448,
"xdm:createdClientId": "{CREATED_CLIENT}",
"xdm:repositoryCreatedBy": "{CREATED_BY}"
}
}
En ocasiones puede ser necesario eliminar una clase del Registro de esquemas. Esto se hace realizando una solicitud de DELETE con el ID de clase proporcionado en la ruta.
Formato de API
DELETE /tenant/classes/{CLASS_ID}
Parámetro | Descripción |
---|---|
{CLASS_ID} |
La dirección URL codificada $id URI o meta:altId de la clase que desea eliminar. |
Solicitud
curl -X DELETE \
https://platform.adobe.io/data/foundation/schemaregistry/tenant/classes/_{TENANT_ID}.classes.d5cc04eb8d50190001287e4c869ebe67 \
-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}'
Respuesta
Una respuesta correcta devuelve el estado HTTP 204 (sin contenido) y un cuerpo en blanco.
Puede confirmar la eliminación intentando solicitud de búsqueda (GET) para la clase . Deberá incluir un Accept
en la solicitud, pero debe recibir un estado HTTP 404 (no encontrado) porque la clase se ha eliminado del Registro de esquemas.