架构注册表API指南附录

上次更新: 2023-08-25
  • 主题:
  • Schemas
    查看有关此主题的更多信息
  • 创建对象:
  • Developer
    User
    Admin
    Leader

本文档提供有关使用 Schema Registry API。

使用查询参数

此 Schema Registry 在列出资源时,支持使用查询参数来分页和筛选结果。

注意

组合多个查询参数时,必须使用&符号(&)。

分页

分页最常见的查询参数包括:

参数 描述
orderby 按特定属性对结果进行排序。 示例: orderby=title 将按标题对结果进行升序(A-Z)排序。 添加 - 在参数值之前(orderby=-title)将按标题降序对项目排序(Z-A)。
limit 当与 orderby 参数, limit 限制给定请求应返回的最大项目数。 如果没有参数,不能使用此参数 orderby 参数存在。

limit parameter指定正整数(介于 0500) as a 提示 应返回的最大项目数。 例如, limit=5 仅返回列表中的五个资源。 但是,不会严格遵循此值。 实际响应大小可以小于或大于该响应大小,因为需要提供可靠的运行 start 参数(如果有)。
start 当与 orderby 参数, start 指定子设置的项目列表的开始位置。 如果没有参数,不能使用此参数 orderby 参数存在。 此值可从 _page.next 列表响应的属性,用于访问结果的下一页。 如果 _page.next 值为null,则没有可用的其他页面。

通常,为获取结果的第一页,将忽略此参数。 之后, start 应设置为的主排序属性的最大值 orderby 在上一页接收的字段。 然后,API响应会返回以具有来自的主要排序属性的条目开头的条目 orderby 严格大于(对于升序)或严格小于(对于降序)指定的值。

例如,如果 orderby 参数设置为 orderby=name,firstnamestart 参数将包含 name 属性。 在本例中,如果您想在名称“Miller”之后立即显示资源的后20个条目,则可以使用: ?orderby=name,firstname&start=Miller&limit=20.

正在筛选

您可以使用以下方式筛选结果 property 参数,用于对检索到的资源中的给定JSON属性应用特定运算符。 支持的运算符包括:

操作员 描述 示例
== 按属性是否等于提供的值筛选。 property=title==test
!= 按属性是否不等于提供的值筛选。 property=title!=test
< 根据属性是否小于提供的值来进行筛选。 property=version<5
> 按属性是否大于提供的值筛选。 property=version>5
<= 根据属性是否小于或等于提供的值来进行筛选。 property=version<=5
>= 按属性是否大于或等于提供的值筛选。 property=version>=5
(None) 仅声明属性名称将只返回属性存在的条目。 property=title
小贴士

您可以使用 property 用于按架构字段组的兼容类筛选这些字段组的参数。 例如, property=meta:intendedToExtend==https://ns.adobe.com/xdm/context/profile 仅返回与兼容的字段组 XDM Individual Profile 类。

兼容模式

Experience Data Model (XDM)是一个公开记录的规范,由Adobe驱动,用于提高数字体验的互操作性、表达性和强大功能。 Adobe在中维护源代码和正式XDM定义 GitHub上的开源项目. 这些定义使用XDM标准表示法编写,使用JSON-LD(链接数据的JavaScript对象表示法)和JSON Schema作为定义XDM架构的语法。

在公共存储库中查看正式XDM定义时,您可以看到标准XDM与您在Adobe Experience Platform中看到的不同。 您在中看到的内容 Experience Platform 此模式称为兼容模式,它提供了标准XDM与其使用方式之间的简单映射 Platform.

兼容模式的工作原理

兼容模式允许XDM JSON-LD模型通过更改标准XDM中的值同时保持语义相同来与现有数据基础结构一起使用。 它使用嵌套的JSON结构,以树状格式显示架构。

您会注意到标准XDM和兼容模式之间的主要区别是删除了字段名称的“xdm:”前缀。

以下并排比较显示在标准XDM和兼容性模式中与生日相关的字段(删除了“description”属性)。 请注意,兼容性模式字段包括对XDM字段的引用,以及它在“meta:xdmField”和“meta:xdmType”属性中的数据类型。

标准XDM 兼容模式
{ "xdm:birthDate": { "title": "Birth Date", "type": "string", "format": "date" }, "xdm:birthDayAndMonth": { "title": "Birth Date", "type": "string", "pattern": "[0-1][0-9]-[0-9][0-9]" }, "xdm:birthYear": { "title": "Birth": "minimum": 1, "maximum": 32767 } }
  
{ "birthDate": { "title": "Birth Date", "type": "string", "format": "date", "meta:xdmField": "xdm:birthDate", "meta:xdmType": "date" }, "birthDayAndMonth": { "title": "Birth Date", "type": "string", "pattern": "[0-1][0-9]-[0-9]", "meta:xdmField": "xdm:birthAndMonth", meta:xdmType": "string" }, "birthYear": { "title": "Birth year", "type": "integer", "minimum": 1, "maximum": 32767, "meta:xdmField": "xdm:birthYear", "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示例提供了您应了解和遵循的最佳实践。

在此页面上