架构端点

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

快速入门

本指南中使用的API端点是 Schema Registry API. 在继续之前,请查看 入门指南 有关相关文档的链接,请参阅本文档中的API调用示例指南,以及有关成功调用任何Experience PlatformAPI所需标头的重要信息。

检索架构列表

您可以在 globaltenant 容器,方法是向 /global/schemas/tenant/schemas,分别为。

注意

列出资源时,方案注册表将结果集限制为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架构(原始) $refallOf 包含。 (限制:300)

响应

上述请求使用 application/vnd.adobe.xed-id+json Accept 标头,因此响应仅包含 title, $id, meta:altIdversion 属性。 使用其他 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"
        }
    }
}

查找架构

您可以通过发出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 原始 $refallOf的标题和描述。
application/vnd.adobe.xed-full+json; version=1 $refallOf 已解析,具有标题和描述。
application/vnd.adobe.xed-notext+json; version=1 原始 $refallOf,无标题或描述。
application/vnd.adobe.xed-full-notext+json; version=1 $refallOf 已解析,无标题或描述。
application/vnd.adobe.xed-full-desc+json; version=1 $refallOf 已解析,包含描述符。
application/vnd.adobe.xed-deprecatefield+json; version=1 $refallOf 已解析,具有标题和描述。 已弃用的字段用 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}"
}

创建架构

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

注意

以下示例调用只是一个基准示例,用于说明如何在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:altIdversion. 这些值是只读的,由 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请求 列出所有架构 现在,租户容器中将包含新架构。 您可以执行 查找(GET)请求 使用URL编码 $id 用于直接查看新架构的URI。

要向架构添加其他字段,您可以执行 PATCH操作 将字段组添加到架构的 allOfmeta:extends 数组。

更新架构

您可以通过PUT操作替换整个架构,实质上是重写资源。 通过PUT请求更新架构时,主体必须包含在 创建新模式 POST请求中。

注意

如果只想更新架构的一部分而不是完全替换它,请参阅 更新模式的一部分.

API格式

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

请求

以下请求会替换现有架构,并更改其 title, descriptionallOf 属性。

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请求更新架构的一部分。 的 Schema Registry 支持所有标准JSON修补程序操作,包括 add, removereplace. 有关JSON修补程序的更多信息,请参阅 API基础知识指南.

注意

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

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

API格式

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

请求

以下示例请求通过添加该字段组的 $idmeta:extendsallOf 数组。

请求正文采用数组的形式,每个列出的对象都表示对单个字段的特定更改。 每个对象都包括要执行的操作(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 标记到架构 meta:immutableTags 数组。 为此,您可以对相关架构发出PATCH请求。

重要

不可变标记是指要设置但从不删除的标记。

API格式

PATCH /tenant/schema/{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"
    ]
}

现在,您可以查看此架构类的并集,以确认已表示架构的字段。 请参阅 unions endpoint指南 以了解更多信息。

删除架构

有时可能需要从架构注册表中删除架构。 这是通过使用路径中提供的架构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(未找到),因为架构已从架构注册表中删除。

在此页面上