文档Experience Platform体验数据模型 (XDM) 指南

架构端点

Last update: Wed Sep 24 2025 00:00:00 GMT+0000 (Coordinated Universal Time)
  • 主题：

创建对象：

  • 开发人员

架构可以被视为您要摄取到Adobe Experience Platform的数据的蓝图。 每个架构由一个类和零个或多个架构字段组组成。 /schemas API中的Schema Registry端点允许您以编程方式管理体验应用程序中的架构。

快速入门

本指南中使用的API端点是Schema Registry API的一部分。 在继续之前，请查看快速入门指南，以获取相关文档的链接、阅读本文档中示例API调用的指南，以及有关成功调用任何Experience Platform API所需的所需标头的重要信息。

检索架构列表 list

通过分别向global或tenant发出GET请求，可列出/global/schemas或/tenant/schemas容器下的所有架构。

NOTE
列出资源时，架构注册表将结果集限制为300个项目。 要返回超出此限制的资源，必须使用分页参数。 还建议您使用其他查询参数来筛选结果并减少返回的资源数。 有关详细信息，请参阅附录文档中有关查询参数的部分。

API格式

GET /{CONTAINER_ID}/schemas?{QUERY_PARAMS}
参数
描述
{CONTAINER_ID}
存放要检索的架构的容器： global用于Adobe创建的架构，或者tenant用于您的组织拥有的架构。
{QUERY_PARAMS}
用于筛选结果的可选查询参数。 有关可用参数的列表，请参阅附录文档。

请求

以下请求从tenant容器中检索架构列表，使用orderby查询参数按其title属性对结果进行排序。

curl -X GET \
  https://platform.adobe.io/data/foundation/schemaregistry/tenant/schemas?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}'

响应格式取决于请求中发送的Accept标头。 以下Accept标头可用于列出架构：

Accept标头
描述
application/vnd.adobe.xed-id+json
返回每个资源的简短摘要。 这是列出资源的推荐标头。 （限制：300）
application/vnd.adobe.xed+json
返回每个资源的完整JSON架构，包括原始$ref和allOf。 （限制：300）

响应

上述请求使用了application/vnd.adobe.xed-id+json Accept标头，因此响应只包含每个架构的title、$id、meta:altId和version属性。 使用其他Accept标头(application/vnd.adobe.xed+json)返回每个架构的所有属性。 根据您在响应中需要的信息，选择适当的Accept标头。

{
  "results": [
    {
      "$id": "https://ns.adobe.com/{TENANT_ID}/schemas/0238be93d3e7a06aec5e0655955901ec",
      "meta:altId": "_{TENANT_ID}.schemas.0238be93d3e7a06aec5e0655955901ec",
      "version": "1.4",
      "title": "Hotels"
    },
    {
      "$id": "https://ns.adobe.com/{TENANT_ID}/schemas/0ef4ce0d390f0809fad490802f53d30b",
      "meta:altId": "_{TENANT_ID}.schemas.0ef4ce0d390f0809fad490802f53d30b",
      "version": "1.0",
      "title": "Loyalty Members"
    }
  ],
  "_page": {
        "orderby": "title",
        "next": null,
        "count": 2
    },
    "_links": {
        "next": null,
        "global_schemas": {
            "href": "https://platform.adobe.io/data/foundation/schemaregistry/global/schemas"
        }
    }
}

查找架构 lookup

您可以通过发出GET请求来查找特定架构，该请求在路径中包含架构的ID。

API格式

GET /{CONTAINER_ID}/schemas/{SCHEMA_ID}
参数
描述
{CONTAINER_ID}
包含您要检索的架构的容器： global用于Adobe创建的架构，或者tenant用于您的组织拥有的架构。
{SCHEMA_ID}
要查找的架构的meta:altId或URL编码的$id。

请求

以下请求检索由路径中其meta:altId值指定的架构。

curl -X GET \
  https://platform.adobe.io/data/foundation/schemaregistry/tenant/schemas/_{TENANT_ID}.schemas.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}'

响应格式取决于请求中发送的Accept标头。 所有查找请求都要求在version标头中包含Accept。 以下Accept标头可用：

Accept标头
描述
application/vnd.adobe.xed+json; version=1
具有$ref和allOf的原始，具有标题和描述。
application/vnd.adobe.xed-full+json; version=1
$ref和allOf已解决，具有标题和描述。
application/vnd.adobe.xed-notext+json; version=1
原始为$ref和allOf，无标题或描述。
application/vnd.adobe.xed-full-notext+json; version=1
$ref和allOf已解决，无标题或描述。
application/vnd.adobe.xed-full-desc+json; version=1
已解决$ref和allOf，包含描述符。
application/vnd.adobe.xed-deprecatefield+json; version=1
$ref和allOf已解决，具有标题和描述。 已弃用的字段用meta:status的deprecated属性表示。

响应

成功的响应将返回架构的详细信息。 返回的字段取决于请求中发送的Accept标头。 尝试使用不同的Accept标头来比较响应并确定哪个标头最适合您的用例。

{
  "$id": "https://ns.adobe.com/{TENANT_ID}/schemas/20af3f1d4b175f27ba59529d1b51a0c79fc25df454117c80",
  "meta:altId": "_{TENANT_ID}.schemas.20af3f1d4b175f27ba59529d1b51a0c79fc25df454117c80",
  "meta:resourceType": "schemas",
  "version": "1.1",
  "title": "Example schema",
  "type": "object",
  "description": "An example schema created within the tenant container.",
  "allOf": [
      {
          "$ref": "https://ns.adobe.com/xdm/context/profile",
          "type": "object",
          "meta:xdmType": "object"
      },
      {
          "$ref": "https://ns.adobe.com/{TENANT_ID}/mixins/443fe51457047d958f4a97853e64e0eca93ef34d7990583b",
          "type": "object",
          "meta:xdmType": "object"
      }
  ],
  "imsOrg": "{ORG_ID}",
  "meta:extensible": false,
  "meta:abstract": false,
  "meta:extends": [
      "https://ns.adobe.com/{TENANT_ID}/mixins/443fe51457047d958f4a97853e64e0eca93ef34d7990583b",
      "https://ns.adobe.com/xdm/common/auditable",
      "https://ns.adobe.com/xdm/data/record",
      "https://ns.adobe.com/xdm/context/profile"
  ],
  "meta:xdmType": "object",
  "meta:registryMetadata": {
      "repo:createdDate": 1602872911226,
      "repo:lastModifiedDate": 1603381419889,
      "xdm:createdClientId": "{CLIENT_ID}",
      "xdm:lastModifiedClientId": "{CLIENT_ID}",
      "xdm:createdUserId": "{USER_ID}",
      "xdm:lastModifiedUserId": "{USER_ID}",
      "eTag": "84b4da79b7445a4bf1c59269e718065effddb983c492f48e223d49c049c6d589",
      "meta:globalLibVersion": "1.15.4"
  },
  "meta:class": "https://ns.adobe.com/xdm/context/profile",
  "meta:containerId": "tenant",
  "meta:sandboxId": "ff0f6870-c46d-11e9-8ca3-036939a64204",
  "meta:sandboxType": "production",
  "meta:tenantNamespace": "_{TENANT_ID}"
}

创建架构 create

架构组合过程从指定类开始。 类定义数据的关键行为方面（记录或时间序列），以及描述将摄取的数据所需的最小字段。

有关在不使用类或字段组的情况下创建架构（称为基于模型的架构）的说明，请参阅创建基于模型的架构部分。

NOTE
以下示例调用只是一个基准示例，说明如何在API中创建架构，具有类的最低组合要求，并且没有字段组。 有关如何在API中创建架构的完整步骤，包括如何使用字段组和数据类型分配字段，请参阅架构创建教程。

API格式

POST /tenant/schemas

请求

该请求必须包含引用类的allOf的$id特性。 此属性定义架构将实施的“基类”。 在此示例中，基类是以前创建的“属性信息”类。

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: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '{
        "title":"Property Information",
        "description": "Property-related information.",
        "type": "object",
        "allOf": [
          {
            "$ref": "https://ns.adobe.com/{TENANT_ID}/classes/19e1d8b5098a7a76e2c10a81cbc99590"
          }
        ]
      }'
属性
描述
allOf
一个对象数组，每个对象引用架构实现其字段的类或字段组。 每个对象都包含一个属性($ref)，其值表示新架构将实现的类或字段组的$id。 必须提供一个类，且不含或包含多个其他字段组。 在上述示例中，allOf数组中的单个对象是架构的类。

响应

成功的响应返回HTTP状态201 （已创建）以及包含新创建架构的详细信息（包括$id、meta:altId和version）的有效负载。 这些值是只读的，由Schema Registry分配。

{
    "title": "Property Information",
    "description": "Property-related information.",
    "type": "object",
    "allOf": [
        {
            "$ref": "https://ns.adobe.com/{TENANT_ID}/classes/19e1d8b5098a7a76e2c10a81cbc99590"
        }
    ],
    "meta:class": "https://ns.adobe.com/{TENANT_ID}/classes/19e1d8b5098a7a76e2c10a81cbc99590",
    "meta:abstract": false,
    "meta:extensible": false,
    "meta:extends": [
        "https://ns.adobe.com/{TENANT_ID}/classes/19e1d8b5098a7a76e2c10a81cbc99590",
        "https://ns.adobe.com/xdm/data/record"
    ],
    "meta:containerId": "tenant",
    "imsOrg": "{ORG_ID}",
    "meta:altId": "_{TENANT_ID}.schemas.d5cc04eb8d50190001287e4c869ebe67",
    "meta:xdmType": "object",
    "$id": "https://ns.adobe.com/{TENANT_ID}/schemas/d5cc04eb8d50190001287e4c869ebe67",
    "version": "1.0",
    "meta:resourceType": "schemas",
    "meta:registryMetadata": {
        "repo:createDate": 1552088461236,
        "repo:lastModifiedDate": 1552088461236,
        "xdm:createdClientId": "{CREATED_CLIENT}",
        "xdm:repositoryCreatedBy": "{CREATED_BY}"
    }
}

现在执行GET请求以列出租户容器中的所有架构将包括新架构。 您可以使用URL编码的 URI执行查找(GET)请求$id以直接查看新架构。

要将其他字段添加到架构，您可以执行PATCH操作以将字段组添加到架构的allOf和meta:extends数组。

创建一个基于模型的架构 create-model-based-schema

AVAILABILITY
Data Mirror和基于模型的架构可供Adobe Journey Optimizer 协调的营销活动 ​许可证持有人使用。 根据您的许可证和功能启用，它们也可用作Customer Journey Analytics用户的​ 有限版本。 请联系您的Adobe代表以获取访问权限。

通过向/schemas端点发出POST请求来创建基于模型的架构。 基于模型的架构存储结构化关系样式数据​ ，但不包含 ​类或字段组。 直接在架构上定义字段，并使用逻辑行为标记将架构标识为基于模型。

IMPORTANT
要创建基于模型的架构，请将meta:extends设置为"https://ns.adobe.com/xdm/data/adhoc-v2"。 这是​ 逻辑行为标识符 （不是物理行为或类）。 在​ 中 ​不allOf引用类或字段组，在​ 中 ​不meta:extends包含类或字段组。

首先使用POST /tenant/schemas创建架构。 然后使用描述符API (POST /tenant/descriptors)添加所需的描述符：

NOTE
在UI架构编辑器中，版本描述符和时间戳描述符分别显示为“版本标识符”和“时间戳标识符”。
CAUTION
基于模型的架构​ 与合并架构 ​不兼容。 使用基于模型的架构时，请勿将union标记应用于meta:immutableTags。 此配置在UI中被阻止，但当前未被API阻止。 有关合并架构行为的详细信息，请参阅联合终结点指南。

API格式

POST /tenant/schemas

请求

curl --request POST \
  --url https://platform.adobe.io/data/foundation/schemaregistry/tenant/schemas \
  -H 'Accept: application/vnd.adobe.xed+json' \
  -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": "marketing.customers",
  "type": "object",
  "description": "Schema of the Marketing Customers table.",
  "definitions": {
    "customFields": {
      "type": "object",
      "properties": {
        "customer_id": {
          "title": "Customer ID",
          "description": "Primary key of the customer table.",
          "type": "string",
          "minLength": 1
        },
        "name": {
          "title": "Name",
          "description": "Name of the customer.",
          "type": "string"
        },
        "email": {
          "title": "Email",
          "description": "Email of the customer.",
          "type": "string",
          "format": "email",
          "minLength": 1
        }
      },
      "required": ["customer_id"]
    }
  },
  "allOf": [
    {
      "$ref": "#/definitions/customFields",
      "meta:xdmType": "object"
    }
  ],
  "meta:extends": ["https://ns.adobe.com/xdm/data/adhoc-v2"],
  "meta:behaviorType": "record"
}
'

请求正文属性

属性
类型
描述
title
字符串
架构的显示名称。
description
字符串
有关架构用途的简短说明。
type
字符串
对于基于模型的架构，必须为"object"。
definitions
对象
包含定义架构字段的根级别对象。
definitions.<name>.properties
对象
字段名称和数据类型。
allOf
数组
引用根级对象定义（例如，#/definitions/marketing_customers）。
meta:extends
数组
必须包括"https://ns.adobe.com/xdm/data/adhoc-v2"以将架构标识为基于模型。
meta:behaviorType
字符串
设置为"record"。 仅在启用和适当的情况下使用"time-series"。
IMPORTANT
基于模型的架构的架构演化遵循与标准架构相同的附加规则。 您可以通过PATCH请求添加新字段。 仅当未将数据摄取到数据集时，才允许重命名或删除字段等更改。

响应

成功的请求返回​ HTTP 201 （已创建） ​和已创建的架构。

NOTE
基于模型的架构不继承预植入字段（例如，id、时间戳或eventType）。 在架构中显式定义所有必填字段。

示例响应

{
  "$id": "https://ns.adobe.com/<TENANT_ID>/schemas/<SCHEMA_UUID>",
  "meta:altId": "_<SCHEMA_ALT_ID>",
  "meta:resourceType": "schemas",
  "version": "1.0",
  "title": "marketing.customers",
  "description": "Schema of the Marketing Customers table.",
  "type": "object",
  "definitions": {
    "marketing_customers": {
      "type": "object",
      "properties": {
        "customer_id": {
          "title": "Customer ID",
          "description": "Primary key of the customer table.",
          "type": "string",
          "minLength": 1
        },
        "name": {
          "title": "Name",
          "description": "Name of the customer.",
          "type": "string"
        },
        "email": {
          "title": "Email",
          "description": "Email of the customer.",
          "type": "string",
          "format": "email",
          "minLength": 1
        }
      },
      "required": ["customer_id"]
    }
  },
  "allOf": [
    { "$ref": "#/definitions/marketing_customers" }
  ],
  "meta:extends": ["https://ns.adobe.com/xdm/data/adhoc-v2"],
  "meta:behaviorType": "record",
  "meta:containerId": "tenant"
}

响应正文属性

属性
类型
描述
$id
字符串
已创建架构的唯一URL。 在后续API调用中使用。
meta:altId
字符串
架构的替代标识符。
meta:resourceType
字符串
资源类型（始终为"schemas"）。
version
字符串
创建时分配的架构版本。
title
字符串
架构的显示名称。
description
字符串
有关架构用途的简短说明。
type
字符串
架构类型。
definitions
对象
定义架构中使用的可重用对象或字段组。 这通常包括主数据结构，在allOf数组中引用它来定义架构根。
allOf
数组
通过引用一个或多个定义（例如，#/definitions/marketing_customers）指定架构的根对象。
meta:extends
数组
将架构标识为基于模型(adhoc-v2)。
meta:behaviorType
字符串
行为类型（record或time-series，启用时）。
meta:containerId
字符串
存储架构的容器（例如，tenant）。

要在基于模型的架构创建后添加字段，请发出PATCH请求。 基于模型的架构不会继承或自动演化。 仅当未将数据摄取到数据集中时，才允许进行重命名或删除字段等结构更改。 一旦存在数据，则仅支持​ 附加更改（例如添加新字段）。

您可以添加新的根级别字段（在根定义或根properties中），但无法删除、重命名或更改现有字段的类型。

CAUTION
在使用架构初始化数据集后，架构演化将受到限制。 事先仔细规划字段名称和类型，因为一旦接收到数据，就无法删除或修改字段。

更新架构 put

您可以通过PUT操作替换整个架构，从而本质上重新编写资源。 通过PUT请求更新架构时，正文必须包含在POST请求中创建新架构时所需的所有字段。

NOTE
如果只想更新部分架构而不是完全替换它，请参阅更新部分架构部分。

API格式

PUT /tenant/schemas/{SCHEMA_ID}
参数
描述
{SCHEMA_ID}
要重写的架构的meta:altId或URL编码的$id。

请求

以下请求替换了现有架构，更改了其title、description和allOf属性。

curl -X PUT \
  https://platform.adobe.io/data/foundation/schemaregistry/tenant/schemas/_{TENANT_ID}.schemas.d5cc04eb8d50190001287e4c869ebe67 \
  -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":"Commercial Property Information",
        "description": "Information related to commercial properties.",
        "type": "object",
        "allOf": [
          {
            "$ref": "https://ns.adobe.com/{TENANT_ID}/classes/01b7b1745e8ac4ed1e8784ec91b6afa7"
          }
        ]
      }'

响应

成功的响应将返回已更新架构的详细信息。

{
    "title":"Commercial Property Information",
    "description": "Information related to commercial properties.",
    "type": "object",
    "allOf": [
        {
            "$ref": "https://ns.adobe.com/{TENANT_ID}/classes/01b7b1745e8ac4ed1e8784ec91b6afa7"
        }
    ],
    "meta:class": "https://ns.adobe.com/{TENANT_ID}/classes/01b7b1745e8ac4ed1e8784ec91b6afa7",
    "meta:abstract": false,
    "meta:extensible": false,
    "meta:extends": [
        "https://ns.adobe.com/{TENANT_ID}/classes/01b7b1745e8ac4ed1e8784ec91b6afa7",
        "https://ns.adobe.com/xdm/data/record"
    ],
    "meta:containerId": "tenant",
    "imsOrg": "{ORG_ID}",
    "meta:altId": "_{TENANT_ID}.schemas.d5cc04eb8d50190001287e4c869ebe67",
    "meta:xdmType": "object",
    "$id": "https://ns.adobe.com/{TENANT_ID}/schemas/d5cc04eb8d50190001287e4c869ebe67",
    "version": "1.0",
    "meta:resourceType": "schemas",
    "meta:registryMetadata": {
        "repo:createDate": 1552088461236,
        "repo:lastModifiedDate": 1552088470592,
        "xdm:createdClientId": "{CREATED_CLIENT}",
        "xdm:repositoryCreatedBy": "{CREATED_BY}"
    }
}

更新架构的一部分 patch

您可以使用PATCH请求更新架构的一部分。 Schema Registry支持所有标准JSON修补程序操作，包括add、remove和replace。 有关JSON修补程序的详细信息，请参阅API基础指南。

NOTE
如果要使用新值替换整个资源，而不是更新单个字段，请参阅使用PUT操作替换架构部分。

PATCH最常见的操作之一是将以前定义的字段组添加到架构中，如以下示例所示。

API格式

PATCH /tenant/schemas/{SCHEMA_ID}
参数
描述
{SCHEMA_ID}
要更新的架构的URL编码的$id URI或meta:altId。

请求

下面的示例请求通过将字段组的$id值同时添加到meta:extends和allOf数组，向架构中添加了新的字段组。

请求正文采用数组的形式，每个列出的对象表示对单个字段的特定更改。 每个对象都包含要执行的操作(op)、应该对(path)执行该操作的字段，以及该操作中应该包含哪些信息(value)。

curl -X PATCH\
  https://platform.adobe.io/data/foundation/schemaregistry/tenant/schemas/_{TENANT_ID}.schemas.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}' \
  -H 'content-type: application/json' \
  -d '[
        {
          "op": "add",
          "path": "/meta:extends/-",
          "value":  "https://ns.adobe.com/{TENANT_ID}/mixins/e49cbb2eec33618f686b8344b4597ecf"
        },
        {
          "op": "add",
          "path": "/allOf/-",
          "value":  {
            "$ref": "https://ns.adobe.com/{TENANT_ID}/mixins/e49cbb2eec33618f686b8344b4597ecf"
          }
        }
      ]'

响应

响应显示两个操作均已成功执行。 字段组$id已添加到meta:extends数组，并且字段组$ref的引用($id)现在显示在allOf数组中。

{
    "title": "Property Information",
    "description": "Property-related information.",
    "type": "object",
    "allOf": [
        {
            "$ref": "https://ns.adobe.com/{TENANT_ID}/classes/19e1d8b5098a7a76e2c10a81cbc99590"
        },
        {
            "$ref": "https://ns.adobe.com/{TENANT_ID}/mixins/e49cbb2eec33618f686b8344b4597ecf"
        }
    ],
    "meta:class": "https://ns.adobe.com/{TENANT_ID}/classes/19e1d8b5098a7a76e2c10a81cbc99590",
    "meta:abstract": false,
    "meta:extensible": false,
    "meta:extends": [
        "https://ns.adobe.com/{TENANT_ID}/classes/19e1d8b5098a7a76e2c10a81cbc99590",
        "https://ns.adobe.com/xdm/data/record",
        "https://ns.adobe.com/{TENANT_ID}/mixins/e49cbb2eec33618f686b8344b4597ecf"
    ],
    "meta:containerId": "tenant",
    "imsOrg": "{ORG_ID}",
    "meta:altId": "_{TENANT_ID}.schemas.d5cc04eb8d50190001287e4c869ebe67",
    "meta:xdmType": "object",
    "$id": "https://ns.adobe.com/{TENANT_ID}/schemas/d5cc04eb8d50190001287e4c869ebe67",
    "version": "1.1",
    "meta:resourceType": "schemas",
    "meta:registryMetadata": {
        "repo:createDate": 1552088461236,
        "repo:lastModifiedDate": 1552088649634,
        "xdm:createdClientId": "{CREATED_CLIENT}",
        "xdm:repositoryCreatedBy": "{CREATED_BY}"
    }
}

启用架构以在实时客户档案中使用 union

为了使架构参与实时客户个人资料，您必须将union标记添加到架构的meta:immutableTags数组。 您可以通过向PATCH请求相关架构来实现这一点。

IMPORTANT
不可变标记是旨在设置但不会移除的标记。

API格式

PATCH /tenant/schemas/{SCHEMA_ID}
参数
描述
{SCHEMA_ID}
要启用的架构的URL编码的$id URI或meta:altId。

请求

下面的示例请求将meta:immutableTags数组添加到现有架构中，为该数组赋予union单个字符串值，以启用它以用于配置文件。

curl -X PATCH\
  https://platform.adobe.io/data/foundation/schemaregistry/tenant/schemas/_{TENANT_ID}.schemas.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}' \
  -H 'content-type: application/json' \
  -d '[
        {
          "op": "add",
          "path": "/meta:immutableTags",
          "value": ["union"]
        }
      ]'

响应

成功的响应返回更新架构的详细信息，表明已添加meta:immutableTags数组。

{
    "title": "Property Information",
    "description": "Property-related information.",
    "type": "object",
    "allOf": [
        {
            "$ref": "https://ns.adobe.com/{TENANT_ID}/classes/19e1d8b5098a7a76e2c10a81cbc99590"
        },
        {
            "$ref": "https://ns.adobe.com/{TENANT_ID}/mixins/e49cbb2eec33618f686b8344b4597ecf"
        }
    ],
    "meta:class": "https://ns.adobe.com/{TENANT_ID}/classes/19e1d8b5098a7a76e2c10a81cbc99590",
    "meta:abstract": false,
    "meta:extensible": false,
    "meta:extends": [
        "https://ns.adobe.com/{TENANT_ID}/classes/19e1d8b5098a7a76e2c10a81cbc99590",
        "https://ns.adobe.com/xdm/data/record",
        "https://ns.adobe.com/{TENANT_ID}/mixins/e49cbb2eec33618f686b8344b4597ecf"
    ],
    "meta:containerId": "tenant",
    "imsOrg": "{ORG_ID}",
    "meta:altId": "_{TENANT_ID}.schemas.d5cc04eb8d50190001287e4c869ebe67",
    "meta:xdmType": "object",
    "$id": "https://ns.adobe.com/{TENANT_ID}/schemas/d5cc04eb8d50190001287e4c869ebe67",
    "version": "1.1",
    "meta:resourceType": "schemas",
    "meta:registryMetadata": {
        "repo:createDate": 1552088461236,
        "repo:lastModifiedDate": 1552088649634,
        "xdm:createdClientId": "{CREATED_CLIENT}",
        "xdm:repositoryCreatedBy": "{CREATED_BY}"
    },
    "meta:immutableTags": [
      "union"
    ]
}

现在，您可以查看此架构的类的合并以确认架构的字段已显示。 有关详细信息，请参阅联合终结点指南。

删除架构 delete

有时可能需要从架构注册表中删除架构。 可使用路径中提供的架构ID执行DELETE请求，从而达到此目的。

API格式

DELETE /tenant/schemas/{SCHEMA_ID}
参数
描述
{SCHEMA_ID}
要删除的架构的URL编码的$id URI或meta:altId。

请求

curl -X DELETE \
  https://platform.adobe.io/data/foundation/schemaregistry/tenant/schemas/_{TENANT_ID}.schemas.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}'

响应

成功的响应返回HTTP状态204（无内容）和一个空白正文。

您可以通过尝试对架构进行查找(GET)请求来确认删除。 您需要在请求中包含Accept标头，但应该会收到HTTP状态404 （未找到），因为架构已从架构注册表中删除。

recommendation-more-help
62e9ffd9-1c74-4cef-8f47-0d00af32fc07