目录

Search

  1. 前言
  2. 业务实体服务简介
  3. EJB 业务实体服务调用
  4. REST 业务实体服务调用
  5. 适用于 Data Director 的 REST API
  6. SOAP 业务实体服务调用
  7. 交叉引用记录和 BVT 计算服务
  8. 支持企业关联服务
  9. 清理、分析和转换数据的外部调用
  10. 附录 , A: 使用 REST API 添加记录
  11. 附录 , B: 使用 REST API 上载文件
  12. 附录 , C: 使用 REST API 管理报告

业务实体服务指南

业务实体服务指南

查询参数

查询参数

将查询定义为字段-值对的列表。
下表介绍了可以在 URL 中使用的查询参数:
参数
说明
action
必需。返回查询结果中指定业务实体类型的所有记录。设置为
query
,然后将此参数与
filter
参数结合使用。不使用
filter
参数时,此查询会搜索指定业务实体类型的所有参数。
例如,使用下列查询搜索所有 Person 业务实体记录:
Person?action=query
filter
必需。指定一个用运算符分隔的字段-值对列表。有效运算符为 AND、IN 和 Range。
例如,使用以下查询搜索名字为 STEVE 且姓氏为 SMITH 的 Person 记录:
Person?action=query&filter=firstName='STEVE' AND lastName='SMITH'
depth
指定返回的子记录级数。例如,您可以指定以下层级:
  • 1. 返回根记录。
  • 2. 返回根记录及其直接子记录。
  • 3. 返回根记录、其直接子记录和孙记录。
例如,使用以下查询搜索名字为 STEVE 的记录,并返回有关根记录及其直接子记录的信息:
Person?action=query&filter=firstName='STEVE' AND lastName='SMITH'&depth=2
suppressLinks
指示父子链接在 API 响应中是否可见。将此参数设置为 true 可在响应中禁用所有父子链接。默认值为 false。
例如,使用以下查询搜索名字为 STEVE 的记录,并在不存在可见父子链接时返回响应:
Person?action=query&filter=firstName='STEVE'&suppressLinks=true
readSystemFields
指示是否在结果中返回系统字段。默认值为 false。
fields
指定要在查询结果中显示的字段。
outputView
指定要用于显示查询结果的业务实体视图。为查询结果配置业务实体视图时,应当包括要在查询结果中显示的字段。
Order
指定查询结果的排序顺序。使用加号字符 (+) 作为前缀可指定升序,而使用减号字符 (-) 作为前缀可指定降序。查询结果默认为升序。
如果指定多个参数,则结果集将先按列表中的第一个参数进行排序,接着按第二个参数进行排序,依此类推。
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" }

运算符

在筛选参数中可以使用以下运算符:
AND
搜索包含筛选参数中列出的所有字段值的记录。
例如,使用以下查询搜索名字为 STEVE 且姓氏为 SMITH 的记录:
Person?action=query&filter=firstName='STEVE' AND lastName='SMITH'
IN
搜索包含筛选参数中列出的任何字段值的记录。
例如,使用以下查询搜索名字为 STEVE 或 JOHN 的记录:
Person?action=query&filter=firstName IN [STEVE,JOHN]
Range
搜索指定范围内的记录。可以为数字和日期数据类型的字段指定范围。
请对整数数据类型使用以下格式:
<business entity field name>=[fromValue,toValue]
范围介于 fromValue 到 toValue 之间。请确保 fromValue 低于 toValue。
例如,使用以下查询搜索属于 35 到 45 岁年龄组中的记录:
Person?action=query&filter=firstName IN [STEVE,JOHN] AND age=[35,45]
请对日期数据类型使用以下格式:
<business entity field name>=[fromDate,toDate]
范围介于 fromDate 到 toDate 之间。
例如,使用以下查询搜索出生日期处于 2000 年 6 月 12 日 和 2015 年 6 月 12 日之间的记录:
Person?action=query&filter=birthDate=[2000-06-12T12:30:00Z,2015-06-12T12:30:00Z]
! =
搜索与指定字段值或范围不匹配的记录。
例如,使用以下查询搜索名字不是 ADAM 的记录:
Person?action=query&filter=firstName!='ADAM'
例如,使用以下查询来搜索名字不是 ADAM 且出生日期在 2017 年 11 月 16 日之前和 2020 年 11 月 16 日之后的记录。
Person?action=query&filter=firstName!='ADAM' AND birthdate!=[2017-11-16T00:00:00,2020-11-16T00:00:00]
通配符
可以使用文本和星号 (*) 通配符来指定文本模式,而不是使用完整的搜索字符串。可以使用星号通配符增加找到所需记录的概率。当不知道确切文本或希望搜索相似文本时,星号通配符非常有用。
下表列出了示例搜索字符串并解释了其工作方式:
示例查询字符串
查询行为
John*
查询包含以
John
开头的值的记录。例如,
Johnson
Johnny
Jo*n
查询以
Jo
开头并以
n
结尾的记录。例如,
Johansson
Jordan
*
返回所有记录。