Sugarcrm支持产品指南糖开发人员糖开发人员指南10.3一体化网页服务休息API.终点/<module>/:记录/链接/:link_name get
此版本仅适用于Sugarcloud客户。

/<module>/:记录/链接/:link_name get

概述

列出相关的ED记录。

概括

此端点将通过表达式返回一组相关的记录。可以应用于多个 字段并具有其中的多个和/或条件。需要注意确保这是 在服务器端上适当的索引否则终端的运行时间将很长。相关领域可以 通过指定字段名称来搜索:“link_name.remote_field”,因此如果您希望搜索帐户 由相关成员帐户的模块您将使用“成员.sic_code”。

请求论据

名称 类型 描述 必需的
filter String 表达方式。滤波表达式如下所述。 False
max_num Integer 最大返回的记录数。默认为20。 False
offset Integer 在返回记录之前跳过的记录数量。默认为0。 False
fields String 逗号分隔列表返回。将始终返回Field Date_modified。这个论点 可以与视图参数组合。
Example: name,account_type,description
False
view String 可以使用View参数而不是定义字段参数。现场列表是 基于请求的视图定义在服务器端构造。可以使用此论点 结合字段参数。公共视图是“记录”和“列表”。
Example: record
False
order_by String 如何在逗号分隔列表中对返回的记录进行排序,其中向列名附加方向 after a colon.
Example: name:DESC,account_type:DESC,date_modified:ASC
False

过滤表达式

有四种类型的S:

基本的

这将通过检查价值“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 含有匹配记录的结果数组。

repsonse.

{
   "next_offset.":-1,
   "记录":[
      {
         "id":"fa300a0e-0ad1-b322-9601-512d0983c19a",
         "name":"Dale Spivey",
         "date_entered":"2013-02-26T19:12:00+00:00",
         "date_modified":"2013-02-28T05:03:00+00:00",
         "modified_user_id":"1",
         "modified_by_name":"Administrator",
         "created_by":"1",
         "created_by_name":"Administrator",
         "description":"",
         "img":"",
         "deleted":false,
         "assigned_user_id":"seed_sally_id",
         "assigned_user_name":"Sally Bronsen",
         "team_name":[
            {
               "id":"East",
               "name":"East",
               "name_2":"",
               "primary":false
            },
            {
               "id":1,
               "name":"Global",
               "name_2":"",
               "primary":false
            },
            {
               "id":"West",
               "name":"West",
               "name_2":"",
               "primary":true
            }
         ],
         "salutation":"",
         "first_name":"Dale",
         "last_name":"Spivey",
         "full_name":"Dale Spivey",
         "title":"VP Operations",
         "linkedin":"",
         "facebook":"",
         "twitter":"",
         "googleplus":"",
         "department":"",
         "do_not_call":false,
         "phone_home":"(523) 825-4311",
         "email":[
            {
               "email_address":"sugar.dev.sugar@example.co.jp",
               "opt_out":"0",
               "invalid_email":"0",
               "primary_address":"1"
            },
            {
               "email_address":"the.support@example.biz",
               "opt_out":"0",
               "invalid_email":"0",
               "primary_address":"0"
            }
         ],
         "phone_mobile":"(373) 861-0757",
         "phone_work":"(212) 542-9596",
         "phone_other":"",
         "phone_fax":"",
         "email1":"sugar.dev.sugar@example.co.jp",
         "email2":"the.support@example.biz",
         "invalid_email":false,
         "email_opt_out":false,
         "primary_address_street":"345 Sugar Blvd.",
         "primary_address_street_2":"",
         "primary_address_street_3":"",
         "primary_address_city":"Denver",
         "primary_address_state":"CA",
         "primary_address_postalcode":"87261",
         "primary_address_country":"USA",
         "alt_address_street":"",
         "alt_address_street_2":"",
         "alt_address_street_3":"",
         "alt_address_city":"",
         "alt_address_state":"",
         "alt_address_postalcode":"",
         "alt_address_country":"",
         "assistant":"",
         "assistant_phone":"",
         "picture":"",
         "email_and_name1":"",
         "lead_source":"Campaign",
         "account_name":"Smallville Resources Inc",
         "account_id":"d5db6292-5c24-eb61-e202-512d09f0134e",
         "opportunity_role_fields":"",
         "opportunity_role_id":"",
         "opportunity_role":"",
         "reports_to_id":"",
         "report_to_name":"",
         "portal_name":"DaleSpivey97",
         "portal_active":true,
         "portal_password":"$1$yKMAONHM$Y5S.8CY.WZCZCwfGD1a1Q\/",
         "portal_password1":"",
         "portal_app":"",
         "preferred_language":"en_us",
         "campaign_id":"",
         "campaign_name":"",
         "c_accept_status_fields":"",
         "m_accept_status_fields":"",
         "accept_status_id":"",
         "accept_status_name":"",
         "sync_contact":"",
         "my_favorite":false,
         "_acl":{
            "领域 ":{

            }
         }
      },
      {
         "id":"95e17367-9b3d-0e26-22dc-512d0961fedf",
         "name":"Florence Haddock",
         "date_entered":"2013-02-26T19:12:00+00:00",
         "date_modified":"2013-02-26T19:12:00+00:00",
         "modified_user_id":"1",
         "modified_by_name":"Administrator",
         "created_by":"1",
         "created_by_name":"Administrator",
         "description":"",
         "img":"",
         "deleted":false,
         "assigned_user_id":"seed_sally_id",
         "assigned_user_name":"Sally Bronsen",
         "team_name":[
            {
               "id":"East",
               "name":"East",
               "name_2":"",
               "primary":false
            },
            {
               "id":1,
               "name":"Global",
               "name_2":"",
               "primary":false
            },
            {
               "id":"West",
               "name":"West",
               "name_2":"",
               "primary":true
            }
         ],
         "salutation":"",
         "first_name":"Florence",
         "last_name":"Haddock",
         "full_name":"Florence Haddock",
         "title":"Director Sales",
         "linkedin":"",
         "facebook":"",
         "twitter":"",
         "googleplus":"",
         "department":"",
         "do_not_call":false,
         "phone_home":"(729) 845-3137",
         "email":[
            {
               "email_address":"dev.vegan@example.de",
               "opt_out":"1",
               "invalid_email":"0",
               "primary_address":"0"
            },
            {
               "email_address":"section71@example.it",
               "opt_out":"0",
               "invalid_email":"0",
               "primary_address":"1"
            }
         ],
         "phone_mobile":"(246) 233-1382",
         "phone_work":"(565) 696-6981",
         "phone_other":"",
         "phone_fax":"",
         "email1":"section71@example.it",
         "email2":"dev.vegan@example.de",
         "invalid_email":false,
         "email_opt_out":false,
         "primary_address_street":"111 Silicon Valley Road",
         "primary_address_street_2":"",
         "primary_address_street_3":"",
         "primary_address_city":"Denver",
         "primary_address_state":"CA",
         "primary_address_postalcode":"79900",
         "primary_address_country":"USA",
         "alt_address_street":"",
         "alt_address_street_2":"",
         "alt_address_street_3":"",
         "alt_address_city":"",
         "alt_address_state":"",
         "alt_address_postalcode":"",
         "alt_address_country":"",
         "assistant":"",
         "assistant_phone":"",
         "picture":"",
         "email_and_name1":"",
         "lead_source":"Support Portal User Registration",
         "account_name":"Smallville Resources Inc",
         "account_id":"d5db6292-5c24-eb61-e202-512d09f0134e",
         "opportunity_role_fields":"",
         "opportunity_role_id":"",
         "opportunity_role":"",
         "reports_to_id":"",
         "report_to_name":"",
         "portal_name":"FlorenceHaddock169",
         "portal_active":true,
         "portal_password":"$1$nWFhTbK6$JF9BCGSqL\/NCrbhueX5ia0",
         "portal_password1":"",
         "portal_app":"",
         "preferred_language":"en_us",
         "campaign_id":"",
         "campaign_name":"",
         "c_accept_status_fields":"",
         "m_accept_status_fields":"",
         "accept_status_id":"",
         "accept_status_name":"",
         "sync_contact":"",
         "my_favorite":false,
         "_acl":{
            "领域 ":{

            }
         }
      }
   ]
}

更改日志

版本 改变
v10 Added /<module>/:record/link/:link_name/filter GET endpoint.

最后修改:2021-01-06 23:28:41