业务实体服务指南

10.4

上一个下一个

查询参数

使用

fuzzyFilter

参数指定想要查询的字段值。将

fuzzyFilter

参数与

action

参数结合使用。

下表介绍了可以在 URL 中使用的查询参数：

参数	说明
action	必需。返回指定的业务实体的匹配记录。设置为 match ，然后将此参数与 fuzzyFilter 参数结合使用。例如，使用以下查询搜索名字为 STEVE 的人： Person?action=match&fuzzyFilter=STEVE
fuzzyFilter	必需。指定要用于查询特定业务实体类型记录的字段名和字段值对的逗号分隔列表。例如，使用以下查询搜索名字为 STEVE、地址为 Toronto 的记录： Person?action=match&fuzzyFilter=firstName=STEVE,Address.Address.City=TORONTO
matchRuleSet	指定要用于识别匹配记录的匹配规则集。如果您没有指定的匹配规则集，请指定 NONE。将使用自动和手动合并匹配规则。
filter	指定用于筛选模糊搜索结果的字段值。例如，使用以下查询搜索名字为 STEVE、地址为 Toronto 的记录： Person?action=match&fuzzyFilter=firstName='STEVE',lastName="SMITH'&filter=city=Toronto
depth	指定返回的子记录级数。例如，您可以指定以下层级： 1. 返回根记录。 2. 返回根记录及其直接子记录。 3. 返回根记录、其直接子记录和孙记录。例如，使用以下查询搜索名字为 STEVE 的记录，并返回有关根记录及其直接子记录的信息： Person?action=match&fuzzyFilter=firstName='STEVE'&filter=city=Toronto
suppressLinks	指示父子链接在 API 响应中是否可见。将此参数设置为 true 可在响应中禁用所有父子链接。默认值为 false。例如，使用以下查询搜索名字为 STEVE 的记录，并在不存在可见父子链接时返回响应： Person?action=match&fuzzyFilter=firstName='STEVE'&suppressLinks=true
readSystemFields	指示是否在结果中返回系统字段。默认值为 false。
fields	指定要在查询结果中显示的字段。
outputView	指定要用于显示查询结果的业务实体视图。为查询结果配置业务实体视图时，应当包括要在查询结果中显示的字段。

在筛选参数中可以使用以下运算符：

AND: 搜索包含筛选参数中列出的所有字段值的记录。; 例如，使用以下查询搜索名字为 STEVE 且姓氏为 SMITH 的记录：
Person?action=match&fuzzyFilter=firstName='STEVE',lastName='SMITH'&filter=city=Toronto AND gender=Male
IN: 搜索包含筛选参数中列出的任何字段值的记录。; 例如，使用以下查询搜索名字为 STEVE 或姓氏为 JOHN、地址为多伦多或渥太华的记录：
Person?action=match&fuzzyFilter=firstName='STEVE',lastName='SMITH'&filter=city in [Toronto,Ottawa]
Range: 搜索指定范围内的记录。可以为数字和日期数据类型的字段指定范围。; 请对整数数据类型使用以下格式：
<business entity field name>=[fromValue,toValue]
范围介于 fromValue 到 toValue 之间。请确保 fromValue 低于 toValue。; 例如，使用以下查询搜索属于 35 到 45 岁年龄组中的记录：
Person?action=match&fuzzyFilter=firstName='STEVE',lastName='SMITH'&filter=age=[35,45]; 请对日期数据类型使用以下格式：
<business entity field name>=[fromDate,toDate]
范围介于 fromDate 到 toDate 之间。; 例如，使用以下查询搜索出生日期处于 2000 年 6 月 12 日和 2015 年 6 月 12 日之间的记录：
Person?action=match&fuzzyFilter=firstName='STEVE',lastName='SMITH'&filter=birthDate=[2000-06-12T12:30:00Z,2015-06-12T12:30:00Z]

SearchMatch

下载指南

发送反馈

社区

Knowledge Base

成功门户

Rename Saved Search

目录

业务实体服务指南

业务实体服务指南

查询参数

查询参数