Sugarcrm支持产品指南糖开发人员糖开发人员指南10.0一体化网页服务休息API.终点/<module>/globalsearch GET

/<module>/globalsearch GET

概述

Global search

概括

此端点将全局搜索能力公开使用Elasticsearch后端作为替代方案 /搜索端点。此端点可以与长期的请求参数一起使用。而不是使用get请求 参数,所有描述的参数都可以使用get请求在JSON编码的请求正文中使用。如果你的 客户端没有支持与身体的请求,POST方法可以用作替代品。

请求论据

名称 类型 描述 必需的
q String 搜索表达式。可以立即指定多个术语。将搜索所有已启用的字段。该 结果由相关性排序,基于基于令牌计数的多种设置,命中 比率,(加权)升压值和字段类型。目前在搜索中没有支持运营商 表达本身。通过炼制搜索表达式,更相关的结果将作为最高结果返回。 如果没有给出搜索表达式,则基于上次修改日期返回结果。 False
module_list String 逗号分隔用于搜索的模块列表。如果省略,将查询所有搜索启用的模块。注意 when consuming the endpoint /:module/globalsearch that this parameter is ignored.
Example: Accounts,Contacts
False
max_num Integer 最大返回的记录数。默认为20。 False
offset Integer 在返回记录之前跳过的记录数量。默认为0。 False
highlights Boolean WETHER或不恢复突出显示的结果。默认为真。 False
sort Array 定义结果的排序顺序。默认情况下,结果将按相关性返回 首选方法。使用此参数可以使用任何搜索启用字段来排序。留心 不按相关性排序可能具有负面的性能影响。
Example: {"date_modified":"desc","name":"asc"}
False

要求

{
}

响应论点

名称 类型 描述
next_offset Integer 显示接下来的偏移量以检索其他结果。 - 当没有更多时,将返回 records.
records Array 含有匹配记录的结果数组。

回复

{
}

更改日志

版本 改变
v10 Added /globalsearch GET/POST endpoint.
v10 Added /:module/globalsearch GET/POST endpoint.

最后修改:2020-03-16 17:04:48