创建临时架构

在特定情况下,可能需要创建Experience Data Model (XDM)架构,其中的字段名称仅由单个数据集使用。 这称为“临时”架构。 临时架构用于Experience Platform的各种数据获取工作流,包括获取CSV文件并创建某些类型的源连接。

本文档提供了使用架构注册表API创建临时架构的一般步骤。 它将与其他需要在工作流中创建临时架构的Experience Platform教程结合使用。 这些文档中的每个文档都提供了有关如何为其特定用例正确配置临时架构的详细信息。

快速入门

本教程需要对Experience Data Model (XDM)系统有正确的了解。 在开始本教程之前,请查阅以下XDM文档:

在开始本教程之前,请查看开发人员指南 ,以了解成功调用Schema Registry API所需了解的重要信息。 这包括您的{TENANT_ID}、“容器”的概念以及发出请求所需的标头(请特别注意“接受”标头及其可能值)。

创建临时类

XDM架构的数据行为由其底层类决定。 创建临时架构的第一步是根据adhoc行为创建类。 这是通过向/tenant/classes端点发出POST请求来完成的。

API格式

POST /tenant/classes

请求

以下请求会创建一个新的XDM类,该类由有效负载中提供的属性进行配置。 通过提供在allOf数组中设置为https://ns.adobe.com/xdm/data/adhoc$ref属性,该类继承了adhoc行为。 该请求还定义了一个_adhoc对象,其中包含类的自定义字段。

注意

_adhoc下定义的自定义字段因临时架构的用例而异。 有关基于用例的必需自定义字段,请参阅相应教程中的特定工作流。

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"
                  }
                }
              }
            }
          }
        ]
      }'
属性 描述
$ref 新类的数据行为。 对于临时类,此值必须设置为https://ns.adobe.com/xdm/data/adhoc
properties._adhoc 一个对象,其中包含类的自定义字段,以字段名称和数据类型的键值对表示。

响应

成功的响应返回新类的详细信息,将properties._adhoc对象的名称替换为系统生成的类唯一标识符GUID。 meta:datasetNamespace属性也会自动生成并包含在响应中。

{
    "$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="
    }
}
属性 描述
$id 一个URI,用作新Ad-hoc类的只读、系统生成的唯一标识符。 此值用于创建临时架构的下一步。

创建临时架构

创建临时类后,可以通过向/tenant/schemas端点发出POST请求来创建用于实现该类的新架构。

API格式

POST /tenant/schemas

请求

以下请求会创建一个新架构,在其负载中为之前创建的ad-hoc类的$id提供引用($ref)。

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"
          }
        ]
      }'

响应

成功响应会返回新创建架构的详细信息,包括其系统生成的只读$id

{
    "$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="
    }
}

查看完整的临时架构

注意

此步骤是可选的。如果您不想检查临时架构的字段结构,则可以在本教程结束时跳到后续步骤部分。

创建临时架构后,您可以发出查找(GET)请求,以查看其扩展形式的架构。 这是通过在GET请求中使用相应的Accept标头来完成的,如下所示。

API格式

GET /tenant/schemas/{SCHEMA_ID}
参数 描述
{SCHEMA_ID} 要访问的临时架构的URL编码的$id URI或meta:altId

请求

以下请求使用Accept标头application/vnd.adobe.xed-full+json; version=1,该标头会返回模式的扩展形式。 请注意,在从Schema Registry检索特定资源时,请求的Accept标头必须包含相关资源的主要版本。

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}' \

响应

成功的响应会返回架构的详细信息,包括嵌套在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="
    }
}

后续步骤

通过阅读本教程,您已成功创建新的临时架构。 如果您是作为另一个教程的一部分来到本文档,您现在可以使用临时架构的$id按照指导完成工作流。

有关使用Schema Registry API的更多信息,请参阅开发人员指南

在此页面上