创建临时架构

Last update: Thu May 25 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

主题：
Schemas

创建对象：

Developer

在特定情况下，可能有必要创建一个 Experience Data Model (XDM)架构中的字段已命名为仅供单个数据集使用。这称为“临时”模式。临时架构用在的各种数据摄取工作流中 Experience Platform，包括摄取CSV文件和创建特定类型的源连接。

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

快速入门

本教程需要您实际了解 Experience Data Model (XDM)系统。在开始本教程之前，请查看以下XDM文档：

XDM系统概述：XDM及其在中实施的高级概述 Experience Platform.
模式组合基础：XDM架构的基本组件概述。

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

创建临时类

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

API格式

POST /tenant/classes

请求

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

NOTE

下定义的自定义字段 _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: {ORG_ID}' \
  -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": "{ORG_ID}",
    "meta:xdmType": "object",
    "meta:registryMetadata": {
        "repo:createdDate": 1557527784822,
        "repo:lastModifiedDate": 1557527784822,
        "xdm:createdClientId": "{CREATED_CLIENT}",
        "xdm:lastModifiedClientId": "{MODIFIED_CLIENT}",
        "eTag": "Jggrlh4PQdZUvDUhQHXKx38iTQo="
    }
}

属性

描述

$id

用作只读、系统为新临时类生成的唯一标识符的URI。此值将在创建临时架构的下一个步骤中使用。