Sugarcrm支持产品指南糖开发人员糖开发人员指南11.0一体化网页服务休息API.终点/用户得到

/用户得到

概述

列出过滤的记录。

概括

此端点将返回由表达式过滤的一组记录。过滤器可以应用于多个字段 并在其中有多个和/或条件。或者,您可以通过指定其ID来使用现有过滤器。 If both a filter definition and a filter id are passed, the two filters will be joined with an AND. 需要注意确保使用的任何过滤器都在服务器端上具有适当的索引 端点的运行时间将很长。可以通过将字段名称指定为: “link_name.remote_field”,因此如果您希望通过相关成员帐户搜索帐户模块,您将 使用“成员.sic_code”。

请求论据

名称 类型 描述 必需的
filter String 过滤器表达式。滤波表达式如下所述。 请注意,可以将JSON编码的过滤器指定为查询参数 以两种方式获取请求之一:
  1. 通过将单个过滤器参数指定为不同的参数。 Example: 筛选[0][id]=1.
  2. 通过将整个过滤器指定为单个JSON编码的字符串。 请注意,某些模块目前不支持此语法。 Example: 筛选=[{"id":"1"}].
False
filter_id String 预先存在的滤波器的标识符。如果还设置过滤器,则两者 filters are joined with an AND. False
max_num Integer 最大返回的记录数。默认为20。 False
offset Integer 在返回记录之前跳过的记录数量。默认为0。 False
fields String 逗号分隔列表返回。每个字段可以由字符串或映射表示 包含字段名称和其他字段参数(适用于链接和集合字段)。 The fields iddate_modified will always be returned.
Example: name,account_type,description,{"name":"opportunities","领域":["id","name","sales_status"],"Order_by.":"date_closed:desc"}
有关其他字段参数的更多详细信息,请参阅 关联API. and 集合API..
False
view String 可以使用View参数而不是定义字段参数。现场列表是 基于请求的视图定义在服务器端构造。可以使用此论点 结合字段参数。公共视图是“记录”和“列表”。
Example: record
False
order_by String 如何在逗号分隔列表中对返回的记录进行排序,其中向列名附加方向 after a colon.
Example: name:DESC,account_type:DESC,date_modified:ASC
False
q String 搜索表达式将在此模块上搜索。不能与筛选表达式或ID同时使用。 False
deleted Boolean 布尔表示在结果集中显示已删除的记录。 False
nulls_last Boolean Boolean在结果集中返回Order_by字段中的空值返回记录。 False

过滤表达式

有四种类型的过滤器:

基本的

这将通过检查值“Nelson Inc”的字段“名称”来过滤结果。这只会找到完全匹配。
例子
{
   "筛选":[
      {
         "name":"Nelson Inc"
      }
   ]
}

满的

此表达式允许您指定要在字段上过滤的操作。在你的例子中 将匹配字段“名称”以“纳尔逊”的字段“名称”的任何记录匹配。
例子
{
   "筛选":[
      {
         "name":{
            "$开始":"Nelson"
         }
      }
   ]
}
以下是操作类型的列表:
手术 描述
$equals 在该字段上执行完全匹配。
$not_equals 在该字段上执行完全匹配。
$not_equals 匹配非匹配值。
$starts 匹配任何以值开头的东西。
$ends 匹配以符合值的任何结尾。
$contains 匹配包含该值的任何东西
$in 查找字段与指定为数组的值之一匹配的任何东西。
$not_in 查找任何字段与指定为数组的任何值都不匹配的任何东西。
$is_null 检查字段是否为null。此操作不需要指定值。
$not_null 检查字段是否未为null。此操作不需要指定值。
$lt 匹配字段小于值时。
$lte 当字段小于或等于值时匹配。
$gt 当字段大于值时匹配。
$gte 当字段大于或等于值时匹配。

子表达式

这允许您将筛选表达式组组或/和/和/和分组。默认情况下,所有表达式都在一起。 如果字段“名称”是“Nelson Inc”或“Nelson LLC”,则示例表达式将匹配。唯一的目前 被接受的子表达式类型为“$”和“$或”。
例子
{
   "筛选":[
      {
         "$or":[
            {
               "name":"Nelson Inc"
            },
            {
               "name":"Nelson LLC"
            }
         ]
      }
   ]
}

模块

有两个模块表达式,它们在模块上运行而不是字段。目前的模块可以指定 使用模块名称“_this”或将模块名称留成空白字符串。示例表达式会 将当前模块中的记录过滤到只有您的收藏夹。唯一的当前接受的模块表达式是 “$最喜欢的”和“$所有者”。
例子
{
   "筛选":[
      {
         "$favorite":"_this"
      }
   ]
}

响应论点

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

回复

{
   "next_offset.":-1,
   "记录":[
      {
         "id":"fa300a0e-0ad1-b322-9601-512d0983c19a",
         "name":"Dale Spivey",
         "date_modified":"2013-02-28T05:03:00+00:00",
         "description":"",
         "opportunities": [
            {
               _module: "Opportunities",
               "id": "b0701501-1fab-8ae7-3942-540da93f5017",
               "name": "360 Vacations - 228 Units",
               "date_modified": "2014-09-08T16:05:00+03:00",
               "sales_status": "New"
            },
         ],
         "_acl": {
            "领域": {
            }
         }
      },
      {
         "id":"95e17367-9b3d-0e26-22dc-512d0961fedf",
         "name":"Florence Haddock",
         "date_modified":"2013-02-26T19:12:00+00:00",
         "description":"",
         "opportunities": [
            {
               _module: "Opportunities"
               date_modified: "2014-09-08T16:05:00+03:00"
               id: "9ce7c088-8ee4-7cd3-18f1-540da944d4c0"
               name: "360 Vacations - 312 Units"
               sales_status: "New"
            },
         ],
         "_acl": {
            "领域": {
            }
         }
      }
   ]
}

更改日志

版本 改变
v10 Added /<module>/filter GET endpoint.

最后修改:2021-02-17 02:44:13