Let the platform do the work
SugarClubContact+1 (877) 842-7276

get_entries

Overview

Retrieves a list of beans based on specified record IDs.

Available APIs

  • SOAP
  • REST

Definition

get_entries(session, module_name, ids, select_fields, link_name_to_fields_array, track_view)

Parameters

Name Type Description
session String Session ID returned by a previous login call.
module_name String The name of the module from which to retrieve records. Note: This is the modules key which may not be the same as the modules display name.
ids String The list of record IDs to retrieve.
select_fields select_fields | Array The list of fields to be returned in the results. Specifying an empty array will return all fields.
link_name_to_fields_array link_names_to_fields_array | Array A list of link names and the fields to be returned for each link.
track_view Boolean Flag the record as a recently viewed item.

Result

Name Type Description
result get_entry_result_version2 | Array The call result.
result.entry_list Array The record's name-value pair for the simple datatypes excluding the link field data. If you do not have access to the object, entry_list[].name_value_list will notify you.
result.relationship_list Array The records link field data.

Change Log

Version Change
v3_1 Added track_view parameter.
v2 Added link_name_to_fields_array parameter.
v2 Return type was changed from get_entry_result to get_entry_result_version2.

Examples

PHP

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

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

    //An array of record IDs
    'ids' => array(
        '14b0c0ca-3ea2-0ee8-f3be-50aa57c11ee7',
    ),

    //The list of fields to be returned in the results
    'select_fields' => array(
        'name',
        'billing_address_state',
        'billing_address_country'
    ),

    //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'
            ),
        ),
    ),

    //Flag the record as a recently viewed item
    'track_view' => true,
);

Topics