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

search_by_module

Overview

Searches modules for a string and returns matched records.

Available APIs

  • SOAP
  • REST

Definition

search_by_module(session, search_string, modules, offset, max_results, assigned_user_id, select_fields, unified_search_only, favorites)

Parameters

Name Type Description
session String Session ID returned by a previous login call.
search_string String The string to search for.
modules Integer The list of modules to query.
offset Integer The record offset from which to start.
max_results Integer The maximum number of records to return.
assigned_user_id String Filters records by the assigned user ID. Leave this empty if no filter should be applied.
select_fields select_fields | Array An array of fields to return. If empty the default return fields will be from the active listviewdefs.
unified_search_only Boolean If the search is only against modules participating in the unified search.
favorites Boolean If only records marked as favorites should be returned.

Result

Name Type Description
result return_search_result | Array Call result.
result.entry_list Array The count of records in paged result.
result.entry_list[].name String The .name of the module
result.entry_list[].records Array A list of name_value lists for each record matched.

Change Log

Version Change
v3_1 Added unified_search_only parameter.

Examples

PHP

$search_by_module_parameters = array(
    //Session id
    "session" => $session_id,

    //The string to search for.
    'search_string' => 'example text',

    //The list of modules to query.
    'modules' => array(
        'Accounts',
    ),

    //The record offset from which to start.
    'offset' => 0,

    //The maximum number of records to return.
    'max_results' => 100,

    //Filters records by the assigned user ID.
    //Leave this empty if no filter should be applied.
    'assigned_user_id' => '',

    //An array of fields to return.
    //If empty the default return fields will be from the active listviewdefs.
    'select_fields' => array(
        'id',
        'name',
    ),

    //If the search is only search modules participating in the unified search.
    'unified_search_only' => false,

    //If only records marked as favorites should be returned.
    'favorites' => false
);

Topics