Sugarcrm支持产品指南糖开发人员糖开发人员指南11.0一体化网页服务遗产API.方法get_entry_list.
此API已被新版本成功。建议升级到最新的API。

get_entry_list.

概述

根据查询规范检索bean列表。

可用API.

  • 肥皂
  • 休息

定义

get_entry_list.(会话,module_name,查询,ourder_by,offset,select_fields,link_name_to_fields_array.,max_results,删除,收藏夹)

参数

名称 类型 描述
会议 细绳 以前的登录呼叫返回会话ID。
module_name. 细绳 从中检索记录的模块的名称。注意:这是模块键,可能与模块显示名称不同。
询问 细绳 SQL where子句没有“在哪里”。您应该记得为字段指定表名以避免任何模糊的列错误。
Order_by. 细绳 没有短语“顺序”的SQL Order By子句。
抵消 整数 从中开始的记录偏移。
选择_fields. 选择_Fields |大批 在结果中返回的字段列表。指定空数组将返回所有字段。
link_name_to_fields_array. link_names_to_fields_array |大批 每个链接的链接名称和要返回的字段列表。
max_results. 整数 返回的最大结果数。
删除了 整数 如果删除的记录应包含在结果中。
最爱 布尔基 如果只返回标记为收藏夹的记录。

结果

名称 类型 描述
结果 get_entry_result_version2 |大批 呼叫结果。
结果。result_count. 整数 呼叫中返回的记录总数。
结果.Total_Count. 整数 记录总数。
结果next_offset. 整数 检索记录的下一个偏移量。
结果.entry_list. 大批 记录的名称值对,用于链接字段数据的简单数据类型。如果您无权访问该对象,则Entry_List []。name_value_list将通知您。
结果.RelationShip_List. 大批 记录链接字段数据。

更改日志

版本 改变
v3_1 添加 最爱 parameter.
v2 添加 link_name_to_fields_array. parameter.
v2 返回类型已从get_entry_list_result更改为 get_entry_list._result_version2..

例子

PHP.

$get_entry_list_parameters = array(
    //session id
    'session' => $session_id,

    //The name of the module from which to retrieve records
    'module_name' => 'Leads',

    //The SQL WHERE clause without the word "where".
    'query' => "",

    //没有短语“顺序”的SQL Order By子句。
    'order_by' => "",

    //从中开始的记录偏移。
    'offset' => 0,

    //A list of fields to include in the results.
    'select_fields' => array(
        'id',
        'name',
        'title',
    ),

    //A list of link names and the fields to be returned for each link name.
    'link_name_to_fields_array.' => array(
        array(
            'name' => 'email_addresses',
            'value' => array(
                'email_address',
                'opt_out',
                'primary_address'
            ),
        ),
    ),

    //返回的最大结果数。
    'max_results' => 2,

    //If deleted records should be included in results.
    'deleted' => 0,

    //如果只返回标记为收藏夹的记录。
    'favorites' => false,
);

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