Search

业务实体服务指南

业务实体服务指南

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

上一个下一个

参数

参数

指定要在响应中返回的源系统。

下表介绍了请求正文中的参数：

参数	类型	说明
orsId	路径	用于检索源系统的数据库的操作引用存储 ID。
entityId	路径	业务实体的 ID。
entityName	路径	业务实体的名称。
action	查询	希望 API 执行的操作。以下为默认值： getSourceSystems
aggregate	查询	可选。汇总多个 XREF 的数据。使用以下值： RECORD NODE ENTITY
children	查询	可选。子节点名称的列表。如果指定，响应将包含子节点名称。
compact	查询	可选。指定则返回压缩结果。
contentMetadata	查询	可选。历史记录事件列表的元数据。使用以下值： XREF PENDING_XREF DELETED_XREF HISTORY MATCH BVT TRUST
contributorsOnly	查询	可选。计数所有 XREF 或计入最佳数据版本 (BVT) 的 XREF。
depth	查询	可选。返回的子级数。
describe	查询	可选。添加源系统说明。
fields	查询	可选。业务实体字段的逗号分隔列表。如果指定，响应将仅包含列出的字段。
filter	查询	可选。筛选器表达式。
firstRecord	查询	可选。指定结果中的第一行。
order	查询	可选。带有可选前缀 + 或 - 的字段名称的逗号分隔列表。前缀 + 表示按升序对结果排序，前缀 - 表示按降序对结果排序。默认值为 + 。如果指定多个参数，则结果集将先按列表中的第一个参数进行排序，接着按第二个参数进行排序，依此类推。
recordStates	查询	可选。历史记录事件列表中返回的记录状态。请提供逗号分隔的列表。可以使用以下值： ACTIVE PENDING DELETED
recordstoReturn	查询	可选。指定返回的行数。
recordsTotal	查询	可选。如果设置为 true ，则返回结果中的记录数。默认值为 false

获取源系统元数据

发送反馈