Search

业务实体服务指南

业务实体服务指南

10.2

上一个下一个

查询参数

查询参数

使用 q 或 fq 查询参数可以为搜索提供字符串值。q 和 fq 查询参数是互斥的。请对字段搜索使用 fq 参数，并对多个条件使用 AND 逻辑运算符。

下表列出了可以在 URL 中使用的参数：

参数	说明
q	指定字符串值或搜索词。查询会搜索在记录中任何位置出现的搜索词。可以在简单搜索中使用。例如， Person?q=STEVE 查询将搜索包含词语 STEVE 的记录。要同时搜索两个或更多词语，请用双引号将这些词语括起来。请在您希望包含于搜索结果中的每个词语之前添加字符 +。如果字段值包含空格，请用单引号将字段值括起来。使用以下查询可搜索 WILLIAM JOHN LAWSON 的完全匹配项： Person?q="WILLIAM JOHN LAWSON" 使用以下查询可搜索 WILLIAM、JOHN 或 LAWSON： Person?q=WILLIAM JOHN LAWSON
fq	指定特定字段中的字符串值或搜索词。查询只会在记录的该部分搜索相关词语。可以对已编制索引的字段执行有针对性的搜索。例如， Person?fq=displaname=STEVE 查询将搜索具有显示名称 STEVE 的记录。
facets	指定应视为构面或类别的字段，搜索结果将按这些构面或类别进行分组。请仅指定可搜索字段。与 q 和 fq 参数结合使用。语法为 &facets=FieldName1,FieldName2,FieldNameN 例如， Person?q=STEVE&facets=department 查询将搜索具有显示名称 STEVE 的人员并按部门对搜索结果进行分组。此搜索将显示具有显示名称 STEVE 的人员记录，而且这些记录会按部门进行分组。
筛选器	指定可用于缩小搜索结果范围的字段。请仅指定可筛选字段。与 q 和 fq 参数结合使用。例如， Person?fq=STEVE&filters=birthdate='1980-11-27T08:00:00Z' 查询将搜索具有显示名称 STEVE 的人员并按出生日期筛选搜索结果。此搜索将显示具有显示名称 STEVE 且出生日期为 1980 年 11 月 27 日的人员记录。请用单引号将指定的日期括起来。
depth	指定返回的子级数。指定 2 将返回根节点及其直接子代；指定 3 将返回根节点及其直接子代和孙代。指定 1 将仅返回根节点。默认情况下未指定任何深度。如果未指定任何深度，搜索结果将返回根节点以及发现搜索词匹配项的子节点。例如， Person?q=STEVE&depth=2 查询将搜索包含词语 STEVE 的记录并返回有关根记录及其直接子代的信息。
suppressLinks	指示父子链接在 API 响应中是否可见。将此参数设置为 true 可在响应中禁用所有父子链接。默认值为 false。例如， Person?q=STEVE&suppressLinks=true 查询将搜索包含词语 STEVE 的记录并返回没有任何可见父子链接的响应。
readSystemFields	指示是否在结果中返回系统字段。默认值为 false。
order	带有可选前缀 + 或 - 的字段名称的逗号分隔列表。前缀 + 表示按升序对结果排序，前缀 - 表示按降序对结果排序。默认值为 + 。如果想使用子字段来对结果进行排序，请使用字段的全名。例如， BillAddresses.Address.cityName 。如果指定多个参数，则结果集将先按列表中的第一个参数进行排序，接着按第二个参数进行排序，依此类推。例如， Person?order=displayName,-BillAddresses.Address.cityName 查询会先按显示名称以升序对结果排序，再按城市名称以降序对结果排序。
maxRecordsToSort	要排序的搜索结果的最大数量。默认值为 1000。

使用
filters
参数指定范围
：

您可以使用 filters 参数将搜索结果缩小至指定的范围。可以为数值和日期数据类型的可筛选字段指定范围。

请对整数数据类型使用以下格式：

fieldName1=[fromValue,toValue]

范围介于 fromValue 到 toValue 之间。例如，

filters=age=[35,45]

查询会缩小搜索结果范围并搜索 35 到 45 岁年龄组中的记录。

请对日期数据类型使用以下格式：

fieldName1=[fromDate,toDate]

范围介于 fromDate 到 toDate 之间。例如，

filters=birthdate=[2000-06-12T12:30:00Z,2015-06-12T12:30:00Z]

查询指定了介于 2000 年 6 月 12 日到 2015 年 6 月 12 日之间的出生日期。

指定完全匹配日期筛选器时，请用单引号将其括起来。指定日期范围时，请勿使用引号。

搜索业务实体

UTC 格式的日期和时间

发送反馈