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

get_module_fields

Overview

Retrieves the list of field vardefs for a specific module.

Available APIs

  • SOAP
  • REST

Definition

get_module_fields(session, module_name, fields)

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.
fields select_fields | Array The list of fields to retrieve. An empty parameter will return all.

Result

Name Type Description
result new_module_fields | Array The call result.
result.module_name String The name of the module.
result.table_name String The name of the modules primary table.
result.module_fields Array The vardefs for each individual field.

Change Log

Version Change
v2 Added fields parameter.
v2 Return type was changed from module_fields to new_module_fields.

Examples

PHP

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

    //The name of the module from which to retrieve fields
    'module_name' => "Contacts",

    //List of specific fields
    'fields' => array(),
);

Topics