架构注册表API指南附录

最近更新： 2025年5月5日
  • 主题：

创建对象：

  • 开发人员

本文档提供有关使用Schema Registry API的补充信息。

使用查询参数

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

NOTE
组合多个查询参数时，必须用&符号(&)分隔。

分页

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

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

参数limit指定正整数（介于0和500之间）作为​ 提示，表示应返回的最大项数。 例如，limit=5在列表中只返回五个资源。 但是，不会严格遵循此值。 实际响应大小可以小于或大于，因为需要提供start参数的可靠操作而受此限制（如果提供）。
start当与orderby参数一起使用时，start指定子设置的项目列表的开始位置。 如果没有orderby参数，则无法使用此参数。 此值可从列表响应的_page.next属性中获取，并用于访问结果的下一页。 如果_page.next值为null，则表示没有其他页面可用。

通常省略此参数以获取结果的第一页。 之后，start应设置为在上一页收到的orderby字段的主排序属性的最大值。 然后，API响应返回以主排序属性从orderby开始并严格大于（对于升序）或严格小于（对于降序）指定值的条目。

例如，如果orderby参数设置为orderby=name,firstname，则start参数将包含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
（无）仅声明属性名称将只返回属性存在的条目。property=title
TIP
您可以使用property参数按架构字段组的兼容类筛选架构字段组。 例如，property=meta:intendedToExtend==https://ns.adobe.com/xdm/context/profile只返回与XDM Individual Profile类兼容的字段组。

兼容模式

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

在公共存储库中查看正式XDM定义时，您可以看到标准XDM与您在Adobe Experience Platform中看到的不同。 您在Experience Platform中看到的内容称为兼容性模式，它提供了标准XDM与Experience 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 year"，
    "type"： "integer"，
    “最小值”：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][0-9]"，
    "meta：xdmField"： "xdm：birthDayAndMonth"，
    "meta：xdmType"： "string"
  }，
  "birthYear"： {
    "title"： "Birth year"，
    "type"： "integer"，
    “最小值”：1，
    "maximum"：32767，
    "meta：xdmField"： "xdm：birthYear"，
    "meta：xdmType"： "short"
  }
}