架构注册表API指南附录

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

使用查询参数 query

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

分页 paging

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

筛选 filtering

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

兼容模式 compatibility

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：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"
  }
}

为什么需要兼容模式？

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中操作的方式之间发生，但它不应影响您对Experience Platform服务的使用。

开放源代码项目可供您使用，但涉及通过Schema Registry与资源交互时，本文档中的API示例提供了您应了解和遵循的最佳实践。