架构端点
架构可以被视为您希望摄取到Adobe Experience Platform的数据的蓝图。 每个架构由一个类和零个或多个架构字段组组成。 此 /schemas
中的端点 Schema Registry API允许您以编程方式管理体验应用程序中的架构。
快速入门
本指南中使用的API端点是 Schema Registry API. 在继续之前,请查看 快速入门指南 有关相关文档的链接,请参阅本文档中的示例API调用指南,以及有关成功调用任何Experience PlatformAPI所需的所需标头的重要信息。
检索架构列表 list
您可以列出以下位置的所有架构: global
或 tenant
通过向发出GET请求来容器 /global/schemas
或 /tenant/schemas
,则不会显示任何内容。
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
application/vnd.adobe.xed+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
您可以通过在路径中包含架构ID的GET请求来查找特定架构。
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
架构组合过程从分配类开始。 类定义数据的关键行为方面(记录或时间序列),以及描述将摄取的数据所需的最小字段。
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请求至 列出所有架构 租户容器中将包含新架构。 您可以执行 查找(GET)请求 使用URL编码 $id
用于直接查看新架构的URI。
要向架构添加其他字段,您可以执行 PATCH操作 将字段组添加到架构的 allOf
和 meta:extends
数组。
更新架构 put
您可以通过PUT操作替换整个架构,本质上就是重写资源。 通过PUT请求更新架构时,正文必须包括以下情况下所需的所有字段: 创建新架构 在POST请求中。
API格式
PUT /tenant/schemas/{SCHEMA_ID}
{SCHEMA_ID}
meta:altId
或URL编码 $id
要重写的架构的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基础知识指南.
最常见的PATCH操作之一涉及将以前定义的字段组添加到架构,如下例所示。
API格式
PATCH /tenant/schemas/{SCHEMA_ID}
{SCHEMA_ID}
$id
URI或 meta:altId
要更新的架构的ID。请求
下面的示例请求通过添加字段组的 $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}"
}
}
启用架构以用于Real-Time Customer Profile union
为了让架构参与 Real-time Customer Profile,您必须添加 union
标记到架构的 meta:immutableTags
数组。 您可以通过对相关架构发出PATCH请求来完成此操作。
API格式
PATCH /tenant/schemas/{SCHEMA_ID}
{SCHEMA_ID}
$id
URI或 meta:altId
要启用的架构的ID。请求
下面的示例请求添加了 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}
$id
URI或 meta:altId
要删除的架构的ID。请求
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(未找到),因为架构已从架构注册表中删除。