创建临时架构

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

主题：

创建对象：

开发人员

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

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

快速入门

本教程要求您对Experience Data Model (XDM)系统有一定的了解。在开始本教程之前，请查看以下XDM文档：

XDM系统概述： Experience Platform中XDM及其实现的高级概述。
架构组合的基础知识： XDM架构的基本组件概述。

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

创建临时类

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

API格式

POST /tenant/classes

请求

以下请求创建一个新XDM类，该类由有效负载中提供的属性进行配置。通过在allOf数组中提供$ref属性设置为https://ns.adobe.com/xdm/data/adhoc，该类继承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。此值将在创建临时模式的下一个步骤中使用。