业务实体服务指南

10.4 HotFix 3
- 10.4 HotFix 2
- 10.4
- 10.3 HotFix 1
- 10.3
- 10.2 HotFix 1
- 10.2

上一个下一个

查询参数

您可将查询参数附加到请求 URL，以筛选记录的详细信息。

下表列出了查询参数：

参数	说明
depth	返回的子级数。指定 2 将返回根节点及其直接子代；指定 3 将返回根节点及其直接子代和孙代。默认值为 1。
effectiveDate	要为其检索数据的日期。
readSystemFields	指示是否在结果中返回系统字段。默认值为 false。
recordStates	记录的状态。请提供逗号分隔的状态列表。支持的记录状态为 ACTIVE、PENDING 和 DELETED。默认值为 ACTIVE。
contentMetadata	记录的元数据。请提供逗号分隔的列表。例如，XREF、PENDING_XREF、DELETED_XREF、HISTORY、XREF_HISTORY 和 MATCH。选择 MATCH 时，响应将包含从 _MTCH 表检索的匹配记录的列表。
historyDate	要为其检索历史记录数据的日期。响应包含从 _HIST 表检索的指定日期的记录数据。您可以使用 historyDate 与 contentMetadata 参数来检索历史元数据。将 contentMetadata 设置为 XREF、BVT 或 TRUST。 XREF。响应包含 _HXRF 表中的历史交叉引用数据。 BVT。响应包含 _HCTL 表中的历史最佳数据版本。 TRUST。响应包含 _HCTL 和 _HVXR 表的历史信任设置。
children	子节点名称或路径的逗号分隔列表。
suppressLinks	指示父子链接在 API 响应中是否可见。将此参数设置为 true 可在响应中禁用所有父子链接。默认值为 false。例如， Person/1242?depth=10&suppressLinks=true 查询最多显示 10 个子级的记录详细信息，并且响应中没有任何父子链接可见。
顺序	带有可选前缀 + 或 - 的字段名称的逗号分隔列表。前缀 + 表示按升序对结果排序，前缀 - 表示按降序对结果排序。默认值为 + 。如果指定多个参数，则结果集将先按列表中的第一个参数进行排序，接着按第二个参数进行排序，依此类推。例如， Person/1242/Names?order=-name 查询将显示按姓名降序排序的结果。 Person/1242/BillAddresses?order=rowidObject,-effStartDate 查询将显示按行 ID 升序排序且按有效期开始日期降序排序的帐单地址。
resolveLookup	在整个查找字段中检索指定业务实体。将该参数设置为 true 可加载查找字段并将其包含在响应中。默认值为 false。例如，addressType 字段是 Person 业务实体的子级别的查找字段。当 resolveLookup 参数设置为 false 时，可能会收到以下 REST API 响应： { "label": "LU Address Type", "addressType": "BILL" } 当 resolveLookups 参数设置为 true 时，REST API 响应将包含其他详细信息，且可能会收到以下 REST API 响应： { "label": "LU Address Type", "addressType": "BILL", "addressTypeDisp": "BILLING" }

以下示例显示了如何筛选记录的详细信息：

GET http://localhost:8080/cmx/cs/localhost-orcl-DS_UI1/Person/123/Phone/SFA:456/PhoneUse?recordsToReturn=100&recordStates=ACTIVE,PENDING&contentMetadata=XREF

读取记录

UTC 格式的日期和时间

下载指南

发送反馈

社区

Knowledge Base

成功门户

Rename Saved Search

目录

业务实体服务指南

业务实体服务指南

查询参数

查询参数