模式可以被视为您希望收录到Adobe Experience Platform的数据的蓝图。 每个模式由一个类和零个或多个混音组成。 Schema Registry API中的/schemas
端点允许您以编程方式管理体验应用程序中的模式。
本指南中使用的API端点是Schema Registry API的一部分。 在继续之前,请查看入门指南,了解相关文档的链接、阅读此文档中示例API调用的指南,以及成功调用任何Experience PlatformAPI所需的重要头信息。
您可以通过分别向/global/schemas
或/tenant/schemas
发出GET请求,列表global
或tenant
容器下的所有模式。
列出资源时,模式注册表将结果集限制为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: {IMS_ORG}' \
-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"
}
}
}
您可以通过发出在路径中包含模式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: {IMS_ORG}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
响应格式取决于请求中发送的Accept
头。 所有查找请求都要求version
包含在Accept
标头中。 以下Accept
标头可用:
Accept 标题 |
描述 |
---|---|
application/vnd.adobe.xed+json; version={MAJOR_VERSION} |
具有$ref 和allOf 的原始数据具有标题和说明。 |
application/vnd.adobe.xed-full+json; version={MAJOR_VERSION} |
$ref 并 allOf 且有标题和说明。 |
application/vnd.adobe.xed-notext+json; version={MAJOR_VERSION} |
没有标题或说明的原始数据,具有$ref 和allOf 。 |
application/vnd.adobe.xed-full-notext+json; version={MAJOR_VERSION} |
$ref 并解 allOf 析,无标题或说明。 |
application/vnd.adobe.xed-full-desc+json; version={MAJOR_VERSION} |
$ref 和包 allOf 含的描述符。 |
响应
成功的响应会返回模式的详细信息。 返回的字段取决于请求中发送的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": "{IMS_ORG}",
"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
请求
请求必须包含引用类的$id
的allOf
属性。 此属性定义模式将实现的“基类”。 在此示例中,基类是先前创建的“属性信息”类。
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: {IMS_ORG}' \
-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": "{IMS_ORG}",
"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编码的$id
URI执行查找(GET)请求以直接视图新模式。
要向模式添加其他字段,可以执行PATCH操作以向模式的allOf
和meta:extends
阵列添加混音。
您可以通过PUT操作替换整个模式,实质上是重写资源。 当通过模式请求更新PUT时,主体必须包括在POST请求中创建新模式时所需的所有字段。
如果您只想更新模式的一部分而不是完全替换模式,请参阅更新的一部分。
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: {IMS_ORG}' \
-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": "{IMS_ORG}",
"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
、remove
和replace
。 有关JSON修补程序的详细信息,请参阅API基础指南。
如果要用新值替换整个资源,而不是更新单个字段,请参阅中有关使用模式操作替换PUT的部分。
最常见的PATCH操作之一涉及向模式添加以前定义的混音,如下例所示。
API格式
PATCH /tenant/schema/{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: {IMS_ORG}' \
-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
阵列,对混音$id
的引用($ref
)现在显示在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": "{IMS_ORG}",
"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
标签。 您可以通过向相关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: {IMS_ORG}' \
-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": "{IMS_ORG}",
"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"
]
}
您现在可以视图此模式类的合并,以确认表示模式的字段。 有关详细信息,请参阅合并端点指南。
有时可能需要从模式注册表中删除模式。 这是通过使用路径中提供的DELETEID执行模式请求来完成的。
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: {IMS_ORG}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
响应
成功的响应返回HTTP状态204(无内容)和空白正文。
您可以通过尝试对GET进行查找(模式)请求来确认删除。 您需要在请求中包含Accept
头,但应接收HTTP状态404(未找到),因为模式已从模式注册表中删除。