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

get_report_entries

Overview

Retrieves a list of report entries based on specified record IDs.

Available APIs

  • SOAP
  • REST

Definition

get_report_entries(session, ids, select_fields)

Parameters

Name Type Description
session String Session ID returned by a previous login call.
ids select_fields | Array An array of record IDs to retrieve.
select_fields select_fields | Array The list of fields to be included in the results.

Result

Name Type Description
result get_entry_result_for_reports | Array The call result.
result.field_list Array The list of selected fields.
result.field_list[].name String The name of the report.
result.field_list[].type String The type of the report.
result.field_list[].label String The label of the report.
result.field_list[].required Boolean
result.field_list[].options Array
result.entry_list Array The list of report results
result.entry_list[].id String The result ID. This is not the record ID.
result.entry_list[].module_name String The name of the module. Normally contains the value 'Reports'.
result.entry_list[].name_value_list Array The name value list of the report results.

Change Log

Version Change
v2 Method get_report_entries was added.

Considerations

  • This method is not available in CE.

Examples

PHP

$get_report_entries_parameters = array(
    //Session id
    'session' => $session_id,

    //An array of record IDs to retrieve.
    'ids' => array(
        '63f1b905-d206-14cb-cb95-50aa5734815f'
    ),

    //The list of fields to be included in the results.
    'select_fields' => array()
);

Topics