本文档提供与使用Schema Registry API相关的补充信息。
Schema Registry支持在列出资源时使用查询参数进行页面和筛选结果。
组合多个查询参数时,必须用和号(&
)分隔。
用于分页的最常见的查询参数包括:
参数 | 描述 |
---|---|
start |
指定列出的结果的开始位置。 此值可以从列表响应的_page.next 属性中获取,并用于访问结果的下一页。 如果_page.next 值为null,则没有其他页可用。 |
limit |
限制返回的资源数。 示例:limit=5 将返回一个列表,共5个资源。 |
orderby |
按特定属性对结果排序。 示例:orderby=title 将按标题按升序(A-Z)对结果排序。 在参数值(orderby=-title )之前添加- 将按降序(Z-A)按标题对项目进行排序。 |
您可以使用property
参数筛选结果,该参数用于对检索的资源中的给定JSON属性应用特定运算符。 支持的运算符包括:
运算符 | 描述 | 示例 |
---|---|---|
== |
过滤器属性是否等于提供的值。 | property=title==test |
!= |
过滤器:属性是否不等于提供的值。 | property=title!=test |
< |
过滤器该属性是否小于提供的值。 | property=version<5 |
> |
过滤器该属性是否大于提供的值。 | property=version>5 |
<= |
过滤器,该属性是否小于或等于提供的值。 | property=version<=5 |
>= |
过滤器为属性是大于或等于提供的值。 | property=version>=5 |
~ |
过滤器,根据该属性是否与提供的常规表达式匹配。 | property=title~test$ |
(None) | 仅声明属性名称只返回存在属性的条目。 | property=title |
可以使用property
参数按其兼容类过滤混音。 例如,property=meta:intendedToExtend==https://ns.adobe.com/xdm/context/profile
只返回与XDM Individual Profile类兼容的混音。
Experience Data Model (XDM)是一个公开的文档规范,它由Adobe驱动,旨在提高数字体验的互操作性、表现力和强大功能。Adobe在GitHub](https://github.com/adobe/xdm/)上的[开放源项目中维护源代码和正式的XDM定义。 这些定义以XDM标准表示法编写,使用JSON-LD(链接数据的JavaScript对象表示法)和JSON模式作为定义XDM模式的语法。
在公共存储库中查看正式的XDM定义时,您会发现标准XDM与您在Adobe Experience Platform看到的不同。 您在Experience Platform中看到的内容称为兼容性模式,它在标准XDM和在Platform中使用它的方式之间提供了简单映射。
兼容性模式允许XDM JSON-LD模型通过更改标准XDM中的值并保持语义相同,与现有数据基础结构配合使用。 它使用嵌套JSON结构,以类树格式显示模式。
标准XDM和兼容性模式之间的主要区别是删除字段名称的“xdm:”前缀。
以下是标准XDM和兼容性模式中与生日相关的字段(删除了“描述”属性)的并排比较。 请注意,兼容性模式字段包括对“meta:xdmField”和“meta:xdmType”属性中XDM字段及其数据类型的引用。
标准XDM | 兼容性模式 |
---|---|
{ "xdm:birthDate":{ “标题”:“出生日期”, “类型”:"string", “格式”:“日期”, }, "xdm:birthDayAndMonth":{ “标题”:“出生日期”, “类型”:"string", “模式”:"[0-1][0-9]-[0-9][0-9][0-9]", }, “xdm:birthYear”:{ “标题”:"出生年" “类型”:"integer", “最小”:1, “maximum”:32767 } |
{ "birthDate":{ “标题”:“出生日期”, “类型”:"string", “格式”:“日期”, "meta:xdmField":"xdm:birthDate", "meta:xdmType":“日期” }, “byrthDayAndMonth”:{ “标题”:“出生日期”, “类型”:"string", “模式”:"[0-1][0-9]-[0-9][0-9][0-9]", "meta:xdmField":"xdm:birdyDayAndMonth", "meta:xdmType":"字符串" }, “parthYear”:{ “标题”:"出生年" “类型”:"integer", “最小”:1, “maximum”:32767, "meta:xdmField":"xdm:prishYear", "meta:xdmType":“short” } |
Adobe Experience Platform设计为使用多种解决方案和服务,每种解决方案和服务都有各自的技术挑战和限制(例如,某些技术如何处理特殊特性)。 为了克服这些限制,开发了兼容模式。
大多数Experience Platform服务(包括Catalog、Data Lake和Real-time Customer Profile)使用Compatibility Mode代替标准XDM。 Schema Registry API也使用Compatibility Mode,此文档中的示例全部使用Compatibility Mode显示。
应知道标准XDM与在Experience Platform中操作它的方式之间发生映射,但它不应影响您对Platform服务的使用。
开放源项目可供您使用,但在通过Schema Registry与资源交互时,此文档中的API示例提供您应了解和遵循的最佳实践。