/
var
/
www
/
html
/
sugar25
/
cache
/
include
/
api
/
Upload File
HOME
<?php $apiDictionary['rest'] = array ( 4 => array ( 'base' => array ( 'GET' => array ( '<module>' => array ( '?' => array ( 'link' => array ( 'related_activities' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', 1 => '?', 2 => 'link', 3 => 'related_activities', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', ), 'method' => 'getRelatedActivities', 'minVersion' => '11.7', 'shortHelp' => 'Deprecated api kept for backward compatibility', 'longHelp' => 'include/api/help/related_activities.html', 'file' => 'clients/base/api/RelatedActivitiesApi.php', 'className' => 'RelatedActivitiesApi', 'score' => 10.5, ), ), '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', 1 => '?', 2 => 'link', 3 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', 3 => 'link_name', ), 'jsonParams' => array ( 0 => 'filter', ), 'method' => 'filterRelated', 'shortHelp' => 'Lists related records.', 'longHelp' => 'include/api/help/module_record_link_link_name_filter_get_help.html', 'file' => 'clients/base/api/RelateApi.php', 'className' => 'RelateApi', 'score' => 9.5, ), ), 'activities' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', 1 => '?', 2 => 'link', 3 => 'activities', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', ), 'method' => 'getRecordActivities', 'shortHelp' => 'This method retrieves a record\'s activities', 'longHelp' => 'modules/ActivityStream/clients/base/api/help/recordActivities.html', 'file' => 'modules/ActivityStream/clients/base/api/ActivitiesApi.php', 'className' => 'ActivitiesApi', 'score' => 10.5, ), ), 'history' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', 1 => '?', 2 => 'link', 3 => 'history', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', ), 'method' => 'filterModuleList', 'jsonParams' => array ( 0 => 'filter', ), 'shortHelp' => 'Get the history records for a specific record', 'longHelp' => 'include/api/help/history_filter.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionInvalidParameter', 2 => 'SugarApiExceptionNotAuthorized', ), 'file' => 'modules/History/clients/base/api/HistoryApi.php', 'className' => 'HistoryApi', 'score' => 10.5, ), ), ), 'file' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', 1 => '?', 2 => 'file', 3 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', 3 => 'field', ), 'method' => 'getFile', 'rawReply' => true, 'allowDownloadCookie' => true, 'shortHelp' => 'Gets the contents of a single file related to a field for a module record.', 'longHelp' => 'include/api/help/module_record_file_field_get_help.html', 'file' => 'clients/base/api/FileApi.php', 'className' => 'FileApi', 'score' => 9.5, ), ), ), 'collection' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', 1 => '?', 2 => 'collection', 3 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', 3 => 'collection_name', ), 'method' => 'getCollection', 'shortHelp' => 'Lists collection records.', 'longHelp' => 'include/api/help/module_record_collection_collection_name_get_help.html', 'file' => 'clients/base/api/RelateCollectionApi.php', 'className' => 'RelateCollectionApi', 'score' => 9.5, ), ), ), 'tree' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', 1 => '?', 2 => 'tree', 3 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', 3 => 'link_name', ), 'method' => 'filterSubTree', 'exception' => array ( 0 => 'SugarApiExceptionInvalidParameter', 1 => 'SugarApiExceptionNotAuthorized', 2 => 'SugarApiExceptionNotFound', ), 'file' => 'modules/Categories/clients/base/api/TreeApi.php', 'className' => 'TreeApi', 'score' => 9.5, ), ), ), ), 'chart' => array ( 'pipeline' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', 1 => 'chart', 2 => 'pipeline', 3 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => '', 2 => '', 3 => 'timeperiod_id', ), 'method' => 'pipeline', 'shortHelp' => 'Get the current opportunity pipeline data for a specific timeperiod', 'longHelp' => 'modules/Opportunities/clients/base/api/help/OpportunitiesPipelineChartApi.html', 'file' => 'clients/base/api/PipelineChartApi.php', 'className' => 'PipelineChartApi', 'score' => 10.5, ), ), ), ), ), 'integrate' => array ( '<module>' => array ( '?' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'integrate', 1 => '<module>', 2 => '?', 3 => '?', ), 'pathVars' => array ( 0 => '', 1 => 'module', 2 => 'sync_key_field_name', 3 => 'sync_key_field_value', ), 'method' => 'getByField', 'shortHelp' => 'Retrieve record with given field.', 'file' => 'clients/base/api/IntegrateApi.php', 'className' => 'IntegrateApi', 'score' => 9.5, ), ), ), ), ), 'Administration' => array ( 'packages' => array ( '?' => array ( 'install' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Administration', 1 => 'packages', 2 => '?', 3 => 'install', ), 'pathVars' => array ( 0 => '', 1 => '', 2 => 'id', 3 => '', ), 'method' => 'installPackage', 'shortHelp' => 'Install the given package', 'longHelp' => 'include/api/help/administration_packages_install_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotAuthorized', 1 => 'SugarApiExceptionMissingParameter', 2 => 'SugarApiExceptionNotFound', 3 => 'SugarApiException', ), 'file' => 'modules/Administration/clients/base/api/PackageApiRest.php', 'className' => 'PackageApiRest', 'score' => 11.25, ), ), 'uninstall' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Administration', 1 => 'packages', 2 => '?', 3 => 'uninstall', ), 'pathVars' => array ( 0 => '', 1 => '', 2 => 'id', 3 => '', ), 'method' => 'unInstallPackage', 'shortHelp' => 'Uninstall the given package', 'longHelp' => 'include/api/help/administration_packages_uninstall_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotAuthorized', 1 => 'SugarApiExceptionMissingParameter', 2 => 'SugarApiExceptionNotFound', 3 => 'SugarApiException', ), 'file' => 'modules/Administration/clients/base/api/PackageApiRest.php', 'className' => 'PackageApiRest', 'score' => 11.25, ), ), 'enable' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Administration', 1 => 'packages', 2 => '?', 3 => 'enable', ), 'pathVars' => array ( 0 => '', 1 => '', 2 => 'id', 3 => '', ), 'method' => 'enablePackage', 'shortHelp' => 'Enable the given package', 'longHelp' => 'include/api/help/administration_packages_enable_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotAuthorized', 1 => 'SugarApiExceptionMissingParameter', 2 => 'SugarApiExceptionNotFound', 3 => 'SugarApiException', ), 'file' => 'modules/Administration/clients/base/api/PackageApiRest.php', 'className' => 'PackageApiRest', 'score' => 11.25, ), ), 'disable' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Administration', 1 => 'packages', 2 => '?', 3 => 'disable', ), 'pathVars' => array ( 0 => '', 1 => '', 2 => 'id', 3 => '', ), 'method' => 'disablePackage', 'shortHelp' => 'Disable the given package', 'longHelp' => 'include/api/help/administration_packages_disable_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotAuthorized', 1 => 'SugarApiExceptionMissingParameter', 2 => 'SugarApiExceptionNotFound', 3 => 'SugarApiException', ), 'file' => 'modules/Administration/clients/base/api/PackageApiRest.php', 'className' => 'PackageApiRest', 'score' => 11.25, ), ), 'installation-status' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Administration', 1 => 'packages', 2 => '?', 3 => 'installation-status', ), 'pathVars' => array ( 0 => '', 1 => '', 2 => 'id', 3 => '', ), 'method' => 'getStatus', 'shortHelp' => 'Get a package installation status', 'minVersion' => '11.14', 'longHelp' => 'include/api/help/package_installation_status_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotAuthorized', ), 'ignoreMetaHash' => true, 'ignoreSystemStatusError' => true, 'noLoginRequired' => true, 'file' => 'modules/Administration/clients/base/api/PackageApiRest.php', 'className' => 'PackageApiRest', 'score' => 11.25, ), ), ), ), 'elasticsearch' => array ( 'refresh' => array ( 'status' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Administration', 1 => 'elasticsearch', 2 => 'refresh', 3 => 'status', ), 'pathVars' => array ( 0 => '', ), 'method' => 'elasticSearchRefreshStatus', 'shortHelp' => 'Elasticsearch index refresh status', 'longHelp' => 'include/api/help/administration_elasticsearch_refresh_status_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotAuthorized', 1 => 'SugarApiExceptionSearchUnavailable', ), 'file' => 'modules/Administration/clients/base/api/AdministrationApi.php', 'className' => 'AdministrationApi', 'score' => 12.25, ), ), ), 'replicas' => array ( 'status' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Administration', 1 => 'elasticsearch', 2 => 'replicas', 3 => 'status', ), 'pathVars' => array ( 0 => '', ), 'method' => 'elasticSearchReplicasStatus', 'shortHelp' => 'Elasticsearch index replica status', 'longHelp' => 'include/api/help/administration_elasticsearch_replicas_status_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotAuthorized', 1 => 'SugarApiExceptionSearchUnavailable', ), 'file' => 'modules/Administration/clients/base/api/AdministrationApi.php', 'className' => 'AdministrationApi', 'score' => 12.25, ), ), ), ), ), '?' => array ( '?' => array ( 'customer-journey' => array ( 'chart-data' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '?', 1 => '?', 2 => 'customer-journey', 3 => 'chart-data', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', 3 => '', 4 => 'selected', ), 'method' => 'chartData', 'shortHelp' => 'Provide journey and related stages data of chart', 'longHelp' => '/include/api/help/customer_journeyDRI_WorkflowschartData.html', 'noEtag' => true, 'minVersion' => '11.19', 'file' => 'modules/DRI_Workflows/clients/base/api/DRI_WorkflowsApi.php', 'className' => 'DRI_WorkflowsApi', 'score' => 10.25, ), ), 'momentum-chart' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '?', 1 => '?', 2 => 'customer-journey', 3 => 'momentum-chart', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', 3 => '', 4 => 'selected', ), 'method' => 'momentumChart', 'shortHelp' => 'Provide journey related data for momentum chart', 'longHelp' => '/include/api/help/customer_journeyDRI_WorkflowsmomentumChart.html', 'noEtag' => true, 'minVersion' => '11.19', 'file' => 'modules/DRI_Workflows/clients/base/api/DRI_WorkflowsApi.php', 'className' => 'DRI_WorkflowsApi', 'score' => 10.25, ), ), ), ), ), 'ForecastManagerWorksheets' => array ( 'chart' => array ( '?' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'ForecastManagerWorksheets', 1 => 'chart', 2 => '?', 3 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => '', 2 => 'timeperiod_id', 3 => 'user_id', ), 'method' => 'forecastManagerWorksheetsChartGet', 'jsonParams' => array ( ), 'shortHelp' => 'Filter records and reformat data for chart presentation', 'longHelp' => 'modules/Forecasts/clients/base/api/help/forecastManagerWorksheetsChartGet.html', 'exceptions' => array ( 0 => 'SugarApiExceptionError', 1 => 'SugarApiExceptionInvalidParameter', 2 => 'SugarApiExceptionNotFound', ), 'file' => 'modules/ForecastManagerWorksheets/clients/base/api/ForecastManagerWorksheetsFilterApi.php', 'className' => 'ForecastManagerWorksheetsFilterApi', 'score' => 10.25, ), ), ), ), ), 'EmbeddedFiles' => array ( '?' => array ( 'file' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'EmbeddedFiles', 1 => '?', 2 => 'file', 3 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', 3 => 'field', ), 'method' => 'getFile', 'rawReply' => true, 'allowDownloadCookie' => true, 'shortHelp' => 'Gets the contents of a single file related to a field for a module record.', 'longHelp' => 'include/api/help/module_record_file_field_get_help.html', 'file' => 'modules/EmbeddedFiles/clients/base/api/EmbeddedFileApi.php', 'className' => 'EmbeddedFileApi', 'score' => 10.25, ), ), ), ), ), 'ExternalUsers' => array ( '?' => array ( 'link' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'ExternalUsers', 1 => '?', 2 => 'link', 3 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', 3 => 'link_name', ), 'jsonParams' => array ( 0 => 'filter', ), 'method' => 'filterRelated', 'shortHelp' => 'Lists related records.', 'longHelp' => 'include/api/help/module_record_link_link_name_filter_get_help.html', 'file' => 'modules/ExternalUsers/clients/base/api/ExternalUsersRelateApi.php', 'className' => 'ExternalUsersRelateApi', 'score' => 10.25, ), ), ), ), ), 'pmse_Project' => array ( 'CrmData' => array ( '?' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'pmse_Project', 1 => 'CrmData', 2 => '?', 3 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => '', 2 => 'data', 3 => 'filter', ), 'method' => 'getCrmData', 'acl' => 'view', 'shortHelp' => 'Retrieves information about Fields, Modules, Users, Roles, etc.', 'longHelp' => 'modules/pmse_Project/clients/base/api/help/project_crm_data_get_help.html', 'file' => 'modules/pmse_Project/clients/base/api/PMSEProjectApi.php', 'className' => 'PMSEProjectApi', 'score' => 10.25, ), ), ), ), 'validateCrmData' => array ( '?' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'pmse_Project', 1 => 'validateCrmData', 2 => '?', 3 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => '', 2 => 'data', 3 => 'filter', ), 'method' => 'validateCrmData', 'acl' => 'view', 'shortHelp' => 'Validates whether BPM data exists in the system (Fields, Modules, Users, Roles, etc.)', 'longHelp' => 'modules/pmse_Project/clients/base/api/help/project_validate_crm_data_get_help.html', 'minVersion' => '11.10', 'file' => 'modules/pmse_Project/clients/base/api/PMSEProjectApi.php', 'className' => 'PMSEProjectApi', 'score' => 10.25, ), ), ), ), '?' => array ( 'file' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'pmse_Project', 1 => '?', 2 => 'file', 3 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', 3 => 'field', ), 'method' => 'getProjectFile', 'rawReply' => true, 'allowDownloadCookie' => true, 'file' => 'modules/pmse_Inbox/clients/base/api/PMSEImageGeneratorApi.php', 'className' => 'PMSEImageGeneratorApi', 'score' => 10.25, ), ), ), ), ), 'Notes' => array ( '?' => array ( 'file' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Notes', 1 => '?', 2 => 'file', 3 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', 3 => 'field', ), 'method' => 'getFile', 'rawReply' => true, 'allowDownloadCookie' => true, 'shortHelp' => 'Gets the contents of a single file related to a field for a module record.', 'longHelp' => 'include/api/help/module_record_file_field_get_help.html', 'file' => 'modules/Notes/clients/base/api/NotesFileApi.php', 'className' => 'NotesFileApi', 'score' => 10.25, ), ), ), ), ), 'ForecastWorksheets' => array ( 'chart' => array ( '?' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'ForecastWorksheets', 1 => 'chart', 2 => '?', 3 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => '', 2 => 'timeperiod_id', 3 => 'user_id', ), 'method' => 'forecastWorksheetsChartGet', 'jsonParams' => array ( ), 'shortHelp' => 'Filter records and reformat data for chart presentation', 'longHelp' => 'modules/Forecasts/clients/base/api/help/ForecastsWorksheetChartGet.html', 'exceptions' => array ( 0 => 'SugarApiExceptionError', 1 => 'SugarApiExceptionInvalidParameter', 2 => 'SugarApiExceptionNotAuthorized', 3 => 'SugarApiExceptionNotFound', ), 'file' => 'modules/ForecastWorksheets/clients/base/api/ForecastWorksheetsFilterApi.php', 'className' => 'ForecastWorksheetsFilterApi', 'score' => 10.25, ), ), ), ), ), 'Forecasts' => array ( '?' => array ( 'progressRep' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Forecasts', 1 => '?', 2 => 'progressRep', 3 => '?', ), 'pathVars' => array ( 0 => '', 1 => 'timeperiod_id', 2 => '', 3 => 'user_id', ), 'method' => 'progressRep', 'shortHelp' => 'Projected Rep data', 'longHelp' => 'modules/Forecasts/clients/base/api/help/ForecastProgressRepApi.html', 'file' => 'modules/Forecasts/clients/base/api/ForecastsProgressApi.php', 'className' => 'ForecastsProgressApi', 'score' => 10.25, ), ), ), 'progressManager' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Forecasts', 1 => '?', 2 => 'progressManager', 3 => '?', ), 'pathVars' => array ( 0 => '', 1 => 'timeperiod_id', 2 => '', 3 => 'user_id', ), 'method' => 'progressManager', 'shortHelp' => 'Progress Manager data', 'longHelp' => 'modules/Forecasts/clients/base/api/help/ForecastProgressManagerApi.html', 'file' => 'modules/Forecasts/clients/base/api/ForecastsProgressApi.php', 'className' => 'ForecastsProgressApi', 'score' => 10.25, ), ), ), ), ), 'pmse_Inbox' => array ( '?' => array ( 'file' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'pmse_Inbox', 1 => '?', 2 => 'file', 3 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', 3 => 'field', ), 'method' => 'getFile', 'rawReply' => true, 'allowDownloadCookie' => true, 'shortHelp' => 'Returns the process status image file', 'longHelp' => 'modules/pmse_Inbox/clients/base/api/help/process_get_file_help.html', 'file' => 'modules/pmse_Inbox/clients/base/api/PMSEImageGeneratorApi.php', 'className' => 'PMSEImageGeneratorApi', 'score' => 10.25, ), ), ), ), 'ReassignForm' => array ( '?' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'pmse_Inbox', 1 => 'ReassignForm', 2 => '?', 3 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => '', 2 => 'data', 3 => 'flowId', ), 'method' => 'getReassign', 'keepSession' => true, 'shortHelp' => 'Retrieve information for Assign to new user window. DEPRECATED', 'longHelp' => 'modules/pmse_Inbox/clients/base/api/help/process_deprecate.html', 'file' => 'modules/pmse_Inbox/clients/base/api/PMSEEngineApi.php', 'className' => 'PMSEEngineApi', 'score' => 10.25, ), ), ), ), 'AdhocReassign' => array ( '?' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'pmse_Inbox', 1 => 'AdhocReassign', 2 => '?', 3 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => '', 2 => 'data', 3 => 'flowId', ), 'method' => 'getAdhoc', 'keepSession' => true, 'shortHelp' => 'Retrieve information for Change Process User window. DEPRECATED', 'longHelp' => 'modules/pmse_Inbox/clients/base/api/help/process_deprecate.html', 'file' => 'modules/pmse_Inbox/clients/base/api/PMSEEngineApi.php', 'className' => 'PMSEEngineApi', 'score' => 10.25, ), ), ), ), 'case' => array ( '?' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'pmse_Inbox', 1 => 'case', 2 => '?', 3 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'case', 2 => 'id', 3 => 'idflow', ), 'method' => 'selectCase', 'keepSession' => true, 'shortHelp' => 'Retrieve information of the process record', 'longHelp' => 'modules/pmse_Inbox/clients/base/api/help/process_select_case_help.html', 'file' => 'modules/pmse_Inbox/clients/base/api/PMSEEngineApi.php', 'className' => 'PMSEEngineApi', 'score' => 10.25, ), ), ), ), 'caseRecord' => array ( '?' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'pmse_Inbox', 1 => 'caseRecord', 2 => '?', 3 => '?', ), 'pathVars' => array ( 0 => '', 1 => '', 2 => 'module', 3 => 'record', ), 'method' => 'getCaseRecord', 'file' => 'modules/pmse_Inbox/clients/base/api/PMSEEngineApi.php', 'className' => 'PMSEEngineApi', 'score' => 10.25, ), ), ), ), ), 'DocumentMerge' => array ( 'getCurrencySymbol' => array ( '?' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'DocumentMerge', 1 => 'getCurrencySymbol', 2 => '?', 3 => '?', ), 'pathVars' => array ( 0 => 'DocumentMerge', 1 => 'getCurrencySymbol', 2 => 'module', 3 => 'record_id', ), 'method' => 'getCurrencySymbol', 'shortHelp' => 'Retrieves the currency symbol from a certain record', 'longHelp' => 'include/api/help/document_merges_get_currency_symbol.html', 'file' => 'modules/DocumentMerges/clients/base/api/DocumentMergeApi.php', 'className' => 'DocumentMergeApi', 'score' => 10.25, ), ), ), ), ), ), 'DELETE' => array ( 'integrate' => array ( '<module>' => array ( '?' => array ( '?' => array ( 0 => array ( 'reqType' => 'DELETE', 'path' => array ( 0 => 'integrate', 1 => '<module>', 2 => '?', 3 => '?', ), 'pathVars' => array ( 0 => '', 1 => 'module', 2 => 'sync_key_field_name', 3 => 'sync_key_field_value', ), 'method' => 'deleteByField', 'shortHelp' => 'Delete record with given field.', 'file' => 'clients/base/api/IntegrateApi.php', 'className' => 'IntegrateApi', 'score' => 9.5, ), ), ), ), ), '<module>' => array ( '?' => array ( 'file' => array ( '?' => array ( 0 => array ( 'reqType' => 'DELETE', 'path' => array ( 0 => '<module>', 1 => '?', 2 => 'file', 3 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', 3 => 'field', ), 'method' => 'removeFile', 'rawPostContents' => true, 'shortHelp' => 'Removes a file from a field.', 'longHelp' => 'include/api/help/module_record_file_field_delete_help.html', 'file' => 'clients/base/api/FileApi.php', 'className' => 'FileApi', 'score' => 9.5, ), ), ), ), ), 'Filters' => array ( '?' => array ( 'used' => array ( '?' => array ( 0 => array ( 'reqType' => 'DELETE', 'path' => array ( 0 => 'Filters', 1 => '?', 2 => 'used', 3 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'module_name', 2 => 'used', 3 => 'record', ), 'method' => 'deleteUsed', 'shortHelp' => 'This method deletes the used filter for the current user', 'longHelp' => '', 'file' => 'modules/Filters/clients/base/api/PreviouslyUsedFiltersApi.php', 'className' => 'PreviouslyUsedFiltersApi', 'score' => 10.25, ), ), ), ), ), 'Users' => array ( '?' => array ( 'file' => array ( '?' => array ( 0 => array ( 'reqType' => 'DELETE', 'path' => array ( 0 => 'Users', 1 => '?', 2 => 'file', 3 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', 3 => 'field', ), 'method' => 'removeFile', 'rawPostContents' => true, 'shortHelp' => 'Removes a file from a field.', 'longHelp' => 'include/api/help/module_record_file_field_delete_help.html', 'file' => 'modules/Users/clients/base/api/UsersFileApi.php', 'className' => 'UsersFileApi', 'score' => 10.25, ), ), ), ), ), ), 'PATCH' => array ( 'integrate' => array ( '<module>' => array ( '?' => array ( '?' => array ( 0 => array ( 'reqType' => 'PATCH', 'path' => array ( 0 => 'integrate', 1 => '<module>', 2 => '?', 3 => '?', ), 'pathVars' => array ( 0 => '', 1 => 'module', 2 => 'sync_key_field_name', 3 => 'sync_key_field_value', ), 'method' => 'upsertByField', 'shortHelp' => 'Upsert based on a field. If the record can be found with the provided field, then update. If the record does not exist, then create it. Recommended use of PATCH HTTP verb.', 'file' => 'clients/base/api/IntegrateApi.php', 'className' => 'IntegrateApi', 'score' => 9.5, ), ), ), ), ), ), 'PUT' => array ( 'integrate' => array ( '<module>' => array ( '?' => array ( '?' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'integrate', 1 => '<module>', 2 => '?', 3 => '?', ), 'pathVars' => array ( 0 => '', 1 => 'module', 2 => 'sync_key_field_name', 3 => 'sync_key_field_value', ), 'method' => 'upsertByField', 'shortHelp' => 'Upsert based on a field. If the record can be found with the provided field, then update. If the record does not exist, then create it. Recommended use of PATCH HTTP verb.', 'file' => 'clients/base/api/IntegrateApi.php', 'className' => 'IntegrateApi', 'score' => 9.5, ), ), ), ), ), '<module>' => array ( '?' => array ( 'file' => array ( '?' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => '<module>', 1 => '?', 2 => 'file', 3 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', 3 => 'field', ), 'method' => 'saveFilePut', 'rawPostContents' => true, 'shortHelp' => 'Saves a file. The file can be a new file or a file override. (This is an alias of the POST method save.)', 'longHelp' => 'include/api/help/module_record_file_field_put_help.html', 'file' => 'clients/base/api/FileApi.php', 'className' => 'FileApi', 'score' => 9.5, ), ), ), 'movebefore' => array ( '?' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => '<module>', 1 => '?', 2 => 'movebefore', 3 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => 'movebefore', 3 => 'target', ), 'method' => 'moveBefore', 'shortHelp' => 'This method record as previous sibling of target', 'longHelp' => 'modules/Categories/clients/base/api/help/tree_put_movebefore_help.html', 'file' => 'modules/Categories/clients/base/api/TreeApi.php', 'className' => 'TreeApi', 'score' => 9.5, ), ), ), 'moveafter' => array ( '?' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => '<module>', 1 => '?', 2 => 'moveafter', 3 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => 'moveafter', 3 => 'target', ), 'method' => 'moveAfter', 'shortHelp' => 'This method record as next sibling of target', 'longHelp' => 'modules/Categories/clients/base/api/help/tree_put_moveafter_help.html', 'file' => 'modules/Categories/clients/base/api/TreeApi.php', 'className' => 'TreeApi', 'score' => 9.5, ), ), ), 'movefirst' => array ( '?' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => '<module>', 1 => '?', 2 => 'movefirst', 3 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => 'movefirst', 3 => 'target', ), 'method' => 'moveFirst', 'shortHelp' => 'This method record as first child of target', 'longHelp' => 'modules/Categories/clients/base/api/help/tree_put_movefirst_help.html', 'file' => 'modules/Categories/clients/base/api/TreeApi.php', 'className' => 'TreeApi', 'score' => 9.5, ), ), ), 'movelast' => array ( '?' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => '<module>', 1 => '?', 2 => 'movelast', 3 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => 'movelast', 3 => 'target', ), 'method' => 'moveLast', 'shortHelp' => 'This method record as last child of target', 'longHelp' => 'modules/Categories/clients/base/api/help/tree_put_movelast_help.html', 'file' => 'modules/Categories/clients/base/api/TreeApi.php', 'className' => 'TreeApi', 'score' => 9.5, ), ), ), ), ), 'EmbeddedFiles' => array ( '?' => array ( 'file' => array ( '?' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'EmbeddedFiles', 1 => '?', 2 => 'file', 3 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', 3 => 'field', ), 'method' => 'saveFilePut', 'rawPostContents' => true, 'shortHelp' => 'Saves a file. The file can be a new file or a file override. (This is an alias of the POST method save.)', 'longHelp' => 'include/api/help/module_record_file_field_put_help.html', 'file' => 'modules/EmbeddedFiles/clients/base/api/EmbeddedFileApi.php', 'className' => 'EmbeddedFileApi', 'score' => 10.25, ), ), ), ), ), 'Documents' => array ( '?' => array ( 'file' => array ( '?' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'Documents', 1 => '?', 2 => 'file', 3 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', 3 => 'field', ), 'method' => 'saveFilePut', 'rawPostContents' => true, 'shortHelp' => 'Saves a file. The file can be a new file or a file override. (This is an alias of the POST method save.)', 'longHelp' => 'include/api/help/module_record_file_field_put_help.html', 'file' => 'modules/Documents/clients/base/api/DocumentsFileApi.php', 'className' => 'DocumentsFileApi', 'score' => 10.25, ), ), ), ), ), 'pmse_Project' => array ( 'CrmData' => array ( '?' => array ( '?' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'pmse_Project', 1 => 'CrmData', 2 => '?', 3 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => '', 2 => 'record', 3 => 'filter', ), 'method' => 'putCrmData', 'acl' => 'create', 'shortHelp' => 'Updates information about Fields, Modules, Users, Roles, etc.', 'longHelp' => 'modules/pmse_Project/clients/base/api/help/project_crm_data_put_help.html', 'file' => 'modules/pmse_Project/clients/base/api/PMSEProjectApi.php', 'className' => 'PMSEProjectApi', 'score' => 10.25, ), ), ), ), ), ), 'POST' => array ( '<module>' => array ( '?' => array ( 'file' => array ( '?' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => '<module>', 1 => '?', 2 => 'file', 3 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', 3 => 'field', ), 'method' => 'saveFilePost', 'rawPostContents' => true, 'shortHelp' => 'Saves a file. The file can be a new file or a file override.', 'longHelp' => 'include/api/help/module_record_file_field_post_help.html', 'file' => 'clients/base/api/FileApi.php', 'className' => 'FileApi', 'score' => 9.5, ), ), ), 'link' => array ( '?' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => '<module>', 1 => '?', 2 => 'link', 3 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', 3 => 'link_name', ), 'method' => 'createRelatedRecord', 'shortHelp' => 'Create a single record and relate it to this module', 'longHelp' => 'include/api/help/module_record_link_link_name_post_help.html', 'file' => 'clients/base/api/RelateRecordApi.php', 'className' => 'RelateRecordApi', 'score' => 9.5, ), ), 'commentlog_link' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => '<module>', 1 => '?', 2 => 'link', 3 => 'commentlog_link', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', 3 => 'link_name', ), 'method' => 'addComment', 'shortHelp' => 'Add a comment to this module\'s record', 'longHelp' => 'include/api/help/module_record_link_link_name_post_help.html', 'file' => 'modules/CommentLog/clients/base/api/CommentLogRelateRecordApi.php', 'className' => 'CommentLogRelateRecordApi', 'score' => 10.5, ), ), ), ), 'temp' => array ( 'file' => array ( '?' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => '<module>', 1 => 'temp', 2 => 'file', 3 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'temp', 2 => '', 3 => 'field', ), 'method' => 'saveTempImagePost', 'rawPostContents' => true, 'shortHelp' => 'Saves an image to a temporary folder.', 'longHelp' => 'include/api/help/module_temp_file_field_post_help.html', 'file' => 'clients/base/api/FileTempApi.php', 'className' => 'FileTempApi', 'score' => 10.5, ), ), ), ), ), 'hint' => array ( 'data' => array ( 'enrich' => array ( 'fields' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'hint', 1 => 'data', 2 => 'enrich', 3 => 'fields', ), 'pathVars' => array ( 0 => '', ), 'method' => 'updateDataEnrichmentFieldsConfig', 'shortHelp' => 'Updates Data Enrichment Hint configuration', 'longHelp' => 'include/api/help/hint_data_enrich_fields_post_help.html', 'minVersion' => '11.16', 'file' => 'clients/base/api/HintApi.php', 'className' => 'HintApi', 'score' => 12.25, ), ), ), ), ), 'Administration' => array ( 'elasticsearch' => array ( 'refresh' => array ( 'trigger' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Administration', 1 => 'elasticsearch', 2 => 'refresh', 3 => 'trigger', ), 'pathVars' => array ( 0 => '', ), 'method' => 'elasticSearchRefreshTrigger', 'shortHelp' => 'Elasticsearch trigger an index refresh', 'longHelp' => 'include/api/help/administration_elasticsearch_refresh_trigger_post_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotAuthorized', 1 => 'SugarApiExceptionSearchUnavailable', ), 'file' => 'modules/Administration/clients/base/api/AdministrationApi.php', 'className' => 'AdministrationApi', 'score' => 12.25, ), ), 'enable' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Administration', 1 => 'elasticsearch', 2 => 'refresh', 3 => 'enable', ), 'pathVars' => array ( 0 => '', ), 'method' => 'elasticSearchRefreshEnable', 'shortHelp' => 'Elasticsearch enable index refresh', 'longHelp' => 'include/api/help/administration_elasticsearch_refresh_enable_post_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotAuthorized', 1 => 'SugarApiExceptionSearchUnavailable', ), 'file' => 'modules/Administration/clients/base/api/AdministrationApi.php', 'className' => 'AdministrationApi', 'score' => 12.25, ), ), ), 'replicas' => array ( 'enable' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Administration', 1 => 'elasticsearch', 2 => 'replicas', 3 => 'enable', ), 'pathVars' => array ( 0 => '', ), 'method' => 'elasticSearchReplicasEnable', 'shortHelp' => 'Elasticsearch enable index replicas', 'longHelp' => 'include/api/help/administration_elasticsearch_replicas_enable_post_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotAuthorized', 1 => 'SugarApiExceptionSearchUnavailable', ), 'file' => 'modules/Administration/clients/base/api/AdministrationApi.php', 'className' => 'AdministrationApi', 'score' => 12.25, ), ), ), ), 'idm' => array ( 'migration' => array ( 'enable' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Administration', 1 => 'idm', 2 => 'migration', 3 => 'enable', ), 'pathVars' => array ( 0 => '', ), 'method' => 'enableIdmMigration', 'shortHelp' => 'Enable IDM api to perform migrations', 'longHelp' => 'include/api/help/administration_enable_idm_migrations_post_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotAuthorized', ), 'minVersion' => '11.2', 'ignoreSystemStatusError' => true, 'file' => 'modules/Administration/clients/base/api/AdministrationApi.php', 'className' => 'AdministrationApi', 'score' => 12.25, ), ), 'disable' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Administration', 1 => 'idm', 2 => 'migration', 3 => 'disable', ), 'pathVars' => array ( 0 => '', ), 'method' => 'disableIdmMigration', 'shortHelp' => 'Disable IDM migrations', 'longHelp' => 'include/api/help/administration_disable_idm_migrations_post_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotAuthorized', ), 'minVersion' => '11.2', 'ignoreSystemStatusError' => true, 'file' => 'modules/Administration/clients/base/api/AdministrationApi.php', 'className' => 'AdministrationApi', 'score' => 12.25, ), ), ), ), 'maps' => array ( 'config' => array ( '?' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Administration', 1 => 'maps', 2 => 'config', 3 => '?', ), 'pathVars' => array ( 0 => '', 1 => '', 2 => '', 3 => 'category', ), 'method' => 'setConfig', 'shortHelp' => 'Sets configuration for a category', 'longHelp' => 'include/api/help/administration_config_post_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotAuthorized', ), 'ignoreSystemStatusError' => true, 'minVersion' => '11.16', 'file' => 'modules/Administration/clients/base/api/MapsConfigApi.php', 'className' => 'MapsConfigApi', 'score' => 11.25, ), ), ), ), ), '?' => array ( '?' => array ( 'customer-journey' => array ( 'start-cycle' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => '?', 1 => '?', 2 => 'customer-journey', 3 => 'start-cycle', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', ), 'method' => 'start', 'shortHelp' => 'Start Smart Guide template on parent module', 'longHelp' => '/include/api/help/customer_journeyDRI_Workflowsstart.html', 'noEtag' => true, 'minVersion' => '11.19', 'file' => 'modules/DRI_Workflows/clients/base/api/DRI_WorkflowsApi.php', 'className' => 'DRI_WorkflowsApi', 'score' => 10.25, ), ), ), ), ), 'EmbeddedFiles' => array ( '?' => array ( 'file' => array ( '?' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'EmbeddedFiles', 1 => '?', 2 => 'file', 3 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', 3 => 'field', ), 'method' => 'saveFilePost', 'rawPostContents' => true, 'shortHelp' => 'Saves a file. The file can be a new file or a file override.', 'longHelp' => 'include/api/help/module_record_file_field_post_help.html', 'file' => 'modules/EmbeddedFiles/clients/base/api/EmbeddedFileApi.php', 'className' => 'EmbeddedFileApi', 'score' => 10.25, ), ), ), ), ), 'Documents' => array ( '?' => array ( 'file' => array ( '?' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Documents', 1 => '?', 2 => 'file', 3 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', 3 => 'field', ), 'method' => 'saveFilePost', 'rawPostContents' => true, 'shortHelp' => 'Saves a file. The file can be a new file or a file override.', 'longHelp' => 'include/api/help/module_record_file_field_post_help.html', 'file' => 'modules/Documents/clients/base/api/DocumentsFileApi.php', 'className' => 'DocumentsFileApi', 'score' => 10.25, ), ), ), ), ), ), ), 'mobile' => array ( 'GET' => array ( '<module>' => array ( '?' => array ( 'link' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', 1 => '?', 2 => 'link', 3 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', 3 => 'link_name', ), 'jsonParams' => array ( 0 => 'filter', ), 'method' => 'filterRelated', 'shortHelp' => 'Lists related records.', 'longHelp' => 'include/api/help/module_record_link_link_name_filter_get_help.html', 'file' => 'clients/mobile/api/RelateMobileApi.php', 'className' => 'RelateMobileApi', 'score' => 9.5, ), ), ), ), ), ), 'POST' => array ( '<module>' => array ( '?' => array ( 'link' => array ( '?' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => '<module>', 1 => '?', 2 => 'link', 3 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', 3 => 'link_name', ), 'method' => 'createRelatedRecord', 'shortHelp' => 'Create a single record and relate it to this module', 'longHelp' => 'include/api/help/module_record_link_link_name_post_help.html', 'file' => 'clients/mobile/api/RelateRecordMobileApi.php', 'className' => 'RelateRecordMobileApi', 'score' => 9.5, ), ), ), ), ), ), ), ), 3 => array ( 'base' => array ( 'POST' => array ( '<module>' => array ( '?' => array ( 'related_activities' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => '<module>', 1 => '?', 2 => 'related_activities', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', ), 'method' => 'getRelatedActivities', 'minVersion' => '11.23', 'shortHelp' => 'Get the related activity records for a specific record', 'longHelp' => 'include/api/help/related_activities.html', 'file' => 'clients/base/api/RelatedActivitiesApi.php', 'className' => 'RelatedActivitiesApi', 'score' => 8.75, ), ), 'link' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => '<module>', 1 => '?', 2 => 'link', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', ), 'method' => 'createRelatedLinks', 'shortHelp' => 'Relates existing records to this module.', 'longHelp' => 'include/api/help/module_record_link_post_help.html', 'file' => 'clients/base/api/RelateRecordApi.php', 'className' => 'RelateRecordApi', 'score' => 8.75, ), ), 'subscribe' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => '<module>', 1 => '?', 2 => 'subscribe', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', ), 'method' => 'subscribeToRecord', 'shortHelp' => 'This method subscribes the user to the current record, for activity stream updates.', 'longHelp' => 'modules/ActivityStream/clients/base/api/help/recordSubscribe.html', 'file' => 'modules/ActivityStream/clients/base/api/SubscriptionsApi.php', 'className' => 'SubscriptionsApi', 'score' => 8.75, ), ), ), 'filter' => array ( 'count' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => '<module>', 1 => 'filter', 2 => 'count', ), 'pathVars' => array ( 0 => 'module', 1 => '', 2 => '', ), 'method' => 'filterListCount', 'shortHelp' => 'Lists filtered records.', 'longHelp' => 'include/api/help/module_filter_post_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionNotAuthorized', 3 => 'SugarApiExceptionInvalidParameter', ), 'file' => 'clients/base/api/FilterApi.php', 'className' => 'FilterApi', 'score' => 9.75, ), 1 => array ( 'reqType' => 'POST', 'path' => array ( 0 => '<module>', 1 => 'filter', 2 => 'count', ), 'pathVars' => array ( 0 => 'module', 1 => '', 2 => '', ), 'method' => 'filterListCount', 'shortHelp' => 'Lists filtered records.', 'longHelp' => 'include/api/help/module_filter_post_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionNotAuthorized', 3 => 'SugarApiExceptionInvalidParameter', ), 'file' => 'modules/Opportunities/clients/base/api/OpportunitiesFilterApi.php', 'className' => 'OpportunitiesFilterApi', 'score' => 9.75, ), 2 => array ( 'reqType' => 'POST', 'path' => array ( 0 => '<module>', 1 => 'filter', 2 => 'count', ), 'pathVars' => array ( 0 => 'module', 1 => '', 2 => '', ), 'method' => 'filterListCount', 'shortHelp' => 'Lists filtered records.', 'longHelp' => 'include/api/help/module_filter_post_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionNotAuthorized', 3 => 'SugarApiExceptionInvalidParameter', ), 'file' => 'modules/pmse_Project/clients/base/api/PMSEFilterOutboundEmailsApi.php', 'className' => 'PMSEFilterOutboundEmailsApi', 'score' => 9.75, ), 3 => array ( 'reqType' => 'POST', 'path' => array ( 0 => '<module>', 1 => 'filter', 2 => 'count', ), 'pathVars' => array ( 0 => 'module', 1 => '', 2 => '', ), 'method' => 'filterListCount', 'shortHelp' => 'Lists filtered records.', 'longHelp' => 'include/api/help/module_filter_post_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionNotAuthorized', 3 => 'SugarApiExceptionInvalidParameter', ), 'file' => 'modules/DataArchiver/clients/base/api/DataArchiverFilterApi.php', 'className' => 'DataArchiverFilterApi', 'score' => 9.75, ), ), ), 'file' => array ( 'vcard_import' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => '<module>', 1 => 'file', 2 => 'vcard_import', ), 'pathVars' => array ( 0 => 'module', 1 => '', 2 => '', ), 'method' => 'vCardImport', 'rawPostContents' => true, 'shortHelp' => 'Imports a person record from a vcard', 'longHelp' => 'include/api/help/module_file_vcard_import_post_help.html', 'file' => 'clients/base/api/vCardApi.php', 'className' => 'vCardApi', 'score' => 9.75, ), ), ), 'append' => array ( '?' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => '<module>', 1 => 'append', 2 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'append', 2 => 'target', ), 'method' => 'append', 'shortHelp' => 'This method append record to target as last child', 'longHelp' => 'modules/Categories/clients/base/api/help/tree_post_append_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionInvalidParameter', ), 'file' => 'modules/Categories/clients/base/api/TreeApi.php', 'className' => 'TreeApi', 'score' => 8.75, ), ), ), 'prepend' => array ( '?' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => '<module>', 1 => 'prepend', 2 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'prepend', 2 => 'target', ), 'method' => 'prepend', 'shortHelp' => 'This method prepend record to target as first child', 'longHelp' => 'modules/Categories/clients/base/api/help/tree_post_prepend_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionInvalidParameter', ), 'file' => 'modules/Categories/clients/base/api/TreeApi.php', 'className' => 'TreeApi', 'score' => 8.75, ), ), ), 'insertbefore' => array ( '?' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => '<module>', 1 => 'insertbefore', 2 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'insertbefore', 2 => 'target', ), 'method' => 'insertBefore', 'shortHelp' => 'This method insert record as previous sibling of target', 'longHelp' => 'modules/Categories/clients/base/api/help/tree_post_insertbefore_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionInvalidParameter', ), 'file' => 'modules/Categories/clients/base/api/TreeApi.php', 'className' => 'TreeApi', 'score' => 8.75, ), ), ), 'insertafter' => array ( '?' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => '<module>', 1 => 'insertafter', 2 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'insertafter', 2 => 'target', ), 'method' => 'insertAfter', 'shortHelp' => 'This method insert record as next sibling of target', 'longHelp' => 'modules/Categories/clients/base/api/help/tree_post_insertafter_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionInvalidParameter', ), 'file' => 'modules/Categories/clients/base/api/TreeApi.php', 'className' => 'TreeApi', 'score' => 8.75, ), ), ), ), 'oauth2' => array ( 'bwc' => array ( 'login' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'oauth2', 1 => 'bwc', 2 => 'login', ), 'pathVars' => array ( 0 => '', 1 => '', 2 => '', ), 'method' => 'bwcLogin', 'shortHelp' => 'Bwc login for bwc modules. Internal usage only.', 'longHelp' => 'include/api/help/oauth2_bwc_login_post_help.html', 'keepSession' => true, 'ignoreMetaHash' => true, 'ignoreSystemStatusError' => true, 'file' => 'clients/base/api/OAuth2Api.php', 'className' => 'OAuth2Api', 'score' => 10.5, ), ), 'logout' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'oauth2', 1 => 'bwc', 2 => 'logout', ), 'pathVars' => array ( 0 => '', 1 => '', 2 => '', ), 'method' => 'bwcLogout', 'shortHelp' => 'Bwc logout for bwc modules. Internal usage only.', 'longHelp' => 'include/api/help/oauth2_bwc_logout_post_help.html', 'keepSession' => true, 'ignoreMetaHash' => true, 'ignoreSystemStatusError' => true, 'file' => 'clients/base/api/OAuth2Api.php', 'className' => 'OAuth2Api', 'score' => 10.5, ), ), ), 'sudo' => array ( '?' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'oauth2', 1 => 'sudo', 2 => '?', ), 'pathVars' => array ( 0 => '', 1 => '', 2 => 'user_name', ), 'method' => 'sudo', 'shortHelp' => 'Get an access token for another user', 'longHelp' => 'include/api/help/oauth2_sudo_post_help.html', 'ignoreMetaHash' => true, 'file' => 'clients/base/api/OAuth2Api.php', 'className' => 'OAuth2Api', 'score' => 9.5, ), ), ), ), 'integrate' => array ( '<module>' => array ( 'link' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'integrate', 1 => '<module>', 2 => 'link', ), 'pathVars' => array ( 0 => '', 1 => 'module', 2 => '', ), 'method' => 'relateByFields', 'shortHelp' => 'Create a relationship based on fields given from the query params. If both the LHS and RHS records can be found with the respective fields, then relate the RHS record to the LHS record.', 'file' => 'clients/base/api/IntegrateRelateApi.php', 'className' => 'IntegrateRelateApi', 'score' => 9.75, ), ), ), ), 'me' => array ( 'preference' => array ( '?' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'me', 1 => 'preference', 2 => '?', ), 'pathVars' => array ( 0 => '', 1 => '', 2 => 'preference_name', ), 'method' => 'userPreferenceSave', 'shortHelp' => 'Create a preference for the current user', 'longHelp' => 'include/api/help/me_preference_preference_name_post_help.html', 'ignoreSystemStatusError' => true, 'file' => 'clients/base/api/CurrentUserApi.php', 'className' => 'CurrentUserApi', 'score' => 9.5, ), ), ), ), 'hint' => array ( 'enrich' => array ( 'config' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'hint', 1 => 'enrich', 2 => 'config', ), 'pathVars' => array ( 0 => '', ), 'method' => 'createEnrichFieldConfig', 'shortHelp' => 'Posts Hint configuration', 'longHelp' => 'include/api/help/hint_enrich_config_post_help.html', 'minVersion' => '11.16', 'file' => 'clients/base/api/HintApi.php', 'className' => 'HintApi', 'score' => 10.5, ), ), ), 'insights' => array ( 'resync' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'hint', 1 => 'insights', 2 => 'resync', ), 'pathVars' => array ( 0 => '', ), 'method' => 'resync', 'shortHelp' => 'Triggers instance synchronization', 'longHelp' => 'include/api/help/hint_insights_resync_post_help.html', 'minVersion' => '11.16', 'file' => 'clients/base/api/HintApi.php', 'className' => 'HintApi', 'score' => 10.5, ), ), ), ), 'CloudDrive' => array ( 'list' => array ( 'files' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'CloudDrive', 1 => 'list', 2 => 'files', ), 'pathVars' => array ( 0 => 'CloudDrive', 1 => 'list', 2 => 'files', ), 'method' => 'listFiles', 'shortHelp' => 'Lists files in a folder', 'longHelp' => 'include/api/help/cloud_drive_list_files.html', 'minVersion' => '11.16', 'file' => 'clients/base/api/CloudDriveApi.php', 'className' => 'CloudDriveApi', 'score' => 10.5, ), ), 'folders' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'CloudDrive', 1 => 'list', 2 => 'folders', ), 'pathVars' => array ( 0 => 'CloudDrive', 1 => 'list', 2 => 'folders', ), 'method' => 'listFolders', 'shortHelp' => 'Lists folders in a drive', 'longHelp' => 'include/api/help/cloud_drive_list_folders.html', 'minVersion' => '11.16', 'file' => 'clients/base/api/CloudDriveApi.php', 'className' => 'CloudDriveApi', 'score' => 10.5, ), ), ), 'shared' => array ( 'link' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'CloudDrive', 1 => 'shared', 2 => 'link', ), 'pathVars' => array ( 0 => 'CloudDrive', 1 => 'shared', 2 => 'link', ), 'method' => 'getSharedLink', 'shortHelp' => 'Retrieves a file shared link', 'longHelp' => 'include/api/help/cloud_drive_shared_link.html', 'minVersion' => '11.16', 'file' => 'clients/base/api/CloudDriveApi.php', 'className' => 'CloudDriveApi', 'score' => 10.5, ), ), ), 'files' => array ( 'syncAll' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'CloudDrive', 1 => 'files', 2 => 'syncAll', ), 'pathVars' => array ( 0 => 'CloudDrive', 1 => 'files', 2 => 'syncAll', ), 'method' => 'syncAllFiles', 'shortHelp' => 'Syncs documents', 'longHelp' => 'include/api/help/cloud_drive_sync_all.html', 'minVersion' => '11.16', 'file' => 'clients/base/api/CloudDriveApi.php', 'className' => 'CloudDriveApi', 'score' => 10.5, ), ), 'syncFile' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'CloudDrive', 1 => 'files', 2 => 'syncFile', ), 'pathVars' => array ( 0 => 'CloudDrive', 1 => 'files', 2 => 'syncFile', ), 'method' => 'syncFile', 'shortHelp' => 'Syncs document', 'longHelp' => 'include/api/help/cloud_drive_sync_file.html', 'minVersion' => '11.16', 'file' => 'clients/base/api/CloudDriveApi.php', 'className' => 'CloudDriveApi', 'score' => 10.5, ), ), ), ), 'Calendar' => array ( 'updateRecord' => array ( '?' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Calendar', 1 => 'updateRecord', 2 => '?', ), 'pathVars' => array ( 0 => 'calendarModule', 1 => 'action', 2 => 'recordId', ), 'method' => 'updateRecord', 'shortHelp' => 'update record', 'longHelp' => 'modules/Calendar/clients/base/api/help/calendar_updaterecord_post_help.html', 'minVersion' => '11.14', 'file' => 'modules/Calendar/clients/base/api/CalendarApi.php', 'className' => 'CalendarApi', 'score' => 9.5, ), ), ), ), 'Administration' => array ( 'package' => array ( 'customizations' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Administration', 1 => 'package', 2 => 'customizations', ), 'pathVars' => array ( 0 => '', 1 => '', ), 'method' => 'extractCustomizations', 'shortHelp' => 'Extract customizations', 'longHelp' => 'include/api/help/administration_package_customizations_post_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionInvalidParameter', 1 => 'SugarApiExceptionNotAuthorized', ), 'file' => 'modules/Administration/clients/base/api/PackageBuilderApi.php', 'className' => 'PackageBuilderApi', 'score' => 10.5, ), ), 'remote' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Administration', 1 => 'package', 2 => 'remote', ), 'pathVars' => array ( 0 => '', 1 => '', 2 => '', ), 'method' => 'uploadRemotePackage', 'shortHelp' => 'Upload the given remote package to local instance', 'longHelp' => 'include/api/help/administration_package_remote_post_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionInvalidParameter', 1 => 'SugarApiExceptionNotAuthorized', ), 'file' => 'modules/Administration/clients/base/api/PackageBuilderApi.php', 'className' => 'PackageBuilderApi', 'score' => 10.5, ), ), 'data' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Administration', 1 => 'package', 2 => 'data', ), 'pathVars' => array ( 0 => '', 1 => '', 2 => '', ), 'method' => 'fetchCustomizationsData', 'shortHelp' => 'Fetch customizations\' data', 'longHelp' => 'include/api/help/administration_customizations_data_post_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionInvalidParameter', 1 => 'SugarApiExceptionNotAuthorized', ), 'file' => 'modules/Administration/clients/base/api/PackageBuilderApi.php', 'className' => 'PackageBuilderApi', 'score' => 10.5, ), ), 'getRemotePackages' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Administration', 1 => 'package', 2 => 'getRemotePackages', ), 'pathVars' => array ( 0 => '', 1 => '', 2 => '', ), 'method' => 'getRemotePackages', 'shortHelp' => 'Load packages data from remote instance', 'longHelp' => 'include/api/help/administration_package_connection_post_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionInvalidParameter', 1 => 'SugarApiExceptionNotAuthorized', ), 'file' => 'modules/Administration/clients/base/api/PackageBuilderApi.php', 'className' => 'PackageBuilderApi', 'score' => 10.5, ), ), ), 'config' => array ( '?' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Administration', 1 => 'config', 2 => '?', ), 'pathVars' => array ( 0 => '', 1 => '', 2 => 'category', ), 'method' => 'setConfig', 'shortHelp' => 'Sets configuration for a category', 'longHelp' => 'include/api/help/administration_config_post_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotAuthorized', ), 'ignoreSystemStatusError' => true, 'minVersion' => '11.13', 'file' => 'modules/Administration/clients/base/api/ConfigApi.php', 'className' => 'ConfigApi', 'score' => 9.5, ), ), ), 'search' => array ( 'reindex' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Administration', 1 => 'search', 2 => 'reindex', ), 'pathVars' => array ( 0 => '', ), 'method' => 'searchReindex', 'shortHelp' => 'Perform a reindex', 'longHelp' => 'include/api/help/administration_search_reindex_post_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotAuthorized', 1 => 'SugarApiExceptionSearchUnavailable', ), 'file' => 'modules/Administration/clients/base/api/AdministrationApi.php', 'className' => 'AdministrationApi', 'score' => 10.5, ), ), ), 'denormalization' => array ( 'abort' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Administration', 1 => 'denormalization', 2 => 'abort', ), 'pathVars' => array ( 0 => '', ), 'method' => 'abortProcess', 'shortHelp' => 'Abort the current process', 'exceptions' => array ( 0 => 'SugarApiExceptionNotAuthorized', ), 'file' => 'modules/Administration/clients/base/api/DenormalizationApi.php', 'className' => 'DenormalizationApi', 'score' => 10.5, ), ), 'pre-check' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Administration', 1 => 'denormalization', 2 => 'pre-check', ), 'pathVars' => array ( 0 => '', ), 'method' => 'preCheck', 'shortHelp' => 'Check configuration', 'exceptions' => array ( 0 => 'SugarApiExceptionNotAuthorized', ), 'file' => 'modules/Administration/clients/base/api/DenormalizationApi.php', 'className' => 'DenormalizationApi', 'score' => 10.5, ), ), 'apply' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Administration', 1 => 'denormalization', 2 => 'apply', ), 'pathVars' => array ( 0 => '', ), 'method' => 'runProcess', 'shortHelp' => 'Apply configuration', 'exceptions' => array ( 0 => 'SugarApiExceptionNotAuthorized', ), 'file' => 'modules/Administration/clients/base/api/DenormalizationApi.php', 'className' => 'DenormalizationApi', 'score' => 10.5, ), ), ), 'settings' => array ( 'idmMode' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Administration', 1 => 'settings', 2 => 'idmMode', ), 'pathVars' => array ( 0 => '', ), 'method' => 'switchOnIdmMode', 'shortHelp' => 'Turns IDM mode on', 'longHelp' => 'include/api/help/administration_settings_post_idm_mode_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotAuthorized', 1 => 'SugarApiExceptionMissingParameter', ), 'minVersion' => '11.2', 'ignoreSystemStatusError' => true, 'file' => 'modules/Administration/clients/base/api/AuthSettingsApi.php', 'className' => 'AuthSettingsApi', 'score' => 10.5, ), ), ), ), 'Quotes' => array ( '?' => array ( 'opportunity' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Quotes', 1 => '?', 2 => 'opportunity', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => 'opportunity', ), 'method' => 'convertQuote', 'shortHelp' => 'Convert a Quote into another record', 'longHelp' => 'modules/Quotes/clients/base/api/help/quote_convert.html', 'file' => 'modules/Quotes/clients/base/api/QuoteConvertApi.php', 'className' => 'QuoteConvertApi', 'score' => 9.5, ), ), ), ), 'DRI_Workflows' => array ( '?' => array ( 'archive' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'DRI_Workflows', 1 => '?', 2 => 'archive', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', ), 'method' => 'archive', 'shortHelp' => 'Set the archived status of current journey to true', 'longHelp' => '/include/api/help/customer_journeyDRI_Workflowsarchive.html', 'noEtag' => true, 'minVersion' => '11.19', 'file' => 'modules/DRI_Workflows/clients/base/api/DRI_WorkflowsApi.php', 'className' => 'DRI_WorkflowsApi', 'score' => 9.5, ), ), 'unarchive' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'DRI_Workflows', 1 => '?', 2 => 'unarchive', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', ), 'method' => 'unarchive', 'shortHelp' => 'Set the archived status of current journey to false', 'longHelp' => '/include/api/help/customer_journeyDRI_Workflowsunarchive.html', 'noEtag' => true, 'minVersion' => '11.19', 'file' => 'modules/DRI_Workflows/clients/base/api/DRI_WorkflowsApi.php', 'className' => 'DRI_WorkflowsApi', 'score' => 9.5, ), ), ), ), 'dri-workflows' => array ( 'create-relationship' => array ( '?' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'dri-workflows', 1 => 'create-relationship', 2 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'action', 2 => 'repair', ), 'method' => 'createModuleRelationships', 'shortHelp' => 'Create relationship of DRI_Workflows with some Sugar Core Modules', 'longHelp' => '/include/api/help/customer_journeyDRI_WorkflowsCreateDefRelationships.html', 'minVersion' => '11.19', 'file' => 'modules/DRI_Workflows/clients/base/api/DRI_WorkflowsApi.php', 'className' => 'DRI_WorkflowsApi', 'score' => 9.5, ), ), ), ), 'KBContents' => array ( '?' => array ( 'link' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'KBContents', 1 => '?', 2 => 'link', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', ), 'method' => 'createRelatedLinks', 'shortHelp' => 'Relates existing records to this module.', 'longHelp' => 'include/api/help/module_record_link_post_help.html', 'file' => 'modules/KBContents/clients/base/api/KBContentsRelateRecordApi.php', 'className' => 'KBContentsRelateRecordApi', 'score' => 9.5, ), ), ), ), 'Emails' => array ( '?' => array ( 'link' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Emails', 1 => '?', 2 => 'link', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', ), 'method' => 'createRelatedLinks', 'shortHelp' => 'Relates existing records to an email', 'longHelp' => 'modules/Emails/clients/base/api/help/emails_record_link_post_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionMissingParameter', 1 => 'SugarApiExceptionNotAuthorized', 2 => 'SugarApiExceptionNotFound', ), 'file' => 'modules/Emails/clients/base/api/EmailsRelateRecordApi.php', 'className' => 'EmailsRelateRecordApi', 'score' => 9.5, ), ), ), 'filter' => array ( 'count' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Emails', 1 => 'filter', 2 => 'count', ), 'pathVars' => array ( 0 => 'module', 1 => '', 2 => '', ), 'method' => 'filterListCount', 'shortHelp' => 'Lists filtered records.', 'longHelp' => 'include/api/help/module_filter_post_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionNotAuthorized', 3 => 'SugarApiExceptionInvalidParameter', ), 'file' => 'modules/Emails/clients/base/api/EmailsFilterApi.php', 'className' => 'EmailsFilterApi', 'score' => 10.5, ), ), ), ), 'Mail' => array ( 'recipients' => array ( 'lookup' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Mail', 1 => 'recipients', 2 => 'lookup', ), 'pathVars' => array ( 0 => '', ), 'method' => 'recipientLookup', 'shortHelp' => 'Lookup Email Recipient Info', 'longHelp' => 'modules/Emails/clients/base/api/help/mail_recipients_lookup_post_help.html', 'file' => 'modules/Emails/clients/base/api/MailApi.php', 'className' => 'MailApi', 'score' => 10.5, ), ), ), 'address' => array ( 'validate' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Mail', 1 => 'address', 2 => 'validate', ), 'pathVars' => array ( 0 => '', ), 'method' => 'validateEmailAddresses', 'shortHelp' => 'Validate One Or More Email Address', 'longHelp' => 'modules/Emails/clients/base/api/help/mail_address_validate_post_help.html', 'file' => 'modules/Emails/clients/base/api/MailApi.php', 'className' => 'MailApi', 'score' => 10.5, ), ), ), ), 'Dashboards' => array ( 'filter' => array ( 'count' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Dashboards', 1 => 'filter', 2 => 'count', ), 'pathVars' => array ( 0 => 'module', 1 => '', 2 => '', ), 'method' => 'filterListCount', 'shortHelp' => 'Lists filtered records.', 'longHelp' => 'include/api/help/module_filter_post_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionNotAuthorized', 3 => 'SugarApiExceptionInvalidParameter', ), 'file' => 'modules/Dashboards/clients/base/api/DashboardsFilterApi.php', 'className' => 'DashboardsFilterApi', 'score' => 10.5, ), ), ), ), 'pmse_Project' => array ( 'file' => array ( 'project_import' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'pmse_Project', 1 => 'file', 2 => 'project_import', ), 'pathVars' => array ( 0 => 'module', 1 => '', 2 => '', ), 'method' => 'projectImport', 'rawPostContents' => true, 'acl' => 'create', 'shortHelp' => 'Imports a Process Definition from a .bpm file', 'longHelp' => 'modules/pmse_Project/clients/base/api/help/project_import_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotAuthorized', 1 => 'SugarApiExceptionNotAuthorized', 2 => 'SugarApiExceptionRequestMethodFailure', 3 => 'SugarApiExceptionMissingParameter', ), 'file' => 'modules/pmse_Project/clients/base/api/PMSEProjectImportExportApi.php', 'className' => 'PMSEProjectImportExportApi', 'score' => 10.5, ), ), ), ), 'Leads' => array ( '?' => array ( 'convert' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Leads', 1 => '?', 2 => 'convert', ), 'pathVars' => array ( 0 => '', 1 => 'leadId', 2 => '', ), 'method' => 'convertLead', 'shortHelp' => 'Convert Lead to a Contact and optionally link it to a new or existing module such as an Account or Opportunity', 'longHelp' => 'modules/Leads/clients/base/api/help/LeadConvertApi.html', 'file' => 'modules/Leads/clients/base/api/LeadConvertApi.php', 'className' => 'LeadConvertApi', 'score' => 9.5, ), ), ), ), 'DocuSign' => array ( 'notification' => array ( '?' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'DocuSign', 1 => 'notification', 2 => '?', ), 'pathVars' => array ( 0 => '', 1 => '', 2 => 'authorization', ), 'method' => 'notification', 'shortHelp' => 'This method is called by DocuSign for Events on Envelope', 'longHelp' => 'modules/DocuSignEnvelopes/clients/base/api/help/docusignenvelopes_notification_post_help.html', 'noLoginRequired' => true, 'rawPostContents' => true, 'minVersion' => '11.16', 'file' => 'modules/DocuSignEnvelopes/clients/base/api/DocuSignNotificationApi.php', 'className' => 'DocuSignNotificationApi', 'score' => 9.5, ), ), ), ), 'DRI_Workflow_Templates' => array ( '?' => array ( 'update-activity-order' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'DRI_Workflow_Templates', 1 => '?', 2 => 'update-activity-order', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', ), 'method' => 'updateActivityOrder', 'shortHelp' => 'Update the sort order of the activities', 'longHelp' => '/include/api/help/customer_journeyDRI_Workflow_TemplatesupdateActivityOrder.html', 'noEtag' => true, 'minVersion' => '11.19', 'file' => 'modules/DRI_Workflow_Templates/clients/base/api/DRIWorkflowTemplatesApi.php', 'className' => 'DRIWorkflowTemplatesApi', 'score' => 9.5, ), ), ), 'file' => array ( 'template-import' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'DRI_Workflow_Templates', 1 => 'file', 2 => 'template-import', ), 'pathVars' => array ( 0 => 'module', 1 => '', 2 => '', ), 'method' => 'import', 'rawPostContents' => true, 'acl' => 'create', 'shortHelp' => 'Imports a Smart Guide Template from a .json file', 'longHelp' => '/include/api/help/customer_journeyDRI_Workflow_TemplatestemplateImportPost.html', 'minVersion' => '11.19', 'file' => 'modules/DRI_Workflow_Templates/clients/base/api/DRICustomerJourneyTemplatesImportExportApi.php', 'className' => 'DRICustomerJourneyTemplatesImportExportApi', 'score' => 10.5, ), ), 'check-template-import' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'DRI_Workflow_Templates', 1 => 'file', 2 => 'check-template-import', ), 'pathVars' => array ( 0 => 'module', 1 => '', 2 => '', ), 'method' => 'checkImport', 'rawPostContents' => true, 'acl' => 'create', 'shortHelp' => 'Checks import of a Smart Guide Template from a .json file', 'longHelp' => '/include/api/help/customer_journeyDRI_Workflow_TemplatescheckTemplateImportPost.html', 'minVersion' => '11.19', 'file' => 'modules/DRI_Workflow_Templates/clients/base/api/DRICustomerJourneyTemplatesImportExportApi.php', 'className' => 'DRICustomerJourneyTemplatesImportExportApi', 'score' => 10.5, ), ), ), ), 'Users' => array ( '?' => array ( 'link' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Users', 1 => '?', 2 => 'link', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', ), 'method' => 'createRelatedLinks', 'shortHelp' => 'Relates existing records to this module.', 'longHelp' => 'include/api/help/module_record_link_post_help.html', 'file' => 'modules/Users/clients/base/api/UsersRelateRecordApi.php', 'className' => 'UsersRelateRecordApi', 'score' => 9.5, ), ), ), ), 'Notes' => array ( 'filter' => array ( 'count' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Notes', 1 => 'filter', 2 => 'count', ), 'pathVars' => array ( 0 => 'module', 1 => '', 2 => '', ), 'method' => 'filterListCount', 'shortHelp' => 'Lists filtered records.', 'longHelp' => 'include/api/help/module_filter_post_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionNotAuthorized', 3 => 'SugarApiExceptionInvalidParameter', ), 'file' => 'modules/Notes/clients/base/api/NotesFilterApi.php', 'className' => 'NotesFilterApi', 'score' => 10.5, ), ), ), ), 'RevenueLineItems' => array ( '?' => array ( 'quote' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'RevenueLineItems', 1 => '?', 2 => 'quote', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => 'action', ), 'method' => 'convertToQuote', 'shortHelp' => 'Convert a Revenue Line Item Into A Quote Record', 'longHelp' => 'modules/RevenueLineItems/clients/base/api/help/convert_to_quote.html', 'file' => 'modules/RevenueLineItems/clients/base/api/RevenueLineItemToQuoteConvertApi.php', 'className' => 'RevenueLineItemToQuoteConvertApi', 'score' => 9.5, ), ), ), ), 'DataArchiver' => array ( '?' => array ( 'run' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'DataArchiver', 1 => '?', 2 => 'run', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', ), 'method' => 'performArchive', 'shortHelp' => 'Performs the archiving process for the given archive', 'longHelp' => 'include/api/help/archiver_run.html', 'file' => 'modules/DataArchiver/clients/base/api/DataArchiverApi.php', 'className' => 'DataArchiverApi', 'score' => 9.5, ), ), ), ), 'Teams' => array ( '?' => array ( 'link' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Teams', 1 => '?', 2 => 'link', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', ), 'method' => 'createRelatedLinks', 'shortHelp' => 'Relates existing records to this module.', 'longHelp' => 'include/api/help/module_record_link_post_help.html', 'file' => 'modules/Teams/clients/base/api/TeamsRelateRecordApi.php', 'className' => 'TeamsRelateRecordApi', 'score' => 9.5, ), ), ), ), 'pmse_Emails_Templates' => array ( 'file' => array ( 'emailtemplates_import' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'pmse_Emails_Templates', 1 => 'file', 2 => 'emailtemplates_import', ), 'pathVars' => array ( 0 => 'module', 1 => '', 2 => '', ), 'method' => 'emailTemplatesImport', 'rawPostContents' => true, 'acl' => 'create', 'shortHelp' => 'Imports a Process Email Templates from a .pet file', 'longHelp' => 'modules/pmse_Emails_Templates/clients/base/api/help/email_templates_import_help.html', 'file' => 'modules/pmse_Emails_Templates/clients/base/api/PMSEEmailsTemplates.php', 'className' => 'PMSEEmailsTemplates', 'score' => 10.5, ), ), ), ), 'Forecasts' => array ( 'metrics' => array ( 'named' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Forecasts', 1 => 'metrics', 2 => 'named', ), 'pathVars' => array ( 0 => '', 1 => '', 2 => '', ), 'method' => 'getMetricsByName', 'shortHelp' => 'Retrieve named metrics for Forecast data', 'longHelp' => 'modules/Forecasts/clients/base/api/help/ForecastMetricsByNameApiPost.html', 'minVersion' => '11.20', 'file' => 'modules/Forecasts/clients/base/api/ForecastMetricsApi.php', 'className' => 'ForecastMetricsApi', 'score' => 10.5, ), ), ), ), 'Reports' => array ( 'chart' => array ( '?' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Reports', 1 => 'chart', 2 => '?', ), 'pathVars' => array ( 0 => '', 1 => '', 2 => 'reportId', ), 'method' => 'getSavedReportChartById', 'shortHelp' => 'Updates a ForecastWorksheet model', 'longHelp' => 'modules/Reports/clients/base/api/help/ReportsDashletApiGetSavedReportById.html', 'file' => 'modules/Reports/clients/base/api/ReportsDashletsApi.php', 'className' => 'ReportsDashletsApi', 'score' => 9.5, ), ), ), '?' => array ( 'record_list' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Reports', 1 => '?', 2 => 'record_list', ), 'pathVars' => array ( 0 => '', 1 => 'record', 2 => '', ), 'method' => 'createRecordList', 'shortHelp' => 'An API to create a record list from a saved report', 'longHelp' => 'modules/Reports/api/help/module_recordlist_post.html', 'file' => 'modules/Reports/clients/base/api/ReportsApi.php', 'className' => 'ReportsApi', 'score' => 9.5, ), ), 'retrieveEnumFieldOptions' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Reports', 1 => '?', 2 => 'retrieveEnumFieldOptions', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', ), 'method' => 'retrieveEnumFieldOptions', 'shortHelp' => 'An API that retrieves the options of a complex enum field', 'longHelp' => 'modules/Reports/clients/base/api/help/retrieve_enum_field_options_post_help.html', 'minVersion' => '11.17', 'file' => 'modules/Reports/clients/base/api/ReportsApi.php', 'className' => 'ReportsApi', 'score' => 9.5, ), ), 'updateReportFilters' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Reports', 1 => '?', 2 => 'updateReportFilters', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', ), 'method' => 'updateReportFilters', 'shortHelp' => 'An API that updates the runtime filters on Report\'s Cache', 'longHelp' => 'modules/Reports/clients/base/api/help/update_report_filters_post_help.html', 'minVersion' => '11.17', 'file' => 'modules/Reports/clients/base/api/ReportsApi.php', 'className' => 'ReportsApi', 'score' => 9.5, ), ), 'chart' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Reports', 1 => '?', 2 => 'chart', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', ), 'method' => 'retrieveSavedReportChartById', 'shortHelp' => 'An API to retrieve chart data', 'longHelp' => 'modules/Reports/clients/base/api/help/retrieve_saved_report_chart_by_id_post_help.html', 'minVersion' => '11.17', 'file' => 'modules/Reports/clients/base/api/ReportsApi.php', 'className' => 'ReportsApi', 'score' => 9.5, ), ), ), ), 'pmse_Business_Rules' => array ( 'file' => array ( 'businessrules_import' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'pmse_Business_Rules', 1 => 'file', 2 => 'businessrules_import', ), 'pathVars' => array ( 0 => 'module', 1 => '', 2 => '', ), 'method' => 'businessRulesImport', 'rawPostContents' => true, 'acl' => 'create', 'shortHelp' => 'Imports a Process Business Rules definition from a .pbr file', 'longHelp' => 'modules/pmse_Business_Rules/clients/base/api/help/business_rules_import_help.html', 'file' => 'modules/pmse_Business_Rules/clients/base/api/PMSEBusinessRules.php', 'className' => 'PMSEBusinessRules', 'score' => 10.5, ), ), ), ), 'ExpressionEngine' => array ( '?' => array ( 'related' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'ExpressionEngine', 1 => '?', 2 => 'related', ), 'pathVars' => array ( 0 => '', 1 => 'record', 2 => '', ), 'method' => 'getRelatedValues', 'shortHelp' => 'Retrieves the related fields for a given module record', 'longHelp' => 'modules/ExpressionEngine/clients/base/api/help/related_value_api_post_help.html', 'minVersion' => '11.8', 'file' => 'modules/ExpressionEngine/clients/base/api/RelatedValueApi.php', 'className' => 'RelatedValueApi', 'score' => 9.5, ), ), ), ), ), 'GET' => array ( 'maps' => array ( 'getApiKey' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'maps', 1 => 'getApiKey', 2 => '?', ), 'pathVars' => array ( 0 => '', 1 => '', 2 => 'provider', ), 'method' => 'getApiKey', 'shortHelp' => 'Get Map Api Key', 'longHelp' => 'include/api/help/maps_getapikey_get_help.html', 'minVersion' => '11.16', 'file' => 'clients/base/api/MapsApi.php', 'className' => 'MapsApi', 'score' => 9.5, ), ), ), ), 'collection' => array ( '?' => array ( 'count' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'collection', 1 => '?', 2 => 'count', ), 'pathVars' => array ( 0 => '', 1 => 'collection_name', 2 => '', ), 'method' => 'getCollectionCount', 'shortHelp' => 'Counts collection records.', 'longHelp' => 'include/api/help/collection_collection_name_count_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionNotAuthorized', ), 'file' => 'clients/base/api/ModuleCollectionApi.php', 'className' => 'ModuleCollectionApi', 'score' => 9.5, ), ), ), ), '<module>' => array ( 'filter' => array ( 'count' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', 1 => 'filter', 2 => 'count', ), 'pathVars' => array ( 0 => 'module', 1 => '', 2 => '', ), 'method' => 'getFilterListCount', 'shortHelp' => 'Lists filtered records.', 'longHelp' => 'include/api/help/module_filter_post_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionNotAuthorized', 3 => 'SugarApiExceptionInvalidParameter', ), 'file' => 'clients/base/api/FilterApi.php', 'className' => 'FilterApi', 'score' => 9.75, ), 1 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', 1 => 'filter', 2 => 'count', ), 'pathVars' => array ( 0 => 'module', 1 => '', 2 => '', ), 'method' => 'getFilterListCount', 'shortHelp' => 'Lists filtered records.', 'longHelp' => 'include/api/help/module_filter_post_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionNotAuthorized', 3 => 'SugarApiExceptionInvalidParameter', ), 'file' => 'modules/Opportunities/clients/base/api/OpportunitiesFilterApi.php', 'className' => 'OpportunitiesFilterApi', 'score' => 9.75, ), 2 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', 1 => 'filter', 2 => 'count', ), 'pathVars' => array ( 0 => 'module', 1 => '', 2 => '', ), 'method' => 'getFilterListCount', 'shortHelp' => 'Lists filtered records.', 'longHelp' => 'include/api/help/module_filter_post_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionNotAuthorized', 3 => 'SugarApiExceptionInvalidParameter', ), 'file' => 'modules/pmse_Project/clients/base/api/PMSEFilterOutboundEmailsApi.php', 'className' => 'PMSEFilterOutboundEmailsApi', 'score' => 9.75, ), 3 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', 1 => 'filter', 2 => 'count', ), 'pathVars' => array ( 0 => 'module', 1 => '', 2 => '', ), 'method' => 'getFilterListCount', 'shortHelp' => 'Lists filtered records.', 'longHelp' => 'include/api/help/module_filter_post_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionNotAuthorized', 3 => 'SugarApiExceptionInvalidParameter', ), 'file' => 'modules/DataArchiver/clients/base/api/DataArchiverFilterApi.php', 'className' => 'DataArchiverFilterApi', 'score' => 9.75, ), ), ), 'export' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', 1 => 'export', 2 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => '', 2 => 'record_list_id', ), 'method' => 'export', 'rawReply' => true, 'allowDownloadCookie' => true, 'shortHelp' => 'Returns a record set in CSV format along with HTTP headers to indicate content type.', 'longHelp' => 'include/api/help/module_export_get_help.html', 'file' => 'clients/base/api/ExportApi.php', 'className' => 'ExportApi', 'score' => 8.75, ), ), ), 'sync_key' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', 1 => 'sync_key', 2 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => '', 2 => 'sync_key_field_value', ), 'method' => 'getByField', 'shortHelp' => 'Retrieve record with given sync_key.', 'file' => 'clients/base/api/IntegrateApi.php', 'className' => 'IntegrateApi', 'score' => 8.75, ), ), ), '?' => array ( 'file' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', 1 => '?', 2 => 'file', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', ), 'method' => 'getFileList', 'shortHelp' => 'Gets a listing of files related to a field for a module record.', 'longHelp' => 'include/api/help/module_record_file_get_help.html', 'file' => 'clients/base/api/FileApi.php', 'className' => 'FileApi', 'score' => 8.75, ), ), 'vcard' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', 1 => '?', 2 => 'vcard', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', ), 'method' => 'vCardDownload', 'rawReply' => true, 'allowDownloadCookie' => true, 'shortHelp' => 'An API to download a contact as a vCard.', 'longHelp' => 'include/api/help/module_vcarddownload_get_help.html', 'file' => 'clients/base/api/vCardApi.php', 'className' => 'vCardApi', 'score' => 8.75, ), ), 'pii' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', 1 => '?', 2 => 'pii', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => 'pii', ), 'minVersion' => '11.1', 'method' => 'getPiiFields', 'shortHelp' => 'Returns pii fields', 'longHelp' => 'include/api/help/module_record_pii_help.html', 'file' => 'clients/base/api/ModuleApi.php', 'className' => 'ModuleApi', 'score' => 8.75, ), ), 'tree' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', 1 => '?', 2 => 'tree', ), 'pathVars' => array ( 0 => 'module', 1 => 'root', 2 => '', ), 'method' => 'tree', 'noEtag' => true, 'shortHelp' => 'This method returns formatted tree for selected root', 'longHelp' => 'modules/Categories/clients/base/api/help/tree_get_tree_help.html', 'file' => 'modules/Categories/clients/base/api/TreeApi.php', 'className' => 'TreeApi', 'score' => 8.75, ), ), 'children' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', 1 => '?', 2 => 'children', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', ), 'method' => 'children', 'shortHelp' => 'This method returns children categories for selected record', 'longHelp' => 'modules/Categories/clients/base/api/help/tree_get_children_help.html', 'file' => 'modules/Categories/clients/base/api/TreeApi.php', 'className' => 'TreeApi', 'score' => 8.75, ), ), 'next' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', 1 => '?', 2 => 'next', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', ), 'method' => 'next', 'shortHelp' => 'This method returns next sibling of selected record', 'longHelp' => 'modules/Categories/clients/base/api/help/tree_get_next_help.html', 'file' => 'modules/Categories/clients/base/api/TreeApi.php', 'className' => 'TreeApi', 'score' => 8.75, ), ), 'prev' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', 1 => '?', 2 => 'prev', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', ), 'method' => 'prev', 'shortHelp' => 'This method returns previous sibling of selected record', 'longHelp' => 'modules/Categories/clients/base/api/help/tree_get_prev_help.html', 'file' => 'modules/Categories/clients/base/api/TreeApi.php', 'className' => 'TreeApi', 'score' => 8.75, ), ), 'parent' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', 1 => '?', 2 => 'parent', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', ), 'method' => 'getParent', 'shortHelp' => 'This method returns parent node of selected record', 'longHelp' => 'modules/Categories/clients/base/api/help/tree_get_parent_help.html', 'file' => 'modules/Categories/clients/base/api/TreeApi.php', 'className' => 'TreeApi', 'score' => 8.75, ), ), 'path' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', 1 => '?', 2 => 'path', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', ), 'method' => 'path', 'shortHelp' => 'This method returns full path of selected record', 'longHelp' => 'modules/Categories/clients/base/api/help/tree_get_path_help.html', 'file' => 'modules/Categories/clients/base/api/TreeApi.php', 'className' => 'TreeApi', 'score' => 8.75, ), ), 'audit' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', 1 => '?', 2 => 'audit', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => 'audit', ), 'method' => 'viewChangeLog', 'shortHelp' => 'View audit log in record view', 'minVersion' => '11.11', 'longHelp' => 'include/api/help/audit_get_help.html', 'file' => 'modules/Audit/clients/base/api/AuditApi.php', 'className' => 'AuditApi', 'score' => 8.75, ), ), ), 'record_list' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', 1 => 'record_list', 2 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => '', 2 => 'record_list_id', ), 'method' => 'recordListGet', 'shortHelp' => 'An API to fetch a previously created record list', 'longHelp' => 'include/api/help/module_recordlist_get.html', 'file' => 'clients/base/api/RecordListApi.php', 'className' => 'RecordListApi', 'score' => 8.75, ), ), ), 'chart' => array ( 'pipeline' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', 1 => 'chart', 2 => 'pipeline', ), 'pathVars' => array ( 0 => 'module', 1 => '', 2 => '', ), 'method' => 'pipeline', 'shortHelp' => 'Get the current opportunity pipeline data for the current timeperiod', 'longHelp' => 'modules/Opportunities/clients/base/api/help/OpportunitiesPipelineChartApi.html', 'file' => 'clients/base/api/PipelineChartApi.php', 'className' => 'PipelineChartApi', 'score' => 9.75, ), ), ), 'enum' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', 1 => 'enum', 2 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'enum', 2 => 'field', ), 'method' => 'getEnumValues', 'shortHelp' => 'This method returns enum values for a specified field', 'longHelp' => 'include/api/help/module_enum_get_help.html', 'file' => 'clients/base/api/ModuleApi.php', 'className' => 'ModuleApi', 'score' => 8.75, ), ), ), 'tree' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', 1 => 'tree', 2 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => '', 2 => 'link_name', ), 'method' => 'filterTree', 'exception' => array ( 0 => 'SugarApiExceptionInvalidParameter', 1 => 'SugarApiExceptionNotAuthorized', 2 => 'SugarApiExceptionNotFound', ), 'file' => 'modules/Categories/clients/base/api/TreeApi.php', 'className' => 'TreeApi', 'score' => 8.75, ), ), ), 'Activities' => array ( 'filter' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', 1 => 'Activities', 2 => 'filter', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'getModuleActivities', 'shortHelp' => 'This method retrieves a filtered list of a module\'s activities', 'longHelp' => 'modules/ActivityStream/clients/base/api/help/moduleActivities.html', 'file' => 'modules/ActivityStream/clients/base/api/ActivitiesApi.php', 'className' => 'ActivitiesApi', 'score' => 9.75, ), ), ), 'audit' => array ( 'export' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', 1 => 'audit', 2 => 'export', ), 'pathVars' => array ( 0 => 'module', 1 => '', 2 => '', ), 'method' => 'exportAudit', 'shortHelp' => 'Export Audit records for module', 'minVersion' => '11.11', 'longHelp' => 'include/api/help/audit_export_help.html', 'file' => 'modules/Audit/clients/base/api/AuditApi.php', 'className' => 'AuditApi', 'score' => 9.75, ), ), ), ), 'lang' => array ( 'public' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'lang', 1 => 'public', 2 => '?', ), 'pathVars' => array ( 0 => '', 1 => '', 2 => 'lang', ), 'method' => 'getPublicLanguage', 'shortHelp' => 'Returns the public labels for the application', 'longHelp' => 'include/api/html/metadata_all_help.html', 'noLoginRequired' => true, 'rawReply' => true, 'noEtag' => true, 'ignoreMetaHash' => true, 'ignoreSystemStatusError' => true, 'file' => 'clients/base/api/MetadataApi.php', 'className' => 'MetadataApi', 'score' => 9.5, ), ), ), ), 'metadata' => array ( '?' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'metadata', 1 => '?', 2 => '?', ), 'pathVars' => array ( 0 => '', 1 => 'module', 2 => 'segment', ), 'method' => 'getModuleDataSegment', 'minVersion' => '11.11', 'shortHelp' => 'Gets the desired segment for the given module', 'longHelp' => 'include/api/help/metadata_getModuleDataSegment.html', 'file' => 'clients/base/api/MetadataApi.php', 'className' => 'MetadataApi', 'score' => 8.5, ), ), ), ), 'connector' => array ( 'twitter' => array ( 'currentUser' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'connector', 1 => 'twitter', 2 => 'currentUser', ), 'pathVars' => array ( 0 => 'connector', 1 => 'module', 2 => 'twitterId', ), 'method' => 'getCurrentUser', 'shortHelp' => 'Gets current tweets for a user', 'longHelp' => 'include/api/help/twitter_get_help.html', 'file' => 'clients/base/api/TwitterApi.php', 'className' => 'TwitterApi', 'score' => 10.5, ), ), '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'connector', 1 => 'twitter', 2 => '?', ), 'pathVars' => array ( 0 => 'connector', 1 => 'module', 2 => 'twitterId', ), 'method' => 'getTweets', 'shortHelp' => 'Gets current tweets for a user', 'longHelp' => 'include/api/help/twitter_get_help.html', 'file' => 'clients/base/api/TwitterApi.php', 'className' => 'TwitterApi', 'score' => 9.5, ), ), ), ), 'userUtilities' => array ( 'getLocaleData' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'userUtilities', 1 => 'getLocaleData', 2 => '?', ), 'pathVars' => array ( 0 => 'userUtilities', 1 => 'getLocaleData', 2 => 'userId', ), 'method' => 'getLocaleData', 'shortHelp' => 'Retrieves user locale settings', 'longHelp' => 'include/api/help/user_utilities_getlocaledata_get_help.html', 'minVersion' => '11.15', 'file' => 'clients/base/api/UserUtilitiesApi.php', 'className' => 'UserUtilitiesApi', 'score' => 9.5, ), ), ), ), 'me' => array ( 'preference' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'me', 1 => 'preference', 2 => '?', ), 'pathVars' => array ( 0 => '', 1 => '', 2 => 'preference_name', ), 'method' => 'userPreference', 'shortHelp' => 'Returns a specific preference for the current user', 'longHelp' => 'include/api/help/me_preference_preference_name_get_help.html', 'ignoreSystemStatusError' => true, 'file' => 'clients/base/api/CurrentUserApi.php', 'className' => 'CurrentUserApi', 'score' => 9.5, ), ), ), 'last_states' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'me', 1 => 'last_states', 2 => '?', ), 'pathVars' => array ( 0 => '', 1 => '', 2 => 'platform', ), 'method' => 'retrieveLastStatesByPlatform', 'minVersion' => '11.20', 'ignoreMetaHash' => true, 'shortHelp' => 'Retrieve the set of last state data for the current user for a specific platform', 'longHelp' => 'include/api/help/me_last_states_by_platform_get_help.html', 'ignoreSystemStatusError' => true, 'file' => 'clients/base/api/CurrentUserApi.php', 'className' => 'CurrentUserApi', 'score' => 9.5, ), ), ), ), 'hint' => array ( 'enrich' => array ( 'config' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'hint', 1 => 'enrich', 2 => 'config', ), 'pathVars' => array ( 0 => '', ), 'method' => 'readEnrichFieldConfig', 'shortHelp' => 'Reads Hint configuration', 'longHelp' => 'include/api/help/hint_enrich_config_get_help.html', 'minVersion' => '11.16', 'file' => 'clients/base/api/HintApi.php', 'className' => 'HintApi', 'score' => 10.5, ), ), ), 'license' => array ( 'check' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'hint', 1 => 'license', 2 => 'check', ), 'pathVars' => array ( 0 => '', ), 'method' => 'getHintLicenseType', 'shortHelp' => 'Checks if the user has Hint license enabled', 'longHelp' => 'include/api/help/hint_license_check_get_help.html', 'minVersion' => '11.16', 'file' => 'clients/base/api/HintApi.php', 'className' => 'HintApi', 'score' => 10.5, ), ), ), ), 'get' => array ( 'hint' => array ( 'configNotificationObject' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'get', 1 => 'hint', 2 => 'configNotificationObject', ), 'pathVars' => array ( 0 => '', ), 'method' => 'getConfigNotificationsHint', 'shortHelp' => 'Retrieves the current notifications enabled/disabled value to display in the Hint Configuration panel', 'longHelp' => 'include/api/help/hint_get_hint_configNotificationObject_get_help.html', 'minVersion' => '11.16', 'file' => 'clients/base/api/HintApi.php', 'className' => 'HintApi', 'score' => 10.5, ), ), ), ), 'CloudDrive' => array ( 'file' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'CloudDrive', 1 => 'file', 2 => '?', ), 'pathVars' => array ( 0 => 'CloudDrive', 1 => 'file', 2 => 'fileId', ), 'method' => 'getFile', 'shortHelp' => 'Retrieves a file data', 'longHelp' => 'include/api/help/cloud_drive_file.html', 'minVersion' => '11.16', 'file' => 'clients/base/api/CloudDriveApi.php', 'className' => 'CloudDriveApi', 'score' => 9.5, ), ), ), ), 'Opportunities' => array ( 'enum' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Opportunities', 1 => 'enum', 2 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'enum', 2 => 'field', ), 'method' => 'getEnumValues', 'shortHelp' => 'This method returns enum values for a specified field', 'longHelp' => 'include/api/help/module_enum_get_help.html', 'file' => 'modules/Opportunities/clients/base/api/OpportunitiesEnumApi.php', 'className' => 'OpportunitiesEnumApi', 'score' => 9.5, ), ), ), ), 'Filters' => array ( '?' => array ( 'used' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Filters', 1 => '?', 2 => 'used', ), 'pathVars' => array ( 0 => 'module', 1 => 'module_name', 2 => 'used', ), 'method' => 'getUsed', 'shortHelp' => 'This method gets the used filter for the current user', 'longHelp' => '', 'file' => 'modules/Filters/clients/base/api/PreviouslyUsedFiltersApi.php', 'className' => 'PreviouslyUsedFiltersApi', 'score' => 9.5, ), ), ), ), 'Administration' => array ( 'package' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Administration', 1 => 'package', 2 => '?', ), 'pathVars' => array ( 0 => '', 1 => '', 2 => 'id', ), 'method' => 'getPackage', 'shortHelp' => 'Get the content of a package', 'longHelp' => 'include/api/help/administration_package_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionInvalidParameter', 1 => 'SugarApiExceptionNotAuthorized', ), 'file' => 'modules/Administration/clients/base/api/PackageBuilderApi.php', 'className' => 'PackageBuilderApi', 'score' => 9.5, ), ), ), 'config' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Administration', 1 => 'config', 2 => '?', ), 'pathVars' => array ( 0 => '', 1 => '', 2 => 'category', ), 'method' => 'getConfig', 'shortHelp' => 'Gets configuration for a category', 'longHelp' => 'include/api/help/administration_config_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotAuthorized', ), 'ignoreSystemStatusError' => true, 'minVersion' => '11.13', 'file' => 'modules/Administration/clients/base/api/ConfigApi.php', 'className' => 'ConfigApi', 'score' => 9.5, ), ), 'maps-logger' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Administration', 1 => 'config', 2 => 'maps-logger', ), 'pathVars' => array ( 0 => '', 1 => '', 2 => '', ), 'method' => 'getConfig', 'shortHelp' => 'Gets configuration for a category', 'longHelp' => 'include/api/help/administration_config_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotAuthorized', ), 'ignoreSystemStatusError' => true, 'minVersion' => '11.17', 'file' => 'modules/Administration/clients/base/api/MapsLoggerConfigApi.php', 'className' => 'MapsLoggerConfigApi', 'score' => 10.5, ), ), ), 'packages' => array ( 'staged' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Administration', 1 => 'packages', 2 => 'staged', ), 'pathVars' => array ( 0 => '', ), 'method' => 'getStagedPackages', 'keepSession' => true, 'shortHelp' => 'List uploaded but not installed packages ready to be installed', 'longHelp' => 'include/api/help/administration_packages_list_staged_packages_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotAuthorized', ), 'file' => 'modules/Administration/clients/base/api/PackageApiRest.php', 'className' => 'PackageApiRest', 'score' => 10.5, ), ), 'installed' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Administration', 1 => 'packages', 2 => 'installed', ), 'pathVars' => array ( 0 => '', ), 'method' => 'getInstalledPackages', 'keepSession' => true, 'shortHelp' => 'List of installed packages', 'longHelp' => 'include/api/help/administration_packages_list_installed_packages_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotAuthorized', ), 'file' => 'modules/Administration/clients/base/api/PackageApiRest.php', 'className' => 'PackageApiRest', 'score' => 10.5, ), ), ), 'search' => array ( 'status' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Administration', 1 => 'search', 2 => 'status', ), 'pathVars' => array ( 0 => '', ), 'method' => 'searchStatus', 'shortHelp' => 'Search status', 'longHelp' => 'include/api/help/administration_search_status_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotAuthorized', ), 'file' => 'modules/Administration/clients/base/api/AdministrationApi.php', 'className' => 'AdministrationApi', 'score' => 10.5, ), ), 'fields' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Administration', 1 => 'search', 2 => 'fields', ), 'pathVars' => array ( 0 => '', ), 'method' => 'searchFields', 'shortHelp' => 'List search field configuration', 'longHelp' => 'include/api/help/administration_search_fields_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotAuthorized', ), 'file' => 'modules/Administration/clients/base/api/AdministrationApi.php', 'className' => 'AdministrationApi', 'score' => 10.5, ), ), ), 'elasticsearch' => array ( 'queue' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Administration', 1 => 'elasticsearch', 2 => 'queue', ), 'pathVars' => array ( 0 => '', ), 'method' => 'elasticSearchQueue', 'shortHelp' => 'Elasticsearch queue statistics', 'longHelp' => 'include/api/help/administration_elasticsearch_queue_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotAuthorized', 1 => 'SugarApiExceptionSearchUnavailable', ), 'file' => 'modules/Administration/clients/base/api/AdministrationApi.php', 'className' => 'AdministrationApi', 'score' => 10.5, ), ), 'routing' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Administration', 1 => 'elasticsearch', 2 => 'routing', ), 'pathVars' => array ( 0 => '', ), 'method' => 'elasticSearchRouting', 'shortHelp' => 'Elasticsearch index routing', 'longHelp' => 'include/api/help/administration_elasticsearch_routing_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotAuthorized', 1 => 'SugarApiExceptionSearchUnavailable', ), 'file' => 'modules/Administration/clients/base/api/AdministrationApi.php', 'className' => 'AdministrationApi', 'score' => 10.5, ), ), 'indices' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Administration', 1 => 'elasticsearch', 2 => 'indices', ), 'pathVars' => array ( 0 => '', ), 'method' => 'elasticSearchIndices', 'shortHelp' => 'Elasticsearch index statistics', 'longHelp' => 'include/api/help/administration_elasticsearch_indices_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotAuthorized', 1 => 'SugarApiExceptionSearchUnavailable', ), 'file' => 'modules/Administration/clients/base/api/AdministrationApi.php', 'className' => 'AdministrationApi', 'score' => 10.5, ), ), 'mapping' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Administration', 1 => 'elasticsearch', 2 => 'mapping', ), 'pathVars' => array ( 0 => '', ), 'method' => 'elasticSearchMapping', 'shortHelp' => 'Elasticsearch index mappings', 'longHelp' => 'include/api/help/administration_elasticsearch_mapping_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotAuthorized', 1 => 'SugarApiExceptionSearchUnavailable', ), 'file' => 'modules/Administration/clients/base/api/AdministrationApi.php', 'className' => 'AdministrationApi', 'score' => 10.5, ), ), ), 'license' => array ( 'limits' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Administration', 1 => 'license', 2 => 'limits', ), 'pathVars' => array ( 0 => '', ), 'method' => 'getLicenseLimits', 'shortHelp' => 'get license seats', 'longHelp' => 'include/api/help/administration_disable_license_limits_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotAuthorized', ), 'ignoreSystemStatusError' => true, 'file' => 'modules/Administration/clients/base/api/AdministrationApi.php', 'className' => 'AdministrationApi', 'score' => 10.5, ), ), ), 'settings' => array ( 'validateIPAddress' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Administration', 1 => 'settings', 2 => 'validateIPAddress', ), 'pathVars' => array ( 0 => '', ), 'method' => 'getValidateIPAddress', 'shortHelp' => 'Gets value of Validate IP Address setting', 'longHelp' => 'include/api/help/administration_get_validate_ip_address.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotAuthorized', ), 'minVersion' => '11.12', 'file' => 'modules/Administration/clients/base/api/AdministrationApi.php', 'className' => 'AdministrationApi', 'score' => 10.5, ), ), 'auth' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Administration', 1 => 'settings', 2 => 'auth', ), 'pathVars' => array ( 0 => '', ), 'method' => 'authSettings', 'shortHelp' => 'Fetch auth settings', 'longHelp' => 'include/api/help/administration_idm_auth_settings.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotAuthorized', ), 'minVersion' => '11.2', 'ignoreSystemStatusError' => true, 'file' => 'modules/Administration/clients/base/api/AuthSettingsApi.php', 'className' => 'AuthSettingsApi', 'score' => 10.5, ), ), ), 'module-names-and-icons' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Administration', 1 => 'module-names-and-icons', 2 => '?', ), 'pathVars' => array ( 0 => '', 1 => '', 2 => 'language', ), 'method' => 'getModules', 'shortHelp' => 'Gets modules that whose names and icons can be changed', 'longHelp' => 'modules/Administration/clients/base/api/help/ModuleNamesAndIconsApiGet.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotAuthorized', ), 'ignoreSystemStatusError' => true, 'minVersion' => '11.19', 'file' => 'modules/Administration/clients/base/api/ModuleNamesAndIconsApi.php', 'className' => 'ModuleNamesAndIconsApi', 'score' => 9.5, ), ), ), 'maps' => array ( 'logs' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Administration', 1 => 'maps', 2 => 'logs', ), 'pathVars' => array ( 0 => '', 1 => '', 2 => '', ), 'method' => 'getMapsLog', 'shortHelp' => 'Get the maps logs', 'longHelp' => 'include/api/help/administration_maps_logs_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotAuthorized', ), 'ignoreSystemStatusError' => true, 'minVersion' => '11.17', 'file' => 'modules/Administration/clients/base/api/MapsLoggerConfigApi.php', 'className' => 'MapsLoggerConfigApi', 'score' => 10.5, ), ), ), 'denormalization' => array ( 'configuration' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Administration', 1 => 'denormalization', 2 => 'configuration', ), 'pathVars' => array ( 0 => '', ), 'method' => 'getConfiguration', 'shortHelp' => 'Get modules and fields configuration', 'exceptions' => array ( 0 => 'SugarApiExceptionNotAuthorized', ), 'file' => 'modules/Administration/clients/base/api/DenormalizationApi.php', 'className' => 'DenormalizationApi', 'score' => 10.5, ), ), 'fields' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Administration', 1 => 'denormalization', 2 => 'fields', ), 'pathVars' => array ( 0 => '', ), 'method' => 'getDenormFieldList', 'shortHelp' => 'Get denormalized field list', 'exceptions' => array ( 0 => 'SugarApiExceptionNotAuthorized', ), 'file' => 'modules/Administration/clients/base/api/DenormalizationApi.php', 'className' => 'DenormalizationApi', 'score' => 10.5, ), ), 'status' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Administration', 1 => 'denormalization', 2 => 'status', ), 'pathVars' => array ( 0 => '', ), 'method' => 'getStatus', 'shortHelp' => 'Get the current process status', 'exceptions' => array ( 0 => 'SugarApiExceptionNotAuthorized', ), 'file' => 'modules/Administration/clients/base/api/DenormalizationApi.php', 'className' => 'DenormalizationApi', 'score' => 10.5, ), ), ), 'idm' => array ( 'users' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Administration', 1 => 'idm', 2 => 'users', ), 'pathVars' => array ( 0 => '', ), 'method' => 'getIdmUsers', 'shortHelp' => 'Fetch users for IDM migration', 'longHelp' => 'include/api/help/administration_idm_user_filter_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionError', 1 => 'SugarApiExceptionInvalidParameter', 2 => 'SugarApiExceptionNotAuthorized', ), 'minVersion' => '11.2', 'ignoreSystemStatusError' => true, 'file' => 'modules/Administration/clients/base/api/IdmUserFilterApi.php', 'className' => 'IdmUserFilterApi', 'score' => 10.5, ), ), ), ), 'DRI_Workflows' => array ( '?' => array ( 'widget-data' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'DRI_Workflows', 1 => '?', 2 => 'widget-data', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', ), 'method' => 'widgetData', 'shortHelp' => 'Provide journey, related forms and stages data for widget', 'longHelp' => '/include/api/help/customer_journeyDRI_WorkflowswidgetData.html', 'noEtag' => true, 'minVersion' => '11.19', 'file' => 'modules/DRI_Workflows/clients/base/api/DRI_WorkflowsApi.php', 'className' => 'DRI_WorkflowsApi', 'score' => 9.5, ), ), ), ), '?' => array ( '?' => array ( 'activeSmartGuidesCount' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '?', 1 => '?', 2 => 'activeSmartGuidesCount', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', ), 'method' => 'getActiveSmartGuidesCount', 'shortHelp' => 'Provide the count of active smart guides related to a particular record', 'longHelp' => '/include/api/help/customer_journeyDRI_WorkflowsgetActiveSmartGuidesCount.html', 'minVersion' => '11.22', 'file' => 'modules/DRI_Workflows/clients/base/api/DRI_WorkflowsApi.php', 'className' => 'DRI_WorkflowsApi', 'score' => 8.5, ), ), 'get-smartguides-count' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '?', 1 => '?', 2 => 'get-smartguides-count', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', ), 'method' => 'getSmartGuidesCount', 'shortHelp' => 'give the count of smart guides', 'longHelp' => '/include/api/help/customer_journeyDRI_WorkflowsgetSmartGuidesCount.html', 'minVersion' => '11.22', 'file' => 'modules/DRI_Workflows/clients/base/api/DRI_WorkflowsApi.php', 'className' => 'DRI_WorkflowsApi', 'score' => 8.5, ), ), 'target' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '?', 1 => '?', 2 => 'target', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', ), 'method' => 'target', 'shortHelp' => 'Resolves the target and return the response for the activity', 'longHelp' => '/include/api/help/customer_journeyCJ_Formstarget.html', 'minVersion' => '11.19', 'file' => 'modules/CJ_Forms/clients/base/api/CJ_FormsApi.php', 'className' => 'CJ_FormsApi', 'score' => 8.5, ), ), 'stage-target' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '?', 1 => '?', 2 => 'stage-target', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', ), 'method' => 'stageTarget', 'shortHelp' => 'Resolves the target and return the response for the stage', 'longHelp' => '/include/api/help/customer_journeyCJ_FormsstageTarget.html', 'minVersion' => '11.19', 'file' => 'modules/CJ_Forms/clients/base/api/CJ_FormsApi.php', 'className' => 'CJ_FormsApi', 'score' => 8.5, ), ), 'journey-target' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '?', 1 => '?', 2 => 'journey-target', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', ), 'method' => 'journeyTarget', 'shortHelp' => 'Resolves the target and return the response for the Smart Guide', 'longHelp' => '/include/api/help/customer_journeyCJ_FormsjourneyTarget.html', 'minVersion' => '11.19', 'file' => 'modules/CJ_Forms/clients/base/api/CJ_FormsApi.php', 'className' => 'CJ_FormsApi', 'score' => 8.5, ), ), 'activitiesRSA' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '?', 1 => '?', 2 => 'activitiesRSA', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', ), 'method' => 'activitiesRSA', 'shortHelp' => 'Returns the activities for which RSA will be performed', 'longHelp' => '/include/api/help/customer_journeyCJ_FormsactivitiesRSA.html', 'minVersion' => '11.22', 'file' => 'modules/CJ_Forms/clients/base/api/CJ_FormsApi.php', 'className' => 'CJ_FormsApi', 'score' => 8.5, ), ), ), ), 'KBContents' => array ( '?' => array ( 'related_documents' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'KBContents', 1 => '?', 2 => 'related_documents', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', ), 'method' => 'relatedDocuments', 'shortHelp' => 'Get related documents for current record.', 'longHelp' => '', 'file' => 'modules/KBContents/clients/base/api/KBContentsApi.php', 'className' => 'KBContentsApi', 'score' => 9.5, ), ), ), ), 'ForecastManagerWorksheets' => array ( '?' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'ForecastManagerWorksheets', 1 => '?', 2 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'timeperiod_id', 2 => 'user_id', ), 'method' => 'ForecastManagerWorksheetsGet', 'jsonParams' => array ( ), 'shortHelp' => 'Filter records from a single module', 'longHelp' => 'modules/Forecasts/clients/base/api/help/ForecastManagerWorksheetGet.html', 'exceptions' => array ( 0 => 'SugarApiExceptionError', 1 => 'SugarApiExceptionInvalidParameter', 2 => 'SugarApiExceptionNotFound', ), 'file' => 'modules/ForecastManagerWorksheets/clients/base/api/ForecastManagerWorksheetsFilterApi.php', 'className' => 'ForecastManagerWorksheetsFilterApi', 'score' => 8.5, ), ), ), 'chart' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'ForecastManagerWorksheets', 1 => 'chart', 2 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => '', 2 => 'timeperiod_id', ), 'method' => 'forecastManagerWorksheetsChartGet', 'jsonParams' => array ( ), 'shortHelp' => 'Filter records and reformat data for chart presentation', 'longHelp' => 'modules/Forecasts/clients/base/api/help/forecastManagerWorksheetsChartGet.html', 'exceptions' => array ( 0 => 'SugarApiExceptionError', 1 => 'SugarApiExceptionInvalidParameter', 2 => 'SugarApiExceptionNotFound', ), 'file' => 'modules/ForecastManagerWorksheets/clients/base/api/ForecastManagerWorksheetsFilterApi.php', 'className' => 'ForecastManagerWorksheetsFilterApi', 'score' => 9.5, ), ), ), ), 'Mail' => array ( 'recipients' => array ( 'find' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Mail', 1 => 'recipients', 2 => 'find', ), 'pathVars' => array ( 0 => '', ), 'method' => 'findRecipients', 'shortHelp' => 'Search For Email Recipients', 'longHelp' => 'modules/Emails/clients/base/api/help/mail_recipients_find_get_help.html', 'file' => 'modules/Emails/clients/base/api/MailApi.php', 'className' => 'MailApi', 'score' => 10.5, ), ), ), ), 'Emails' => array ( 'filter' => array ( 'count' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Emails', 1 => 'filter', 2 => 'count', ), 'pathVars' => array ( 0 => 'module', 1 => '', 2 => '', ), 'method' => 'getFilterListCount', 'shortHelp' => 'Lists filtered records.', 'longHelp' => 'include/api/help/module_filter_post_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionNotAuthorized', 3 => 'SugarApiExceptionInvalidParameter', ), 'file' => 'modules/Emails/clients/base/api/EmailsFilterApi.php', 'className' => 'EmailsFilterApi', 'score' => 10.5, ), ), ), ), 'Dashboards' => array ( 'filter' => array ( 'count' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Dashboards', 1 => 'filter', 2 => 'count', ), 'pathVars' => array ( 0 => 'module', 1 => '', 2 => '', ), 'method' => 'getFilterListCount', 'shortHelp' => 'Lists filtered records.', 'longHelp' => 'include/api/help/module_filter_post_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionNotAuthorized', 3 => 'SugarApiExceptionInvalidParameter', ), 'file' => 'modules/Dashboards/clients/base/api/DashboardsFilterApi.php', 'className' => 'DashboardsFilterApi', 'score' => 10.5, ), ), ), ), 'CJ_WebHooks' => array ( '?' => array ( 'send-request' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'CJ_WebHooks', 1 => '?', 2 => 'send-request', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', ), 'method' => 'sendRequest', 'shortHelp' => 'Make curl request according to webhook bean attributes using custom Request class', 'longHelp' => '/include/api/help/customer_journeyCJ_WebHookssendRequest.html', 'noEtag' => true, 'minVersion' => '11.19', 'file' => 'modules/CJ_WebHooks/clients/base/api/CJ_WebHooksApi.php', 'className' => 'CJ_WebHooksApi', 'score' => 9.5, ), ), ), ), 'Meetings' => array ( '?' => array ( 'external' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Meetings', 1 => '?', 2 => 'external', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => 'external', ), 'method' => 'getExternalInfo', 'shortHelp' => 'This method retrieves info about launching an external meeting', 'longHelp' => 'modules/Meetings/clients/base/api/help/MeetingsApiExternalGet.html', 'file' => 'modules/Meetings/clients/base/api/MeetingsApi.php', 'className' => 'MeetingsApi', 'score' => 9.5, ), ), ), ), 'pmse_Project' => array ( '?' => array ( 'dproject' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'pmse_Project', 1 => '?', 2 => 'dproject', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', ), 'method' => 'projectDownload', 'rawReply' => true, 'allowDownloadCookie' => true, 'acl' => 'view', 'shortHelp' => 'Exports a .bpm file with a Process Definition', 'longHelp' => 'modules/pmse_Project/clients/base/api/help/project_export_help.html', 'file' => 'modules/pmse_Project/clients/base/api/PMSEProjectImportExportApi.php', 'className' => 'PMSEProjectImportExportApi', 'score' => 9.5, ), ), 'verify' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'pmse_Project', 1 => '?', 2 => 'verify', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => 'verify', ), 'method' => 'verifyRunningProcess', 'acl' => 'view', 'shortHelp' => 'Verifies whether the Process Definition has any pending processes', 'longHelp' => 'modules/pmse_Project/clients/base/api/help/project_record_verify_help.html', 'file' => 'modules/pmse_Project/clients/base/api/PMSEProjectApi.php', 'className' => 'PMSEProjectApi', 'score' => 9.5, ), ), ), 'project' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'pmse_Project', 1 => 'project', 2 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'customAction', 2 => 'record', ), 'method' => 'retrieveCustomProject', 'acl' => 'view', 'shortHelp' => 'Retrieves the schema data to be used by the Process Definition designer', 'longHelp' => 'modules/pmse_Project/clients/base/api/help/project_project_get_help.html', 'file' => 'modules/pmse_Project/clients/base/api/PMSEProjectApi.php', 'className' => 'PMSEProjectApi', 'score' => 9.5, ), ), ), 'CrmData' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'pmse_Project', 1 => 'CrmData', 2 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => '', 2 => 'data', ), 'method' => 'getCrmData', 'acl' => 'view', 'file' => 'modules/pmse_Project/clients/base/api/PMSEProjectApi.php', 'className' => 'PMSEProjectApi', 'score' => 9.5, ), ), ), 'validateCrmData' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'pmse_Project', 1 => 'validateCrmData', 2 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => '', 2 => 'data', ), 'method' => 'validateCrmData', 'acl' => 'view', 'shortHelp' => 'Validates whether BPM data exists in the system (Fields, Modules, Users, Roles, etc.)', 'longHelp' => 'modules/pmse_Project/clients/base/api/help/project_validate_crm_data_get_help.html', 'minVersion' => '11.10', 'file' => 'modules/pmse_Project/clients/base/api/PMSEProjectApi.php', 'className' => 'PMSEProjectApi', 'score' => 9.5, ), ), ), 'ActivityDefinition' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'pmse_Project', 1 => 'ActivityDefinition', 2 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => '', 2 => 'record', ), 'method' => 'getActivityDefinition', 'acl' => 'view', 'shortHelp' => 'Retrieves the definition data for an activity', 'longHelp' => 'modules/pmse_Project/clients/base/api/help/project_activity_get_help.html', 'file' => 'modules/pmse_Project/clients/base/api/PMSEProjectApi.php', 'className' => 'PMSEProjectApi', 'score' => 9.5, ), ), ), 'EventDefinition' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'pmse_Project', 1 => 'EventDefinition', 2 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => '', 2 => 'record', ), 'method' => 'getEventDefinition', 'acl' => 'view', 'shortHelp' => 'Retrieves the definition data for an event', 'longHelp' => 'modules/pmse_Project/clients/base/api/help/project_event_get_help.html', 'file' => 'modules/pmse_Project/clients/base/api/PMSEProjectApi.php', 'className' => 'PMSEProjectApi', 'score' => 9.5, ), ), ), 'GatewayDefinition' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'pmse_Project', 1 => 'GatewayDefinition', 2 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => '', 2 => 'record', ), 'method' => 'getGatewayDefinition', 'acl' => 'view', 'shortHelp' => 'Retrieves the definition data for a gateway', 'longHelp' => 'modules/pmse_Project/clients/base/api/help/project_gateway_get_help.html', 'file' => 'modules/pmse_Project/clients/base/api/PMSEProjectApi.php', 'className' => 'PMSEProjectApi', 'score' => 9.5, ), ), ), ), 'ProcessBusinessRules' => array ( 'fields' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'ProcessBusinessRules', 1 => 'fields', 2 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'data', 2 => 'filter', ), 'method' => 'getBRFields', 'acl' => 'view', 'file' => 'modules/pmse_Project/clients/base/api/PMSEProjectApi.php', 'className' => 'PMSEProjectApi', 'score' => 9.5, ), ), ), ), 'Leads' => array ( '?' => array ( 'freebusy' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Leads', 1 => '?', 2 => 'freebusy', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', ), 'method' => 'getFreeBusySchedule', 'shortHelp' => 'Retrieve a list of calendar event start and end times for specified person', 'longHelp' => 'include/api/help/lead_get_freebusy_help.html', 'file' => 'modules/Leads/clients/base/api/LeadsApi.php', 'className' => 'LeadsApi', 'score' => 9.5, ), ), ), ), 'DRI_SubWorkflow_Templates' => array ( '?' => array ( 'last-task' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'DRI_SubWorkflow_Templates', 1 => '?', 2 => 'last-task', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', ), 'method' => 'getLastTask', 'shortHelp' => 'Get the last task of the stage template', 'longHelp' => '/include/api/help/customer_journeyDRI_SubWorkflow_TemplatesgetLastTask.html', 'noEtag' => true, 'minVersion' => '11.19', 'file' => 'modules/DRI_SubWorkflow_Templates/clients/base/api/DRI_SubWorkflow_TemplatesApi.php', 'className' => 'DRI_SubWorkflow_TemplatesApi', 'score' => 9.5, ), ), ), ), 'Contact' => array ( '?' => array ( 'Cases' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Contact', 1 => '?', 2 => 'Cases', ), 'pathVars' => array ( 0 => '', 1 => 'contact_id', 2 => 'module', ), 'method' => 'getContactCases', 'shortHelp' => 'Get cases accessible to a contact with portal visibility', 'longHelp' => 'include/api/help/get_contact_cases.html', 'exceptions' => array ( 0 => 'SugarApiExceptionInvalidParameter', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionNotAuthorized', ), 'file' => 'modules/Cases/clients/base/api/CasesFilterApi.php', 'className' => 'CasesFilterApi', 'score' => 9.5, ), ), ), ), 'DRI_Workflow_Templates' => array ( '?' => array ( 'last-stage' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'DRI_Workflow_Templates', 1 => '?', 2 => 'last-stage', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', ), 'method' => 'getLastStage', 'shortHelp' => 'Get the last stage for the Smart Guide template', 'longHelp' => '/include/api/help/customer_journeyDRI_Workflow_TemplatesgetLastStage.html', 'noEtag' => true, 'minVersion' => '11.19', 'file' => 'modules/DRI_Workflow_Templates/clients/base/api/DRIWorkflowTemplatesApi.php', 'className' => 'DRIWorkflowTemplatesApi', 'score' => 9.5, ), ), 'widget-data' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'DRI_Workflow_Templates', 1 => '?', 2 => 'widget-data', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', ), 'method' => 'widgetData', 'shortHelp' => 'Get the data to be loaded for the Smart Guide including stages and activities', 'longHelp' => '/include/api/help/customer_journeyDRI_Workflow_TemplateswidgetData.html', 'noEtag' => true, 'minVersion' => '11.19', 'file' => 'modules/DRI_Workflow_Templates/clients/base/api/DRIWorkflowTemplatesApi.php', 'className' => 'DRIWorkflowTemplatesApi', 'score' => 9.5, ), ), 'export' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'DRI_Workflow_Templates', 1 => '?', 2 => 'export', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', ), 'method' => 'export', 'rawReply' => true, 'allowDownloadCookie' => true, 'shortHelp' => 'Exports a Smart Guide Template in .json format.', 'longHelp' => '/include/api/help/customer_journeyDRI_Workflow_TemplatesexportGet.html', 'minVersion' => '11.19', 'file' => 'modules/DRI_Workflow_Templates/clients/base/api/DRICustomerJourneyTemplatesImportExportApi.php', 'className' => 'DRICustomerJourneyTemplatesImportExportApi', 'score' => 9.5, ), ), ), ), 'Users' => array ( '?' => array ( 'freebusy' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Users', 1 => '?', 2 => 'freebusy', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', ), 'method' => 'getFreeBusySchedule', 'shortHelp' => 'Retrieve a list of calendar event start and end times for specified person', 'longHelp' => 'include/api/help/user_get_freebusy_help.html', 'file' => 'modules/Users/clients/base/api/UsersApi.php', 'className' => 'UsersApi', 'score' => 9.5, ), ), 'userAccess' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Users', 1 => '?', 2 => 'userAccess', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', ), 'method' => 'getUserAccess', 'minVersion' => '11.23', 'shortHelp' => 'Retrieve the users role access defined by the admin in Roles', 'longHelp' => 'modules/Users/clients/base/api/help/UsersApi_get_access.html', 'file' => 'modules/Users/clients/base/api/UsersApi.php', 'className' => 'UsersApi', 'score' => 9.5, ), ), ), ), 'Notes' => array ( 'filter' => array ( 'count' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Notes', 1 => 'filter', 2 => 'count', ), 'pathVars' => array ( 0 => 'module', 1 => '', 2 => '', ), 'method' => 'getFilterListCount', 'shortHelp' => 'Lists filtered records.', 'longHelp' => 'include/api/help/module_filter_post_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionNotAuthorized', 3 => 'SugarApiExceptionInvalidParameter', ), 'file' => 'modules/Notes/clients/base/api/NotesFilterApi.php', 'className' => 'NotesFilterApi', 'score' => 10.5, ), ), ), ), 'Accounts' => array ( '?' => array ( 'opportunity_stats' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Accounts', 1 => '?', 2 => 'opportunity_stats', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', ), 'method' => 'opportunityStats', 'shortHelp' => 'Get opportunity statistics for current record', 'longHelp' => '', 'file' => 'modules/Accounts/clients/base/api/AccountsApi.php', 'className' => 'AccountsApi', 'score' => 9.5, ), ), ), ), 'pmse_Emails_Templates' => array ( '?' => array ( 'etemplate' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'pmse_Emails_Templates', 1 => '?', 2 => 'etemplate', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', ), 'method' => 'emailTemplateDownload', 'rawReply' => true, 'allowDownloadCookie' => true, 'acl' => 'view', 'shortHelp' => 'Exports a .pet file with a Process Email Templates definition', 'longHelp' => 'modules/pmse_Emails_Templates/clients/base/api/help/email_templates_export_help.html', 'file' => 'modules/pmse_Emails_Templates/clients/base/api/PMSEEmailsTemplates.php', 'className' => 'PMSEEmailsTemplates', 'score' => 9.5, ), ), 'find_modules' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'pmse_Emails_Templates', 1 => '?', 2 => 'find_modules', ), 'pathVars' => array ( 0 => 'module', 1 => '', 2 => '', ), 'method' => 'retrieveRelatedBeans', 'acl' => 'view', 'shortHelp' => 'Retrieve a list of related modules', 'longHelp' => 'modules/pmse_Emails_Templates/clients/base/api/help/email_templates_module_list_get_help.html', 'file' => 'modules/pmse_Emails_Templates/clients/base/api/PMSEEmailsTemplates.php', 'className' => 'PMSEEmailsTemplates', 'score' => 9.5, ), ), ), 'variables' => array ( 'find' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'pmse_Emails_Templates', 1 => 'variables', 2 => 'find', ), 'pathVars' => array ( 0 => 'module', 1 => '', 2 => '', ), 'method' => 'findVariables', 'acl' => 'view', 'shortHelp' => 'Get the variable list for a module', 'longHelp' => 'modules/pmse_Emails_Templates/clients/base/api/help/email_templates_variable_list_get_help.html', 'file' => 'modules/pmse_Emails_Templates/clients/base/api/PMSEEmailsTemplates.php', 'className' => 'PMSEEmailsTemplates', 'score' => 10.5, ), ), ), ), 'ForecastWorksheets' => array ( '?' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'ForecastWorksheets', 1 => '?', 2 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'timeperiod_id', 2 => 'user_id', ), 'method' => 'forecastWorksheetsGet', 'jsonParams' => array ( ), 'shortHelp' => 'Filter records from a single module', 'longHelp' => 'modules/Forecasts/clients/base/api/help/ForecastWorksheetGet.html', 'exceptions' => array ( 0 => 'SugarApiExceptionError', 1 => 'SugarApiExceptionInvalidParameter', 2 => 'SugarApiExceptionNotAuthorized', 3 => 'SugarApiExceptionNotFound', ), 'file' => 'modules/ForecastWorksheets/clients/base/api/ForecastWorksheetsFilterApi.php', 'className' => 'ForecastWorksheetsFilterApi', 'score' => 8.5, ), ), ), 'chart' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'ForecastWorksheets', 1 => 'chart', 2 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => '', 2 => 'timeperiod_id', ), 'method' => 'forecastWorksheetsChartGet', 'jsonParams' => array ( ), 'shortHelp' => 'Filter records and reformat data for chart presentation', 'longHelp' => 'modules/Forecasts/clients/base/api/help/ForecastsWorksheetChartGet.html', 'exceptions' => array ( 0 => 'SugarApiExceptionError', 1 => 'SugarApiExceptionInvalidParameter', 2 => 'SugarApiExceptionNotAuthorized', 3 => 'SugarApiExceptionNotFound', ), 'file' => 'modules/ForecastWorksheets/clients/base/api/ForecastWorksheetsFilterApi.php', 'className' => 'ForecastWorksheetsFilterApi', 'score' => 9.5, ), ), ), ), 'Forecasts' => array ( 'user' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Forecasts', 1 => 'user', 2 => '?', ), 'pathVars' => array ( 0 => '', 1 => '', 2 => 'user_id', ), 'method' => 'retrieveSelectedUser', 'shortHelp' => 'Returns selectedUser object for given user', 'longHelp' => 'modules/Forecasts/clients/base/api/help/ForecastsApiUserGet.html', 'file' => 'modules/Forecasts/clients/base/api/ForecastsApi.php', 'className' => 'ForecastsApi', 'score' => 9.5, ), ), ), 'enum' => array ( 'selectedTimePeriod' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Forecasts', 1 => 'enum', 2 => 'selectedTimePeriod', ), 'pathVars' => array ( 0 => '', 1 => '', 2 => '', ), 'method' => 'timeperiod', 'shortHelp' => 'forecast timeperiod', 'longHelp' => 'modules/Forecasts/clients/base/api/help/ForecastApiTimePeriodGet.html', 'file' => 'modules/Forecasts/clients/base/api/ForecastsApi.php', 'className' => 'ForecastsApi', 'score' => 10.5, ), ), ), 'reportees' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Forecasts', 1 => 'reportees', 2 => '?', ), 'pathVars' => array ( 0 => '', 1 => '', 2 => 'user_id', ), 'method' => 'getReportees', 'shortHelp' => 'Gets reportees to a user by id', 'longHelp' => 'modules/Forecasts/clients/base/api/help/ForecastApiReporteesGet.html', 'file' => 'modules/Forecasts/clients/base/api/ForecastsApi.php', 'className' => 'ForecastsApi', 'score' => 9.5, ), ), ), 'orgtree' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Forecasts', 1 => 'orgtree', 2 => '?', ), 'pathVars' => array ( 0 => '', 1 => '', 2 => 'user_id', ), 'method' => 'getOrgTree', 'shortHelp' => 'Gets managers and reportees of user', 'longHelp' => 'modules/Forecasts/clients/base/api/help/ForecastApiOrgetreeGet.html', 'file' => 'modules/Forecasts/clients/base/api/ForecastsApi.php', 'className' => 'ForecastsApi', 'score' => 9.5, ), ), ), ), 'Reports' => array ( '?' => array ( 'records' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Reports', 1 => '?', 2 => 'records', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', ), 'method' => 'getReportRecords', 'jsonParams' => array ( 0 => 'group_filters', ), 'shortHelp' => 'An API to deliver filtered records from a saved report', 'longHelp' => 'modules/Reports/clients/base/api/help/report_records_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionInvalidParameter', ), 'file' => 'modules/Reports/clients/base/api/ReportsApi.php', 'className' => 'ReportsApi', 'score' => 9.5, ), ), 'record_count' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Reports', 1 => '?', 2 => 'record_count', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', ), 'method' => 'getRecordCount', 'jsonParams' => array ( 0 => 'group_filters', ), 'shortHelp' => 'An API to get total number of filtered records from a saved report', 'longHelp' => 'modules/Reports/clients/base/api/help/report_recordcount_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionInvalidParameter', ), 'file' => 'modules/Reports/clients/base/api/ReportsApi.php', 'className' => 'ReportsApi', 'score' => 9.5, ), ), 'chart' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Reports', 1 => '?', 2 => 'chart', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', ), 'method' => 'getSavedReportChartById', 'shortHelp' => 'An API to get chart data for a saved report', 'longHelp' => 'modules/Reports/clients/base/api/help/report_chart_get_help.html', 'file' => 'modules/Reports/clients/base/api/ReportsApi.php', 'className' => 'ReportsApi', 'score' => 9.5, ), ), 'filter' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Reports', 1 => '?', 2 => 'filter', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', ), 'method' => 'getSavedReportFilterData', 'shortHelp' => 'Retrieve Saved Report Filter Data', 'longHelp' => 'modules/Reports/clients/base/api/help/report_saved_report_filterdata_get_help.html', 'minVersion' => '11.17', 'file' => 'modules/Reports/clients/base/api/ReportsApi.php', 'className' => 'ReportsApi', 'score' => 9.5, ), ), '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Reports', 1 => '?', 2 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => 'export_type', ), 'method' => 'exportRecord', 'rawReply' => true, 'shortHelp' => 'This method exports a report in the specified type', 'longHelp' => 'modules/Reports/clients/base/api/help/report_export_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionInvalidParameter', 2 => 'SugarApiExceptionNoMethod', 3 => 'SugarApiExceptionNotAuthorized', 4 => 'SugarReportsExceptionAccessDisabled', 5 => 'SugarReportsExceptionAdminExportOnly', 6 => 'SugarReportsExceptionDisabledExport', 7 => 'SugarReportsExceptionExportNotAllowed', 8 => 'SugarReportsExceptionExportOwner', 9 => 'SugarReportsExceptionFieldsRestricted', 10 => 'SugarReportsExceptionListNotAllowed', 11 => 'SugarReportsExceptionViewNotAllowed', ), 'file' => 'modules/Reports/clients/base/api/ReportsExportApi.php', 'className' => 'ReportsExportApi', 'score' => 8.5, ), ), ), 'panel' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Reports', 1 => 'panel', 2 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'action', 2 => 'record', ), 'method' => 'retrievePanel', 'shortHelp' => 'Retrieve report panel', 'longHelp' => 'modules/Reports/clients/base/api/help/report_panel_get_help.html', 'file' => 'modules/Reports/clients/base/api/ReportsApi.php', 'className' => 'ReportsApi', 'score' => 9.5, ), ), ), 'panelDefault' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Reports', 1 => 'panelDefault', 2 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'action', 2 => 'reportType', ), 'method' => 'getDefaultReportPanel', 'shortHelp' => 'Retrieve default report panel', 'longHelp' => 'modules/Reports/clients/base/api/help/report_default_panel_get_help.html', 'file' => 'modules/Reports/clients/base/api/ReportsApi.php', 'className' => 'ReportsApi', 'score' => 9.5, ), ), ), 'activeSavedReport' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Reports', 1 => 'activeSavedReport', 2 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'action', 2 => 'record', ), 'method' => 'getActiveSavedReportsId', 'shortHelp' => 'Retrieve Saved Reports Defs', 'longHelp' => 'modules/Reports/clients/base/api/help/report_active_saved_reports_help.html', 'minVersion' => '11.17', 'file' => 'modules/Reports/clients/base/api/ReportsApi.php', 'className' => 'ReportsApi', 'score' => 9.5, ), ), ), ), 'pmse_Inbox' => array ( 'processUsersChart' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'pmse_Inbox', 1 => 'processUsersChart', 2 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => '', 2 => 'filter', ), 'method' => 'returnProcessUsersChart', 'acl' => 'adminOrDev', 'file' => 'modules/pmse_Inbox/clients/base/api/PMSECasesListApi.php', 'className' => 'PMSECasesListApi', 'score' => 9.5, ), ), ), 'processStatusChart' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'pmse_Inbox', 1 => 'processStatusChart', 2 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => '', 2 => 'filter', ), 'method' => 'returnProcessStatusChart', 'acl' => 'adminOrDev', 'file' => 'modules/pmse_Inbox/clients/base/api/PMSECasesListApi.php', 'className' => 'PMSECasesListApi', 'score' => 9.5, ), ), ), 'historyLog' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'pmse_Inbox', 1 => 'historyLog', 2 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => '', 2 => 'filter', ), 'method' => 'retrieveHistoryLog', 'acl' => 'view', 'keepSession' => true, 'shortHelp' => 'Returns the history log for a process', 'longHelp' => 'modules/pmse_Inbox/clients/base/api/help/process_retrieve_history_log_help.html', 'file' => 'modules/pmse_Inbox/clients/base/api/PMSEEngineApi.php', 'className' => 'PMSEEngineApi', 'score' => 9.5, ), ), ), 'note_list' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'pmse_Inbox', 1 => 'note_list', 2 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => '', 2 => 'cas_id', ), 'method' => 'getNotes', 'acl' => 'view', 'keepSession' => true, 'shortHelp' => 'Returns the notes list for a process', 'longHelp' => 'modules/pmse_Inbox/clients/base/api/help/process_get_notes_help.html', 'file' => 'modules/pmse_Inbox/clients/base/api/PMSEEngineApi.php', 'className' => 'PMSEEngineApi', 'score' => 9.5, ), ), ), 'changeCaseUser' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'pmse_Inbox', 1 => 'changeCaseUser', 2 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => '', 2 => 'cas_id', ), 'method' => 'changeCaseUser', 'keepSession' => true, 'shortHelp' => 'Retrieve information for Change Process User window. DEPRECATED', 'longHelp' => 'modules/pmse_Inbox/clients/base/api/help/process_deprecate.html', 'file' => 'modules/pmse_Inbox/clients/base/api/PMSEEngineApi.php', 'className' => 'PMSEEngineApi', 'score' => 9.5, ), ), ), 'userListByTeam' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'pmse_Inbox', 1 => 'userListByTeam', 2 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => '', 2 => 'id', ), 'method' => 'userListByTeam', 'keepSession' => true, 'shortHelp' => 'Retrieve users associated to a Team. DEPRECATED', 'longHelp' => 'modules/pmse_Inbox/clients/base/api/help/process_deprecate.html', 'file' => 'modules/pmse_Inbox/clients/base/api/PMSEEngineApi.php', 'className' => 'PMSEEngineApi', 'score' => 9.5, ), ), ), 'reassignFlows' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'pmse_Inbox', 1 => 'reassignFlows', 2 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => '', 2 => 'record', ), 'jsonParams' => array ( 0 => 'filter', ), 'method' => 'getReassignFlows', 'keepSession' => true, 'acl' => 'adminOrDev', 'shortHelp' => 'Retrieve information to reassign processes', 'longHelp' => 'modules/pmse_Inbox/clients/base/api/help/process_get_reassign_flows_help.html', 'file' => 'modules/pmse_Inbox/clients/base/api/PMSEEngineApi.php', 'className' => 'PMSEEngineApi', 'score' => 9.5, ), ), ), ), 'Contacts' => array ( '?' => array ( 'opportunity_stats' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Contacts', 1 => '?', 2 => 'opportunity_stats', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', ), 'method' => 'opportunityStats', 'shortHelp' => 'Get opportunity statistics for current record', 'longHelp' => '', 'file' => 'modules/Contacts/clients/base/api/ContactsApi.php', 'className' => 'ContactsApi', 'score' => 9.5, ), ), 'influencers' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Contacts', 1 => '?', 2 => 'influencers', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', ), 'method' => 'influencers', 'shortHelp' => '', 'longHelp' => '', 'file' => 'modules/Contacts/clients/base/api/ContactsApi.php', 'className' => 'ContactsApi', 'score' => 9.5, ), ), 'freebusy' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Contacts', 1 => '?', 2 => 'freebusy', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', ), 'method' => 'getFreeBusySchedule', 'shortHelp' => 'Retrieve a list of calendar event start and end times for specified person', 'longHelp' => 'include/api/help/contact_get_freebusy_help.html', 'file' => 'modules/Contacts/clients/base/api/ContactsApi.php', 'className' => 'ContactsApi', 'score' => 9.5, ), ), ), ), 'pmse_Business_Rules' => array ( '?' => array ( 'brules' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'pmse_Business_Rules', 1 => '?', 2 => 'brules', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', ), 'method' => 'businessRuleDownload', 'rawReply' => true, 'allowDownloadCookie' => true, 'acl' => 'view', 'shortHelp' => 'Exports a .pbr file with a Process Business Rules definition', 'longHelp' => 'modules/pmse_Business_Rules/clients/base/api/help/business_rules_export_help.html', 'file' => 'modules/pmse_Business_Rules/clients/base/api/PMSEBusinessRules.php', 'className' => 'PMSEBusinessRules', 'score' => 9.5, ), ), ), ), 'ExpressionEngine' => array ( '?' => array ( 'related' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'ExpressionEngine', 1 => '?', 2 => 'related', ), 'pathVars' => array ( 0 => '', 1 => 'record', 2 => '', ), 'method' => 'deprecatedGetRelatedValues', 'shortHelp' => 'Retrieve the Chart data for the given data in the Forecast Module (deprecated)', 'longHelp' => 'modules/Forecasts/clients/base/api/help/ForecastChartApi.html', 'maxVersion' => '12', 'file' => 'modules/ExpressionEngine/clients/base/api/RelatedValueApi.php', 'className' => 'RelatedValueApi', 'score' => 9.5, ), ), ), ), ), 'PUT' => array ( 'lang' => array ( 'labels' => array ( 'module' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'lang', 1 => 'labels', 2 => 'module', ), 'pathVars' => array ( 0 => '', 1 => '', 2 => '', ), 'method' => 'updateModules', 'shortHelp' => 'This method updates translations for fields in a module', 'longHelp' => 'include/api/help/language_labels_module_put_help.html', 'minVersion' => '11.13', 'file' => 'clients/base/api/LanguageApi.php', 'className' => 'LanguageApi', 'score' => 10.5, ), ), 'dropdown' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'lang', 1 => 'labels', 2 => 'dropdown', ), 'pathVars' => array ( 0 => '', 1 => '', 2 => '', ), 'method' => 'updateDropdowns', 'shortHelp' => 'This method updates translations for items in a dropdown', 'longHelp' => 'include/api/help/language_labels_dropdown_put_help.html', 'minVersion' => '11.13', 'file' => 'clients/base/api/LanguageApi.php', 'className' => 'LanguageApi', 'score' => 10.5, ), ), ), ), '<module>' => array ( 'sync_key' => array ( '?' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => '<module>', 1 => 'sync_key', 2 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => '', 2 => 'sync_key_field_value', ), 'method' => 'upsertByField', 'shortHelp' => 'Upsert based on sync_key. If the record can be found with sync_key, then update. If the record does not exist, then create it. Recommended use of PATCH HTTP verb.', 'file' => 'clients/base/api/IntegrateApi.php', 'className' => 'IntegrateApi', 'score' => 8.75, ), ), ), '?' => array ( 'favorite' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => '<module>', 1 => '?', 2 => 'favorite', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => 'favorite', ), 'method' => 'setFavorite', 'shortHelp' => 'This method sets a record of the specified type as a favorite', 'longHelp' => 'include/api/help/module_record_favorite_put_help.html', 'file' => 'clients/base/api/ModuleApi.php', 'className' => 'ModuleApi', 'score' => 8.75, ), ), 'unfavorite' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => '<module>', 1 => '?', 2 => 'unfavorite', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => 'unfavorite', ), 'method' => 'unsetFavorite', 'shortHelp' => 'This method unsets a record of the specified type as a favorite', 'longHelp' => 'include/api/help/module_record_favorite_delete_help.html', 'file' => 'clients/base/api/ModuleApi.php', 'className' => 'ModuleApi', 'score' => 8.75, ), ), ), ), 'integrate' => array ( '<module>' => array ( '?' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'integrate', 1 => '<module>', 2 => '?', ), 'pathVars' => array ( 0 => '', 1 => 'module', 2 => 'record_id', ), 'method' => 'setSyncKey', 'shortHelp' => 'Set synchronization key for a provided module and a record_id given from the query params', 'file' => 'clients/base/api/IntegrateApi.php', 'className' => 'IntegrateApi', 'score' => 8.75, ), ), ), ), 'me' => array ( 'preference' => array ( '?' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'me', 1 => 'preference', 2 => '?', ), 'pathVars' => array ( 0 => '', 1 => '', 2 => 'preference_name', ), 'method' => 'userPreferenceSave', 'shortHelp' => 'Update a specific preference for the current user', 'longHelp' => 'include/api/help/me_preference_preference_name_put_help.html', 'ignoreSystemStatusError' => true, 'file' => 'clients/base/api/CurrentUserApi.php', 'className' => 'CurrentUserApi', 'score' => 9.5, ), ), ), 'last_states' => array ( '?' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'me', 1 => 'last_states', 2 => '?', ), 'pathVars' => array ( 0 => '', 1 => '', 2 => 'platform', ), 'method' => 'updateLastStatesByPlatform', 'minVersion' => '11.20', 'shortHelp' => 'Perform an update to the set of last state data for the current user for a platform', 'longHelp' => 'include/api/help/me_last_states_by_platform_put_help.html', 'ignoreSystemStatusError' => true, 'file' => 'clients/base/api/CurrentUserApi.php', 'className' => 'CurrentUserApi', 'score' => 9.5, ), ), ), ), 'hint' => array ( 'enrich' => array ( 'config' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'hint', 1 => 'enrich', 2 => 'config', ), 'pathVars' => array ( 0 => '', ), 'method' => 'updateEnrichFieldConfig', 'shortHelp' => 'Updates Hint configuration', 'longHelp' => 'include/api/help/hint_enrich_config_put_help.html', 'minVersion' => '11.16', 'file' => 'clients/base/api/HintApi.php', 'className' => 'HintApi', 'score' => 10.5, ), ), ), 'config' => array ( 'notifications' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'hint', 1 => 'config', 2 => 'notifications', ), 'pathVars' => array ( 0 => '', ), 'method' => 'updateConfigNotificationsHint', 'shortHelp' => 'Enables/Disables notifications in the Hint MLP', 'longHelp' => 'include/api/help/hint_config_notifications_put_help.html', 'minVersion' => '11.16', 'file' => 'clients/base/api/HintApi.php', 'className' => 'HintApi', 'score' => 10.5, ), ), ), ), 'Filters' => array ( '?' => array ( 'used' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'Filters', 1 => '?', 2 => 'used', ), 'pathVars' => array ( 0 => 'module', 1 => 'module_name', 2 => 'used', ), 'method' => 'setUsed', 'shortHelp' => 'This method sets the filter as used for the current user', 'longHelp' => '', 'file' => 'modules/Filters/clients/base/api/PreviouslyUsedFiltersApi.php', 'className' => 'PreviouslyUsedFiltersApi', 'score' => 9.5, ), ), ), ), 'Administration' => array ( 'module-names-and-icons' => array ( '?' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'Administration', 1 => 'module-names-and-icons', 2 => '?', ), 'pathVars' => array ( 0 => '', 1 => '', 2 => 'language', ), 'method' => 'setModules', 'shortHelp' => 'Sets module names and icons', 'longHelp' => 'modules/Administration/clients/base/api/help/ModuleNamesAndIconsApiPut.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotAuthorized', ), 'ignoreSystemStatusError' => true, 'minVersion' => '11.19', 'file' => 'modules/Administration/clients/base/api/ModuleNamesAndIconsApi.php', 'className' => 'ModuleNamesAndIconsApi', 'score' => 9.5, ), ), ), ), 'KBContents' => array ( '?' => array ( 'useful' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'KBContents', 1 => '?', 2 => 'useful', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => 'useful', ), 'method' => 'voteUseful', 'shortHelp' => 'This method votes a record of the specified type as useful', 'longHelp' => 'include/api/help/kb_vote_put_help.html', 'file' => 'modules/KBContents/clients/base/api/KBContentsUsefulnessApi.php', 'className' => 'KBContentsUsefulnessApi', 'score' => 9.5, ), ), 'notuseful' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'KBContents', 1 => '?', 2 => 'notuseful', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => 'notuseful', ), 'method' => 'voteNotUseful', 'shortHelp' => 'This method votes a record of the specified type as not useful', 'longHelp' => 'include/api/help/kb_vote_put_help.html', 'file' => 'modules/KBContents/clients/base/api/KBContentsUsefulnessApi.php', 'className' => 'KBContentsUsefulnessApi', 'score' => 9.5, ), ), ), ), 'Dashboards' => array ( '?' => array ( 'restore-tab-metadata' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'Dashboards', 1 => '?', 2 => 'restore-tab-metadata', ), 'pathVars' => array ( 0 => 'module', 1 => 'id', 2 => '', ), 'method' => 'restoreDefaultMetadataForTabbedDashboard', 'shortHelp' => 'This method updates a tab on a dashboard to the default metadata', 'longHelp' => 'modules/Dashboards/clients/base/api/help/dashboard_default_metadata.html', 'minVersion' => '11.12', 'file' => 'modules/Dashboards/clients/base/api/DashboardDefaultMetadataApi.php', 'className' => 'DashboardDefaultMetadataApi', 'score' => 9.5, ), ), 'restore-metadata' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'Dashboards', 1 => '?', 2 => 'restore-metadata', ), 'pathVars' => array ( 0 => 'module', 1 => 'id', 2 => '', ), 'method' => 'restoreMetadata', 'shortHelp' => 'This method restores a dashboard to the default metadata', 'longHelp' => 'modules/Dashboards/clients/base/api/help/restore_metadata.html', 'minVersion' => '11.13', 'file' => 'modules/Dashboards/clients/base/api/DashboardDefaultMetadataApi.php', 'className' => 'DashboardDefaultMetadataApi', 'score' => 9.5, ), ), ), ), 'pmse_Project' => array ( 'project' => array ( '?' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'pmse_Project', 1 => 'project', 2 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'customAction', 2 => 'record', ), 'method' => 'updateCustomProject', 'acl' => 'create', 'shortHelp' => 'Updates the schema data from the Process Definition designer', 'longHelp' => 'modules/pmse_Project/clients/base/api/help/project_project_put_help.html', 'file' => 'modules/pmse_Project/clients/base/api/PMSEProjectApi.php', 'className' => 'PMSEProjectApi', 'score' => 9.5, ), ), ), 'ActivityDefinition' => array ( '?' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'pmse_Project', 1 => 'ActivityDefinition', 2 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => '', 2 => 'record', ), 'method' => 'putActivityDefinition', 'acl' => 'create', 'shortHelp' => 'Updates the definition data for an activity', 'longHelp' => 'modules/pmse_Project/clients/base/api/help/project_activity_put_help.html', 'file' => 'modules/pmse_Project/clients/base/api/PMSEProjectApi.php', 'className' => 'PMSEProjectApi', 'score' => 9.5, ), ), ), 'EventDefinition' => array ( '?' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'pmse_Project', 1 => 'EventDefinition', 2 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => '', 2 => 'record', ), 'method' => 'putEventDefinition', 'acl' => 'create', 'shortHelp' => 'Updates the definition data for an event', 'longHelp' => 'modules/pmse_Project/clients/base/api/help/project_event_put_help.html', 'file' => 'modules/pmse_Project/clients/base/api/PMSEProjectApi.php', 'className' => 'PMSEProjectApi', 'score' => 9.5, ), ), ), 'GatewayDefinition' => array ( '?' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'pmse_Project', 1 => 'GatewayDefinition', 2 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => '', 2 => 'record', ), 'method' => 'putGatewayDefinition', 'acl' => 'create', 'shortHelp' => 'Updates the definition data for a gateway', 'longHelp' => 'modules/pmse_Project/clients/base/api/help/project_gateway_put_help.html', 'file' => 'modules/pmse_Project/clients/base/api/PMSEProjectApi.php', 'className' => 'PMSEProjectApi', 'score' => 9.5, ), ), ), ), 'Users' => array ( '?' => array ( 'resetPreferences' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'Users', 1 => '?', 2 => 'resetPreferences', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', ), 'method' => 'resetPreferences', 'minVersion' => '11.23', 'shortHelp' => 'This method resets User preference.', 'longHelp' => 'modules/Users/clients/base/api/help/UsersApi_resetPreferences.html', 'ignoreSystemStatusError' => true, 'file' => 'modules/Users/clients/base/api/UsersApi.php', 'className' => 'UsersApi', 'score' => 9.5, ), ), ), ), 'Reports' => array ( 'panel' => array ( '?' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'Reports', 1 => 'panel', 2 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'action', 2 => 'record', ), 'method' => 'savePanel', 'shortHelp' => 'Save report panel', 'longHelp' => 'modules/Reports/clients/base/api/help/report_panel_put_help.html', 'file' => 'modules/Reports/clients/base/api/ReportsApi.php', 'className' => 'ReportsApi', 'score' => 9.5, ), ), ), ), 'pmse_Inbox' => array ( 'clearLog' => array ( '?' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'pmse_Inbox', 1 => 'clearLog', 2 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'clearLog', 2 => 'typelog', ), 'method' => 'clearLog', 'jsonParams' => array ( ), 'acl' => 'adminOrDev', 'shortHelp' => 'Clear the PMSE.log file log', 'longHelp' => 'modules/pmse_Inbox/clients/base/api/help/process_clear_log_help.html', 'file' => 'modules/pmse_Inbox/clients/base/api/PMSECasesListApi.php', 'className' => 'PMSECasesListApi', 'score' => 9.5, ), ), ), ), ), 'DELETE' => array ( '<module>' => array ( 'sync_key' => array ( '?' => array ( 0 => array ( 'reqType' => 'DELETE', 'path' => array ( 0 => '<module>', 1 => 'sync_key', 2 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => '', 2 => 'sync_key_field_value', ), 'method' => 'deleteByField', 'shortHelp' => 'Delete record with given sync_key.', 'file' => 'clients/base/api/IntegrateApi.php', 'className' => 'IntegrateApi', 'score' => 8.75, ), ), ), 'record_list' => array ( '?' => array ( 0 => array ( 'reqType' => 'DELETE', 'path' => array ( 0 => '<module>', 1 => 'record_list', 2 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => '', 2 => 'record_list_id', ), 'method' => 'recordListDelete', 'shortHelp' => 'An API to delete an old record list', 'longHelp' => 'include/api/help/module_recordlist_delete.html', 'file' => 'clients/base/api/RecordListApi.php', 'className' => 'RecordListApi', 'score' => 8.75, ), ), ), 'customfield' => array ( '?' => array ( 0 => array ( 'reqType' => 'DELETE', 'path' => array ( 0 => '<module>', 1 => 'customfield', 2 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => '', 2 => 'field', ), 'method' => 'deleteCustomField', 'shortHelp' => 'This method deletes the custom field of specified module', 'longHelp' => 'include/api/help/module_field_delete_help.html', 'minVersion' => '11.11', 'file' => 'clients/base/api/FieldApi.php', 'className' => 'FieldApi', 'score' => 8.75, ), ), ), '?' => array ( 'favorite' => array ( 0 => array ( 'reqType' => 'DELETE', 'path' => array ( 0 => '<module>', 1 => '?', 2 => 'favorite', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => 'favorite', ), 'method' => 'unsetFavorite', 'shortHelp' => 'This method unsets a record of the specified type as a favorite', 'longHelp' => 'include/api/help/module_record_favorite_delete_help.html', 'file' => 'clients/base/api/ModuleApi.php', 'className' => 'ModuleApi', 'score' => 8.75, ), ), 'unsubscribe' => array ( 0 => array ( 'reqType' => 'DELETE', 'path' => array ( 0 => '<module>', 1 => '?', 2 => 'unsubscribe', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', ), 'method' => 'unsubscribeFromRecord', 'shortHelp' => 'This method unsubscribes the user from the current record, for activity stream updates.', 'longHelp' => 'modules/ActivityStream/clients/base/api/help/recordUnsubscribe.html', 'file' => 'modules/ActivityStream/clients/base/api/SubscriptionsApi.php', 'className' => 'SubscriptionsApi', 'score' => 8.75, ), ), ), ), 'integrate' => array ( '<module>' => array ( 'link' => array ( 0 => array ( 'reqType' => 'DELETE', 'path' => array ( 0 => 'integrate', 1 => '<module>', 2 => 'link', ), 'pathVars' => array ( 0 => '', 1 => 'module', 2 => '', ), 'method' => 'unrelateByFields', 'shortHelp' => 'Remove a relationship based on fields given from the query params. If both the LHS and RHS records can be found with the respective fields, and those records are related, then remove the relationship of the RHS record to the LHS record.', 'file' => 'clients/base/api/IntegrateRelateApi.php', 'className' => 'IntegrateRelateApi', 'score' => 9.75, ), ), ), ), 'me' => array ( 'preference' => array ( '?' => array ( 0 => array ( 'reqType' => 'DELETE', 'path' => array ( 0 => 'me', 1 => 'preference', 2 => '?', ), 'pathVars' => array ( 0 => '', 1 => '', 2 => 'preference_name', ), 'method' => 'userPreferenceDelete', 'shortHelp' => 'Delete a specific preference for the current user', 'longHelp' => 'include/api/help/me_preference_preference_name_delete_help.html', 'ignoreSystemStatusError' => true, 'file' => 'clients/base/api/CurrentUserApi.php', 'className' => 'CurrentUserApi', 'score' => 9.5, ), ), ), ), 'Filters' => array ( '?' => array ( 'used' => array ( 0 => array ( 'reqType' => 'DELETE', 'path' => array ( 0 => 'Filters', 1 => '?', 2 => 'used', ), 'pathVars' => array ( 0 => 'module', 1 => 'module_name', 2 => 'used', ), 'method' => 'deleteUsed', 'shortHelp' => 'This method deletes all used filters for the current user', 'longHelp' => '', 'file' => 'modules/Filters/clients/base/api/PreviouslyUsedFiltersApi.php', 'className' => 'PreviouslyUsedFiltersApi', 'score' => 9.5, ), ), ), ), 'Administration' => array ( 'packages' => array ( '?' => array ( 0 => array ( 'reqType' => 'DELETE', 'path' => array ( 0 => 'Administration', 1 => 'packages', 2 => '?', ), 'pathVars' => array ( 0 => '', 1 => '', 2 => 'id', ), 'method' => 'deletePackage', 'shortHelp' => 'Delete the given package by file hash', 'longHelp' => 'include/api/help/administration_packages_delete_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotAuthorized', 1 => 'SugarApiExceptionMissingParameter', 2 => 'SugarApiException', ), 'file' => 'modules/Administration/clients/base/api/PackageApiRest.php', 'className' => 'PackageApiRest', 'score' => 9.5, ), ), ), 'settings' => array ( 'idmMode' => array ( 0 => array ( 'reqType' => 'DELETE', 'path' => array ( 0 => 'Administration', 1 => 'settings', 2 => 'idmMode', ), 'pathVars' => array ( 0 => '', ), 'method' => 'switchOffIdmMode', 'shortHelp' => 'Turns IDM mode off', 'longHelp' => 'include/api/help/administration_settings_delete_idm_mode_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotAuthorized', ), 'minVersion' => '11.2', 'ignoreSystemStatusError' => true, 'file' => 'modules/Administration/clients/base/api/AuthSettingsApi.php', 'className' => 'AuthSettingsApi', 'score' => 10.5, ), ), ), ), 'Mail' => array ( 'attachment' => array ( '?' => array ( 0 => array ( 'reqType' => 'DELETE', 'path' => array ( 0 => 'Mail', 1 => 'attachment', 2 => '?', ), 'pathVars' => array ( 0 => '', 1 => '', 2 => 'file_guid', ), 'method' => 'removeAttachment', 'rawPostContents' => true, 'shortHelp' => 'Removes a mail attachment', 'longHelp' => 'modules/Emails/clients/base/api/help/mail_attachment_record_delete_help.html', 'file' => 'modules/Emails/clients/base/api/MailApi.php', 'className' => 'MailApi', 'score' => 9.5, ), ), 'cache' => array ( 0 => array ( 'reqType' => 'DELETE', 'path' => array ( 0 => 'Mail', 1 => 'attachment', 2 => 'cache', ), 'pathVars' => array ( 0 => '', 1 => '', 2 => '', ), 'method' => 'clearUserCache', 'rawPostContents' => true, 'shortHelp' => 'Clears the user\'s attachment cache directory', 'longHelp' => 'modules/Emails/clients/base/api/help/mail_attachment_cache_delete_help.html', 'file' => 'modules/Emails/clients/base/api/MailApi.php', 'className' => 'MailApi', 'score' => 10.5, ), ), ), ), 'pmse_Inbox' => array ( 'delete_notes' => array ( '?' => array ( 0 => array ( 'reqType' => 'DELETE', 'path' => array ( 0 => 'pmse_Inbox', 1 => 'delete_notes', 2 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => '', 2 => 'id', ), 'method' => 'deleteNotes', 'keepSession' => true, 'shortHelp' => 'Deletes a note for a process', 'longHelp' => 'modules/pmse_Inbox/clients/base/api/help/process_delete_notes_help.html', 'file' => 'modules/pmse_Inbox/clients/base/api/PMSEEngineApi.php', 'className' => 'PMSEEngineApi', 'score' => 9.5, ), ), ), ), ), 'PATCH' => array ( '<module>' => array ( 'sync_key' => array ( '?' => array ( 0 => array ( 'reqType' => 'PATCH', 'path' => array ( 0 => '<module>', 1 => 'sync_key', 2 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => '', 2 => 'sync_key_field_value', ), 'method' => 'upsertByField', 'shortHelp' => 'Upsert based on sync_key. If the record can be found with sync_key, then update. If the record does not exist, then create it. Recommended use of PATCH HTTP verb.', 'file' => 'clients/base/api/IntegrateApi.php', 'className' => 'IntegrateApi', 'score' => 8.75, ), ), ), ), 'integrate' => array ( '<module>' => array ( '?' => array ( 0 => array ( 'reqType' => 'PATCH', 'path' => array ( 0 => 'integrate', 1 => '<module>', 2 => '?', ), 'pathVars' => array ( 0 => '', 1 => 'module', 2 => 'record_id', ), 'method' => 'setSyncKey', 'shortHelp' => 'Set synchronization key for a provided module and a record_id given from the query params', 'file' => 'clients/base/api/IntegrateApi.php', 'className' => 'IntegrateApi', 'score' => 8.75, ), ), ), ), ), ), 'mobile' => array ( 'POST' => array ( 'oauth2' => array ( 'bwc' => array ( 'login' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'oauth2', 1 => 'bwc', 2 => 'login', ), 'pathVars' => array ( 0 => '', 1 => '', 2 => '', ), 'method' => 'bwcLogin', 'shortHelp' => 'Bwc login for bwc modules. Internal usage only.', 'longHelp' => 'include/api/help/oauth2_bwc_login_post_help.html', 'keepSession' => true, 'ignoreMetaHash' => true, 'ignoreSystemStatusError' => true, 'file' => 'clients/mobile/api/OAuth2MobileApi.php', 'className' => 'OAuth2MobileApi', 'score' => 10.5, ), ), 'logout' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'oauth2', 1 => 'bwc', 2 => 'logout', ), 'pathVars' => array ( 0 => '', 1 => '', 2 => '', ), 'method' => 'bwcLogout', 'shortHelp' => 'Bwc logout for bwc modules. Internal usage only.', 'longHelp' => 'include/api/help/oauth2_bwc_logout_post_help.html', 'keepSession' => true, 'ignoreMetaHash' => true, 'ignoreSystemStatusError' => true, 'file' => 'clients/mobile/api/OAuth2MobileApi.php', 'className' => 'OAuth2MobileApi', 'score' => 10.5, ), ), ), 'sudo' => array ( '?' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'oauth2', 1 => 'sudo', 2 => '?', ), 'pathVars' => array ( 0 => '', 1 => '', 2 => 'user_name', ), 'method' => 'sudo', 'shortHelp' => 'Get an access token for another user', 'longHelp' => 'include/api/help/oauth2_sudo_post_help.html', 'ignoreMetaHash' => true, 'file' => 'clients/mobile/api/OAuth2MobileApi.php', 'className' => 'OAuth2MobileApi', 'score' => 9.5, ), ), ), ), '<module>' => array ( '?' => array ( 'link' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => '<module>', 1 => '?', 2 => 'link', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', ), 'method' => 'createRelatedLinks', 'shortHelp' => 'Relates existing records to this module.', 'longHelp' => 'include/api/help/module_record_link_post_help.html', 'file' => 'clients/mobile/api/RelateRecordMobileApi.php', 'className' => 'RelateRecordMobileApi', 'score' => 8.75, ), ), ), ), 'me' => array ( 'preference' => array ( '?' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'me', 1 => 'preference', 2 => '?', ), 'pathVars' => array ( 0 => '', 1 => '', 2 => 'preference_name', ), 'method' => 'userPreferenceSave', 'shortHelp' => 'Create a preference for the current user', 'longHelp' => 'include/api/help/me_preference_preference_name_post_help.html', 'ignoreSystemStatusError' => true, 'file' => 'clients/mobile/api/CurrentUserMobileApi.php', 'className' => 'CurrentUserMobileApi', 'score' => 9.5, ), ), ), ), ), 'GET' => array ( 'me' => array ( 'preference' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'me', 1 => 'preference', 2 => '?', ), 'pathVars' => array ( 0 => '', 1 => '', 2 => 'preference_name', ), 'method' => 'userPreference', 'shortHelp' => 'Returns a specific preference for the current user', 'longHelp' => 'include/api/help/me_preference_preference_name_get_help.html', 'ignoreSystemStatusError' => true, 'file' => 'clients/mobile/api/CurrentUserMobileApi.php', 'className' => 'CurrentUserMobileApi', 'score' => 9.5, ), ), ), 'last_states' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'me', 1 => 'last_states', 2 => '?', ), 'pathVars' => array ( 0 => '', 1 => '', 2 => 'platform', ), 'method' => 'retrieveLastStatesByPlatform', 'minVersion' => '11.20', 'ignoreMetaHash' => true, 'shortHelp' => 'Retrieve the set of last state data for the current user for a specific platform', 'longHelp' => 'include/api/help/me_last_states_by_platform_get_help.html', 'ignoreSystemStatusError' => true, 'file' => 'clients/mobile/api/CurrentUserMobileApi.php', 'className' => 'CurrentUserMobileApi', 'score' => 9.5, ), ), ), ), ), 'PUT' => array ( 'me' => array ( 'preference' => array ( '?' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'me', 1 => 'preference', 2 => '?', ), 'pathVars' => array ( 0 => '', 1 => '', 2 => 'preference_name', ), 'method' => 'userPreferenceSave', 'shortHelp' => 'Update a specific preference for the current user', 'longHelp' => 'include/api/help/me_preference_preference_name_put_help.html', 'ignoreSystemStatusError' => true, 'file' => 'clients/mobile/api/CurrentUserMobileApi.php', 'className' => 'CurrentUserMobileApi', 'score' => 9.5, ), ), ), 'last_states' => array ( '?' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'me', 1 => 'last_states', 2 => '?', ), 'pathVars' => array ( 0 => '', 1 => '', 2 => 'platform', ), 'method' => 'updateLastStatesByPlatform', 'minVersion' => '11.20', 'shortHelp' => 'Perform an update to the set of last state data for the current user for a platform', 'longHelp' => 'include/api/help/me_last_states_by_platform_put_help.html', 'ignoreSystemStatusError' => true, 'file' => 'clients/mobile/api/CurrentUserMobileApi.php', 'className' => 'CurrentUserMobileApi', 'score' => 9.5, ), ), ), ), ), 'DELETE' => array ( 'me' => array ( 'preference' => array ( '?' => array ( 0 => array ( 'reqType' => 'DELETE', 'path' => array ( 0 => 'me', 1 => 'preference', 2 => '?', ), 'pathVars' => array ( 0 => '', 1 => '', 2 => 'preference_name', ), 'method' => 'userPreferenceDelete', 'shortHelp' => 'Delete a specific preference for the current user', 'longHelp' => 'include/api/help/me_preference_preference_name_delete_help.html', 'ignoreSystemStatusError' => true, 'file' => 'clients/mobile/api/CurrentUserMobileApi.php', 'className' => 'CurrentUserMobileApi', 'score' => 9.5, ), ), ), ), ), ), 'portal' => array ( 'GET' => array ( 'me' => array ( 'preference' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'me', 1 => 'preference', 2 => '?', ), 'pathVars' => array ( 0 => '', 1 => '', 2 => 'preference_name', ), 'method' => 'userPreference', 'shortHelp' => 'Returns a specific preference for the current user', 'longHelp' => 'include/api/help/me_preference_preference_name_get_help.html', 'ignoreSystemStatusError' => true, 'file' => 'clients/portal/api/CurrentUserPortalApi.php', 'className' => 'CurrentUserPortalApi', 'score' => 9.5, ), ), ), 'last_states' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'me', 1 => 'last_states', 2 => '?', ), 'pathVars' => array ( 0 => '', 1 => '', 2 => 'platform', ), 'method' => 'retrieveLastStatesByPlatform', 'minVersion' => '11.20', 'ignoreMetaHash' => true, 'shortHelp' => 'Retrieve the set of last state data for the current user for a specific platform', 'longHelp' => 'include/api/help/me_last_states_by_platform_get_help.html', 'ignoreSystemStatusError' => true, 'file' => 'clients/portal/api/CurrentUserPortalApi.php', 'className' => 'CurrentUserPortalApi', 'score' => 9.5, ), ), ), ), '<module>' => array ( 'filter' => array ( 'count' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', 1 => 'filter', 2 => 'count', ), 'pathVars' => array ( 0 => 'module', 1 => '', 2 => '', ), 'method' => 'getFilterListCount', 'shortHelp' => 'Lists filtered records.', 'longHelp' => 'include/api/help/module_filter_post_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionNotAuthorized', 3 => 'SugarApiExceptionInvalidParameter', ), 'file' => 'clients/portal/api/FilterPortalApi.php', 'className' => 'FilterPortalApi', 'score' => 9.75, ), ), ), ), ), 'POST' => array ( 'me' => array ( 'preference' => array ( '?' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'me', 1 => 'preference', 2 => '?', ), 'pathVars' => array ( 0 => '', 1 => '', 2 => 'preference_name', ), 'method' => 'userPreferenceSave', 'shortHelp' => 'Create a preference for the current user', 'longHelp' => 'include/api/help/me_preference_preference_name_post_help.html', 'ignoreSystemStatusError' => true, 'file' => 'clients/portal/api/CurrentUserPortalApi.php', 'className' => 'CurrentUserPortalApi', 'score' => 9.5, ), ), ), ), '<module>' => array ( 'filter' => array ( 'count' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => '<module>', 1 => 'filter', 2 => 'count', ), 'pathVars' => array ( 0 => 'module', 1 => '', 2 => '', ), 'method' => 'filterListCount', 'shortHelp' => 'Lists filtered records.', 'longHelp' => 'include/api/help/module_filter_post_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionNotAuthorized', 3 => 'SugarApiExceptionInvalidParameter', ), 'file' => 'clients/portal/api/FilterPortalApi.php', 'className' => 'FilterPortalApi', 'score' => 9.75, ), ), ), ), ), 'PUT' => array ( 'me' => array ( 'preference' => array ( '?' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'me', 1 => 'preference', 2 => '?', ), 'pathVars' => array ( 0 => '', 1 => '', 2 => 'preference_name', ), 'method' => 'userPreferenceSave', 'shortHelp' => 'Update a specific preference for the current user', 'longHelp' => 'include/api/help/me_preference_preference_name_put_help.html', 'ignoreSystemStatusError' => true, 'file' => 'clients/portal/api/CurrentUserPortalApi.php', 'className' => 'CurrentUserPortalApi', 'score' => 9.5, ), ), ), 'last_states' => array ( '?' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'me', 1 => 'last_states', 2 => '?', ), 'pathVars' => array ( 0 => '', 1 => '', 2 => 'platform', ), 'method' => 'updateLastStatesByPlatform', 'minVersion' => '11.20', 'shortHelp' => 'Perform an update to the set of last state data for the current user for a platform', 'longHelp' => 'include/api/help/me_last_states_by_platform_put_help.html', 'ignoreSystemStatusError' => true, 'file' => 'clients/portal/api/CurrentUserPortalApi.php', 'className' => 'CurrentUserPortalApi', 'score' => 9.5, ), ), ), ), 'Cases' => array ( '?' => array ( 'request_close' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'Cases', 1 => '?', 2 => 'request_close', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', ), 'method' => 'requestCloseCase', 'shortHelp' => 'This method sets the the case as "requested for closure"', 'longHelp' => 'include/api/help/cases_portal_request_close_help.html', 'file' => 'modules/Cases/clients/portal/api/PortalCasesApi.php', 'className' => 'PortalCasesApi', 'score' => 9.5, ), ), ), ), ), 'DELETE' => array ( 'me' => array ( 'preference' => array ( '?' => array ( 0 => array ( 'reqType' => 'DELETE', 'path' => array ( 0 => 'me', 1 => 'preference', 2 => '?', ), 'pathVars' => array ( 0 => '', 1 => '', 2 => 'preference_name', ), 'method' => 'userPreferenceDelete', 'shortHelp' => 'Delete a specific preference for the current user', 'longHelp' => 'include/api/help/me_preference_preference_name_delete_help.html', 'ignoreSystemStatusError' => true, 'file' => 'clients/portal/api/CurrentUserPortalApi.php', 'className' => 'CurrentUserPortalApi', 'score' => 9.5, ), ), ), ), ), ), ), 2 => array ( 'base' => array ( 'GET' => array ( '<module>' => array ( 'config' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', 1 => 'config', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'config', 'shortHelp' => 'Retrieves the config settings for a given module', 'longHelp' => 'include/api/help/module_config_get_help.html', 'file' => 'clients/base/api/ConfigModuleApi.php', 'className' => 'ConfigModuleApi', 'score' => 8.0, ), 1 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', 1 => 'config', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'config', 'shortHelp' => 'Retrieves the config settings for a given module', 'longHelp' => 'include/api/help/module_config_get_help.html', 'file' => 'modules/KBContents/clients/base/api/KBContentsConfigApi.php', 'className' => 'KBContentsConfigApi', 'score' => 8.0, ), ), 'maps' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', 1 => 'maps', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'filterList', 'jsonParams' => array ( 0 => 'filter', ), 'shortHelp' => 'List of all records in this module', 'longHelp' => 'include/api/help/module_filter_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionInvalidParameter', 3 => 'SugarApiExceptionNotAuthorized', ), 'file' => 'clients/base/api/MapsApi.php', 'className' => 'MapsApi', 'score' => 8.0, ), ), 'filter' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', 1 => 'filter', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'filterList', 'jsonParams' => array ( 0 => 'filter', ), 'shortHelp' => 'Lists filtered records.', 'longHelp' => 'include/api/help/module_filter_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionInvalidParameter', 3 => 'SugarApiExceptionNotAuthorized', ), 'file' => 'clients/base/api/FilterApi.php', 'className' => 'FilterApi', 'score' => 8.0, ), 1 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', 1 => 'filter', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'filterList', 'jsonParams' => array ( 0 => 'filter', ), 'shortHelp' => 'Lists filtered records.', 'longHelp' => 'include/api/help/module_filter_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionInvalidParameter', 3 => 'SugarApiExceptionNotAuthorized', ), 'file' => 'modules/Opportunities/clients/base/api/OpportunitiesFilterApi.php', 'className' => 'OpportunitiesFilterApi', 'score' => 8.0, ), 2 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', 1 => 'filter', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'filterList', 'jsonParams' => array ( 0 => 'filter', ), 'shortHelp' => 'Lists filtered records.', 'longHelp' => 'include/api/help/module_filter_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionInvalidParameter', 3 => 'SugarApiExceptionNotAuthorized', ), 'file' => 'modules/pmse_Project/clients/base/api/PMSEFilterOutboundEmailsApi.php', 'className' => 'PMSEFilterOutboundEmailsApi', 'score' => 8.0, ), 3 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', 1 => 'filter', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'filterList', 'jsonParams' => array ( 0 => 'filter', ), 'shortHelp' => 'Lists filtered records.', 'longHelp' => 'include/api/help/module_filter_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionInvalidParameter', 3 => 'SugarApiExceptionNotAuthorized', ), 'file' => 'modules/Notes/clients/base/api/NotesFilterApi.php', 'className' => 'NotesFilterApi', 'score' => 8.0, ), 4 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', 1 => 'filter', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'filterList', 'jsonParams' => array ( 0 => 'filter', ), 'shortHelp' => 'Lists filtered records.', 'longHelp' => 'include/api/help/module_filter_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionInvalidParameter', 3 => 'SugarApiExceptionNotAuthorized', ), 'file' => 'modules/DataArchiver/clients/base/api/DataArchiverFilterApi.php', 'className' => 'DataArchiverFilterApi', 'score' => 8.0, ), ), 'count' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', 1 => 'count', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'jsonParams' => array ( 0 => 'filter', ), 'method' => 'getFilterListCount', 'shortHelp' => 'List of all records in this module', 'longHelp' => 'include/api/help/module_filter_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionNotAuthorized', 3 => 'SugarApiExceptionInvalidParameter', ), 'file' => 'clients/base/api/FilterApi.php', 'className' => 'FilterApi', 'score' => 8.0, ), 1 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', 1 => 'count', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'jsonParams' => array ( 0 => 'filter', ), 'method' => 'getFilterListCount', 'shortHelp' => 'List of all records in this module', 'longHelp' => 'include/api/help/module_filter_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionNotAuthorized', 3 => 'SugarApiExceptionInvalidParameter', ), 'file' => 'modules/Opportunities/clients/base/api/OpportunitiesFilterApi.php', 'className' => 'OpportunitiesFilterApi', 'score' => 8.0, ), 2 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', 1 => 'count', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'jsonParams' => array ( 0 => 'filter', ), 'method' => 'getFilterListCount', 'shortHelp' => 'List of all records in this module', 'longHelp' => 'include/api/help/module_filter_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionNotAuthorized', 3 => 'SugarApiExceptionInvalidParameter', ), 'file' => 'modules/pmse_Project/clients/base/api/PMSEFilterOutboundEmailsApi.php', 'className' => 'PMSEFilterOutboundEmailsApi', 'score' => 8.0, ), 3 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', 1 => 'count', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'jsonParams' => array ( 0 => 'filter', ), 'method' => 'getFilterListCount', 'shortHelp' => 'List of all records in this module', 'longHelp' => 'include/api/help/module_filter_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionNotAuthorized', 3 => 'SugarApiExceptionInvalidParameter', ), 'file' => 'modules/DataArchiver/clients/base/api/DataArchiverFilterApi.php', 'className' => 'DataArchiverFilterApi', 'score' => 8.0, ), ), 'total' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', 1 => 'total', ), 'pathVars' => array ( 0 => 'module', 1 => '', 2 => '', ), 'method' => 'getFilterListSum', 'shortHelp' => 'Lists field sum by filtered records.', 'longHelp' => 'include/api/help/module_sum_by_filter_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionNotAuthorized', 3 => 'SugarApiExceptionInvalidParameter', ), 'minVersion' => '11.21', 'file' => 'clients/base/api/FilterApi.php', 'className' => 'FilterApi', 'score' => 8.0, ), 1 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', 1 => 'total', ), 'pathVars' => array ( 0 => 'module', 1 => '', 2 => '', ), 'method' => 'getFilterListSum', 'shortHelp' => 'Lists field sum by filtered records.', 'longHelp' => 'include/api/help/module_sum_by_filter_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionNotAuthorized', 3 => 'SugarApiExceptionInvalidParameter', ), 'minVersion' => '11.21', 'file' => 'modules/Opportunities/clients/base/api/OpportunitiesFilterApi.php', 'className' => 'OpportunitiesFilterApi', 'score' => 8.0, ), 2 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', 1 => 'total', ), 'pathVars' => array ( 0 => 'module', 1 => '', 2 => '', ), 'method' => 'getFilterListSum', 'shortHelp' => 'Lists field sum by filtered records.', 'longHelp' => 'include/api/help/module_sum_by_filter_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionNotAuthorized', 3 => 'SugarApiExceptionInvalidParameter', ), 'minVersion' => '11.21', 'file' => 'modules/pmse_Project/clients/base/api/PMSEFilterOutboundEmailsApi.php', 'className' => 'PMSEFilterOutboundEmailsApi', 'score' => 8.0, ), 3 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', 1 => 'total', ), 'pathVars' => array ( 0 => 'module', 1 => '', 2 => '', ), 'method' => 'getFilterListSum', 'shortHelp' => 'Lists field sum by filtered records.', 'longHelp' => 'include/api/help/module_sum_by_filter_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionNotAuthorized', 3 => 'SugarApiExceptionInvalidParameter', ), 'minVersion' => '11.21', 'file' => 'modules/Notes/clients/base/api/NotesFilterApi.php', 'className' => 'NotesFilterApi', 'score' => 8.0, ), 4 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', 1 => 'total', ), 'pathVars' => array ( 0 => 'module', 1 => '', 2 => '', ), 'method' => 'getFilterListSum', 'shortHelp' => 'Lists field sum by filtered records.', 'longHelp' => 'include/api/help/module_sum_by_filter_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionNotAuthorized', 3 => 'SugarApiExceptionInvalidParameter', ), 'minVersion' => '11.21', 'file' => 'modules/DataArchiver/clients/base/api/DataArchiverFilterApi.php', 'className' => 'DataArchiverFilterApi', 'score' => 8.0, ), ), 'sync_key' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', 1 => 'sync_key', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'getByField', 'shortHelp' => 'Retrieve record with given sync_key from the query params.', 'file' => 'clients/base/api/IntegrateApi.php', 'className' => 'IntegrateApi', 'score' => 8.0, ), ), 'globalsearch' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', 1 => 'globalsearch', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'globalSearch', 'shortHelp' => 'Global search', 'longHelp' => 'include/api/help/globalsearch_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotAuthorized', 1 => 'SugarApiExceptionSearchUnavailable', 2 => 'SugarApiExceptionSearchRuntime', ), 'file' => 'clients/base/api/GlobalSearchApi.php', 'className' => 'GlobalSearchApi', 'score' => 8.0, ), ), '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', 1 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', ), 'method' => 'retrieveRecord', 'shortHelp' => 'Returns a single record', 'longHelp' => 'include/api/help/module_record_get_help.html', 'file' => 'clients/base/api/ModuleApi.php', 'className' => 'ModuleApi', 'score' => 7.0, ), ), 'recent-product' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', 1 => 'recent-product', ), 'pathVars' => array ( 0 => 'module', 1 => 'recent-product', ), 'minVersion' => '11.5', 'method' => 'getRecentRecords', 'shortHelp' => 'Get top 10 recently used items in reverse Chronological order', 'longHelp' => 'modules/Opportunities/clients/base/api/help/recent_product_get_help.html', 'file' => 'modules/Opportunities/clients/base/api/RecentProductApi.php', 'className' => 'RecentProductApi', 'score' => 8.0, ), ), 'favorites' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', 1 => 'favorites', ), 'pathVars' => array ( 0 => 'module', 1 => 'favorites', ), 'minVersion' => '11.5', 'method' => 'getFavoriteRecords', 'shortHelp' => 'Get all the favorite items in alphabetical order', 'longHelp' => 'modules/Opportunities/clients/base/api/help/favorites_get_help.html', 'file' => 'modules/Opportunities/clients/base/api/FavoritesApi.php', 'className' => 'FavoritesApi', 'score' => 8.0, ), ), 'Activities' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', 1 => 'Activities', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'getModuleActivities', 'shortHelp' => 'This method retrieves a module\'s activities', 'longHelp' => 'modules/ActivityStream/clients/base/api/help/moduleActivities.html', 'file' => 'modules/ActivityStream/clients/base/api/ActivitiesApi.php', 'className' => 'ActivitiesApi', 'score' => 8.0, ), ), ), 'maps' => array ( 'nearby' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'maps', 1 => 'nearby', ), 'pathVars' => array ( 0 => '', ), 'method' => 'getNearBy', 'shortHelp' => 'Get nearby records based on latitude, longitude and radius', 'longHelp' => 'include/api/help/maps_near_by_get_help.html', 'minVersion' => '11.18', 'file' => 'clients/base/api/MapsApi.php', 'className' => 'MapsApi', 'score' => 8.75, ), ), ), 'collection' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'collection', 1 => '?', ), 'pathVars' => array ( 0 => '', 1 => 'collection_name', ), 'method' => 'getCollection', 'shortHelp' => 'Lists collection records.', 'longHelp' => 'include/api/help/collection_collection_name_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionInvalidParameter', 3 => 'SugarApiExceptionNotAuthorized', ), 'file' => 'clients/base/api/ModuleCollectionApi.php', 'className' => 'ModuleCollectionApi', 'score' => 7.75, ), ), ), 'metadata' => array ( '_hash' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'metadata', 1 => '_hash', ), 'pathVars' => array ( 0 => '', ), 'method' => 'getAllMetadataHash', 'shortHelp' => 'This method will return the hash of all metadata for the system', 'longHelp' => 'include/api/html/metadata_all_help.html', 'ignoreMetaHash' => true, 'ignoreSystemStatusError' => true, 'file' => 'clients/base/api/MetadataApi.php', 'className' => 'MetadataApi', 'score' => 8.75, ), ), 'public' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'metadata', 1 => 'public', ), 'pathVars' => array ( 0 => '', ), 'method' => 'getPublicMetadata', 'shortHelp' => 'This method will return the metadata needed when not logged in', 'longHelp' => 'include/api/html/metadata_all_help.html', 'noLoginRequired' => true, 'noEtag' => true, 'ignoreMetaHash' => true, 'ignoreSystemStatusError' => true, 'file' => 'clients/base/api/MetadataApi.php', 'className' => 'MetadataApi', 'score' => 8.75, ), ), ), 'lang' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'lang', 1 => '?', ), 'pathVars' => array ( 0 => '', 1 => 'lang', ), 'method' => 'getLanguage', 'shortHelp' => 'Returns the labels for the application', 'longHelp' => 'include/api/html/metadata_all_help.html', 'rawReply' => true, 'noEtag' => true, 'ignoreMetaHash' => true, 'ignoreSystemStatusError' => true, 'file' => 'clients/base/api/MetadataApi.php', 'className' => 'MetadataApi', 'score' => 7.75, ), ), ), 'integrate' => array ( '<module>' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'integrate', 1 => '<module>', ), 'pathVars' => array ( 0 => '', 1 => 'module', ), 'method' => 'getByField', 'shortHelp' => 'Retrieve record with given field from the query params.', 'file' => 'clients/base/api/IntegrateApi.php', 'className' => 'IntegrateApi', 'score' => 8.0, ), ), ), 'connector' => array ( 'salesfusion' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'connector', 1 => 'salesfusion', ), 'pathVars' => array ( 0 => '', 1 => '', ), 'method' => 'getOrgName', 'shortHelp' => 'Retrieve SalesFusion Connector Org Name', 'longHelp' => 'include/api/help/connector_salesfusion.html', 'file' => 'clients/base/api/SalesFusionApi.php', 'className' => 'SalesFusionApi', 'score' => 8.75, ), ), ), 'ping' => array ( 'whattimeisit' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'ping', 1 => 'whattimeisit', ), 'pathVars' => array ( 0 => '', 1 => 'sub_method', ), 'method' => 'ping', 'shortHelp' => 'An example API only responds with the current time in server format.', 'longHelp' => 'include/api/help/ping_whattimeisit_get_help.html', 'file' => 'clients/base/api/PingApi.php', 'className' => 'PingApi', 'score' => 8.75, ), ), ), 'password' => array ( 'request' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'password', 1 => 'request', ), 'pathVars' => array ( 0 => 'module', ), 'method' => 'requestPassword', 'shortHelp' => 'This method allows a User who is not logged in to request an email be sent to reset their password', 'longHelp' => 'include/api/help/password_request_get_help.html', 'noLoginRequired' => true, 'ignoreSystemStatusError' => true, 'file' => 'clients/base/api/PasswordApi.php', 'className' => 'PasswordApi', 'score' => 8.75, ), ), ), 'me' => array ( 'preferences' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'me', 1 => 'preferences', ), 'pathVars' => array ( ), 'method' => 'userPreferences', 'shortHelp' => 'Returns all the current user\'s stored preferences', 'longHelp' => 'include/api/help/me_preferences_get_help.html', 'ignoreMetaHash' => true, 'ignoreSystemStatusError' => true, 'file' => 'clients/base/api/CurrentUserApi.php', 'className' => 'CurrentUserApi', 'score' => 8.75, ), ), 'following' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'me', 1 => 'following', ), 'pathVars' => array ( 0 => '', 1 => '', ), 'method' => 'getMyFollowedRecords', 'shortHelp' => 'This method retrieves all followed methods for the user.', 'longHelp' => 'include/api/help/me_getfollowed_help.html', 'ignoreSystemStatusError' => true, 'file' => 'clients/base/api/CurrentUserApi.php', 'className' => 'CurrentUserApi', 'score' => 8.75, ), ), 'last_states' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'me', 1 => 'last_states', ), 'pathVars' => array ( 0 => '', 1 => '', ), 'method' => 'retrieveLastStates', 'ignoreMetaHash' => true, 'shortHelp' => 'Retrieve the set of last state data for the current user', 'longHelp' => 'include/api/help/me_last_states_get_help.html', 'ignoreSystemStatusError' => true, 'file' => 'clients/base/api/CurrentUserApi.php', 'className' => 'CurrentUserApi', 'score' => 8.75, ), ), 'plugins' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'me', 1 => 'plugins', ), 'pathVars' => array ( 0 => '', ), 'method' => 'getPlugins', 'shortHelp' => 'Retrieves a list of all Sugar plugins available for Word, Excel, etc.', 'longHelp' => 'include/api/help/plugins_get_help.html', 'minVersion' => '11.23', 'file' => 'clients/base/api/CurrentUserApi.php', 'className' => 'CurrentUserApi', 'score' => 8.75, ), ), ), 'help' => array ( 'exceptions' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'help', 1 => 'exceptions', ), 'pathVars' => array ( 0 => '', 1 => '', ), 'method' => 'getExceptionsHelp', 'shortHelp' => 'Shows the exceptions thrown by the API', 'longHelp' => 'include/api/help/help_get_exceptions.html', 'rawReply' => true, 'noLoginRequired' => true, 'file' => 'clients/base/api/HelpApi.php', 'className' => 'HelpApi', 'score' => 8.75, ), ), ), 'hint' => array ( 'config' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'hint', 1 => 'config', ), 'pathVars' => array ( 0 => '', ), 'method' => 'readConfig', 'shortHelp' => 'Reads Hint configuration', 'longHelp' => 'include/api/help/hint_config_get_help.html', 'minVersion' => '11.16', 'file' => 'clients/base/api/HintApi.php', 'className' => 'HintApi', 'score' => 8.75, ), ), ), 'stage2' => array ( 'params' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'stage2', 1 => 'params', ), 'pathVars' => array ( 0 => '', ), 'method' => 'getParams', 'shortHelp' => 'Returns different Stage2 information particular for the user', 'longHelp' => 'include/api/help/hint_stage2_params_get_help.html', 'minVersion' => '11.16', 'file' => 'clients/base/api/HintApi.php', 'className' => 'HintApi', 'score' => 8.75, ), ), ), 'CloudDrive' => array ( 'paths' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'CloudDrive', 1 => 'paths', ), 'pathVars' => array ( 0 => 'CloudDrive', 1 => 'paths', ), 'method' => 'getDrivePaths', 'shortHelp' => 'retrieves the drive paths', 'longHelp' => 'include/api/help/cloud_drive_paths.html', 'minVersion' => '11.16', 'file' => 'clients/base/api/CloudDriveApi.php', 'className' => 'CloudDriveApi', 'score' => 8.75, ), ), 'path' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'CloudDrive', 1 => 'path', ), 'pathVars' => array ( 0 => 'CloudDrive', 1 => 'path', ), 'method' => 'getDrivePath', 'shortHelp' => 'retrieves a drive path', 'longHelp' => 'include/api/help/cloud_drive_get_path.html', 'minVersion' => '11.16', 'file' => 'clients/base/api/CloudDriveApi.php', 'className' => 'CloudDriveApi', 'score' => 8.75, ), ), ), 'css' => array ( 'preview' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'css', 1 => 'preview', ), 'pathVars' => array ( 0 => '', 1 => '', ), 'method' => 'previewCSS', 'shortHelp' => 'Compile the css for a platform and a theme just as a preview', 'longHelp' => 'include/api/help/css_preview_get_help.html', 'rawReply' => true, 'file' => 'clients/base/api/ThemeApi.php', 'className' => 'ThemeApi', 'score' => 8.75, ), ), ), 'login' => array ( 'content' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'login', 1 => 'content', ), 'method' => 'getMarketingExtras', 'shortHelp' => 'An API to receive marketing extra URLs', 'longHelp' => 'include/api/help/marketing_extras_get_help.html', 'minVersion' => '11.2', 'maxVersion' => '11.8', 'noLoginRequired' => true, 'file' => 'clients/base/api/MarketingExtrasApi.php', 'className' => 'MarketingExtrasApi', 'score' => 8.75, ), ), 'marketingContentUrl' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'login', 1 => 'marketingContentUrl', ), 'method' => 'getMarketingContentUrl', 'shortHelp' => 'Gets the SugarCRM marketing content URL', 'longHelp' => 'include/api/help/marketing_extras_content_get_help.html', 'noLoginRequired' => true, 'ignoreSystemStatusError' => true, 'minVersion' => '11.9', 'file' => 'clients/base/api/MarketingExtrasApi.php', 'className' => 'MarketingExtrasApi', 'score' => 8.75, ), ), ), 'Calendar' => array ( 'invitee_search' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Calendar', 1 => 'invitee_search', ), 'pathVars' => array ( 0 => '', 1 => '', ), 'method' => 'inviteeSearch', 'shortHelp' => 'This method searches for people to invite to an event', 'longHelp' => 'modules/Calendar/clients/base/api/help/calendar_invitee_search_get_help.html', 'file' => 'modules/Calendar/clients/base/api/CalendarApi.php', 'className' => 'CalendarApi', 'score' => 8.75, ), ), 'usersAndTeams' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Calendar', 1 => 'usersAndTeams', ), 'pathVars' => array ( 0 => '', 1 => '', ), 'method' => 'getUsersAndTeams', 'shortHelp' => 'Get Users And Teams', 'longHelp' => 'modules/Calendar/clients/base/api/help/calendar_getusersandteams_get_help.html', 'minVersion' => '11.14', 'file' => 'modules/Calendar/clients/base/api/CalendarApi.php', 'className' => 'CalendarApi', 'score' => 8.75, ), ), 'modules' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Calendar', 1 => 'modules', ), 'pathVars' => array ( 0 => '', 1 => '', ), 'method' => 'getCalendarModules', 'shortHelp' => 'Get modules with Calendar Configurations', 'longHelp' => 'modules/Calendar/clients/base/api/help/calendar_getcalendarmodules_get_help.html', 'minVersion' => '11.14', 'file' => 'modules/Calendar/clients/base/api/CalendarApi.php', 'className' => 'CalendarApi', 'score' => 8.75, ), ), 'getICalData' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Calendar', 1 => 'getICalData', ), 'pathVars' => array ( 0 => 'module', 1 => 'action', ), 'method' => 'getICalData', 'shortHelp' => 'getICalData', 'longHelp' => 'modules/Calendar/clients/base/api/help/calendar_geticaldata_get_help.html', 'noLoginRequired' => true, 'rawReply' => true, 'minVersion' => '11.14', 'file' => 'modules/Calendar/clients/base/api/CalendarApi.php', 'className' => 'CalendarApi', 'score' => 8.75, ), ), ), 'Administration' => array ( 'packages' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Administration', 1 => 'packages', ), 'pathVars' => array ( 0 => '', ), 'method' => 'getPackages', 'keepSession' => true, 'shortHelp' => 'List uploaded but not installed packages ready to be installed', 'longHelp' => 'include/api/help/administration_packages_list_all_packages_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotAuthorized', ), 'file' => 'modules/Administration/clients/base/api/PackageApiRest.php', 'className' => 'PackageApiRest', 'score' => 8.75, ), ), 'aws' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Administration', 1 => 'aws', ), 'pathVars' => array ( 0 => '', ), 'method' => 'getAWSConfig', 'shortHelp' => 'Gets configuration settings for Amazon Web Services integrations', 'longHelp' => 'include/api/help/administration_get_aws_config_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotAuthorized', ), 'ignoreSystemStatusError' => true, 'maxVersion' => '11.14', 'file' => 'modules/Administration/clients/base/api/AdministrationApi.php', 'className' => 'AdministrationApi', 'score' => 8.75, ), ), 'csp' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Administration', 1 => 'csp', ), 'pathVars' => array ( 0 => '', ), 'method' => 'getCSPSConfig', 'shortHelp' => 'Gets configuration settings for Content Security Policy', 'longHelp' => 'include/api/help/administration_get_csp_setting_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotAuthorized', ), 'ignoreSystemStatusError' => true, 'maxVersion' => '11.14', 'file' => 'modules/Administration/clients/base/api/AdministrationApi.php', 'className' => 'AdministrationApi', 'score' => 8.75, ), ), 'errors' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Administration', 1 => 'errors', ), 'pathVars' => array ( 0 => '', ), 'method' => 'getErrors', 'shortHelp' => 'Get errors', 'longHelp' => 'include/api/help/administration_errors_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotAuthorized', ), 'minVersion' => '11.15', 'file' => 'modules/Administration/clients/base/api/AdministrationApi.php', 'className' => 'AdministrationApi', 'score' => 8.75, ), ), 'portalmodules' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Administration', 1 => 'portalmodules', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'getPortalModules', 'shortHelp' => 'This method returns the modules currently enabled in Portal Settings', 'longHelp' => 'include/api/help/administration_get_portal_modules.html', 'minVersion' => '11.13', 'file' => 'modules/Administration/clients/base/api/AdministrationApi.php', 'className' => 'AdministrationApi', 'score' => 8.75, ), ), 'adminPanelDefs' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Administration', 1 => 'adminPanelDefs', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'getAdminPanelDefs', 'shortHelp' => 'Get metadata for Admin Panels', 'longHelp' => 'include/api/help/administration_get_admin_panel_defs.html', 'minVersion' => '11.15', 'file' => 'modules/Administration/clients/base/api/AdministrationApi.php', 'className' => 'AdministrationApi', 'score' => 8.75, ), ), '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Administration', 1 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', ), 'method' => 'retrieveRecord', 'file' => 'modules/Administration/clients/base/api/AdministrationApi.php', 'className' => 'AdministrationApi', 'score' => 7.75, ), ), ), 'Quotes' => array ( 'config' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Quotes', 1 => 'config', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'minVersion' => '11.3', 'method' => 'config', 'shortHelp' => 'Retrieves the config settings for a given module', 'longHelp' => 'modules/Quotes/clients/base/api/help/quotes_module_config_get_help.html', 'file' => 'modules/Quotes/clients/base/api/QuotesConfigApi.php', 'className' => 'QuotesConfigApi', 'score' => 8.75, ), ), ), 'DRI_Workflows' => array ( 'graceperiod-remaining-days' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'DRI_Workflows', 1 => 'graceperiod-remaining-days', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', ), 'method' => 'getGracePeriodRemainingDays', 'shortHelp' => 'Provide grace period remaining days', 'longHelp' => '/include/api/help/customer_journeyDRI_WorkflowsgetGracePeriodRemainingDays.html', 'minVersion' => '11.19', 'file' => 'modules/DRI_Workflows/clients/base/api/DRI_WorkflowsApi.php', 'className' => 'DRI_WorkflowsApi', 'score' => 8.75, ), ), ), 'KBContents' => array ( 'filter' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'KBContents', 1 => 'filter', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'filterList', 'jsonParams' => array ( 0 => 'filter', ), 'shortHelp' => 'Lists filtered records.', 'longHelp' => 'include/api/help/module_filter_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionInvalidParameter', 3 => 'SugarApiExceptionNotAuthorized', ), 'file' => 'modules/KBContents/clients/base/api/KBContentsFilterApi.php', 'className' => 'KBContentsFilterApi', 'score' => 8.75, ), ), ), 'CJ_Forms' => array ( 'available-modules' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'CJ_Forms', 1 => 'available-modules', ), 'pathVars' => array ( 0 => 'module', ), 'method' => 'getTemplateAvailableModules', 'shortHelp' => 'Get modules for which template is enabled', 'longHelp' => '/include/api/help/customer_journeyCJ_FormsgetTemplateAvailableModules.html', 'minVersion' => '11.19', 'file' => 'modules/CJ_Forms/clients/base/api/CJ_FormsApi.php', 'className' => 'CJ_FormsApi', 'score' => 8.75, ), ), ), 'ForecastManagerWorksheets' => array ( 'export' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'ForecastManagerWorksheets', 1 => 'export', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'export', 'rawReply' => true, 'allowDownloadCookie' => true, 'shortHelp' => 'Returns a record set in CSV format along with HTTP headers to indicate content type.', 'longHelp' => 'include/api/help/module_export_get_help.html', 'file' => 'modules/ForecastManagerWorksheets/clients/base/api/ForecastManagerWorksheetsExportApi.php', 'className' => 'ForecastManagerWorksheetsExportApi', 'score' => 8.75, ), ), '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'ForecastManagerWorksheets', 1 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'timeperiod_id', ), 'method' => 'ForecastManagerWorksheetsGet', 'jsonParams' => array ( ), 'shortHelp' => 'Filter records from a single module', 'longHelp' => 'modules/Forecasts/clients/base/api/help/ForecastManagerWorksheetGet.html', 'exceptions' => array ( 0 => 'SugarApiExceptionError', 1 => 'SugarApiExceptionInvalidParameter', 2 => 'SugarApiExceptionNotFound', ), 'file' => 'modules/ForecastManagerWorksheets/clients/base/api/ForecastManagerWorksheetsFilterApi.php', 'className' => 'ForecastManagerWorksheetsFilterApi', 'score' => 7.75, ), ), 'chart' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'ForecastManagerWorksheets', 1 => 'chart', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'forecastManagerWorksheetsChartGet', 'jsonParams' => array ( ), 'shortHelp' => 'Filter records and reformat data for chart presentation', 'longHelp' => 'modules/Forecasts/clients/base/api/help/forecastManagerWorksheetsChartGet.html', 'exceptions' => array ( 0 => 'SugarApiExceptionError', 1 => 'SugarApiExceptionInvalidParameter', 2 => 'SugarApiExceptionNotFound', ), 'file' => 'modules/ForecastManagerWorksheets/clients/base/api/ForecastManagerWorksheetsFilterApi.php', 'className' => 'ForecastManagerWorksheetsFilterApi', 'score' => 8.75, ), ), 'filter' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'ForecastManagerWorksheets', 1 => 'filter', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'filterList', 'jsonParams' => array ( 0 => 'filter', ), 'shortHelp' => 'Filter records from a single module', 'longHelp' => 'modules/Forecasts/clients/base/api/help/ForecastManagerWorksheetFilter.html', 'exceptions' => array ( 0 => 'SugarApiExceptionError', 1 => 'SugarApiExceptionInvalidParameter', 2 => 'SugarApiExceptionNotFound', ), 'file' => 'modules/ForecastManagerWorksheets/clients/base/api/ForecastManagerWorksheetsFilterApi.php', 'className' => 'ForecastManagerWorksheetsFilterApi', 'score' => 8.75, ), ), ), 'TimePeriods' => array ( 'filter' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'TimePeriods', 1 => 'filter', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'filterList', 'jsonParams' => array ( 0 => 'filter', ), 'shortHelp' => 'Lists filtered records.', 'longHelp' => 'include/api/help/module_filter_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionInvalidParameter', 3 => 'SugarApiExceptionNotAuthorized', ), 'file' => 'modules/TimePeriods/clients/base/api/TimePeriodsFilterApi.php', 'className' => 'TimePeriodsFilterApi', 'score' => 8.75, ), ), 'current' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'TimePeriods', 1 => 'current', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'getCurrentTimePeriod', 'jsonParams' => array ( ), 'shortHelp' => 'Return the Current Timeperiod', 'longHelp' => 'modules/TimePeriods/clients/base/api/help/TimePeriodsCurrentApi.html', 'file' => 'modules/TimePeriods/clients/base/api/TimePeriodsCurrentApi.php', 'className' => 'TimePeriodsCurrentApi', 'score' => 8.75, ), ), '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'TimePeriods', 1 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'date', ), 'method' => 'getTimePeriodByDate', 'jsonParams' => array ( ), 'shortHelp' => 'Return a Timeperiod by a given date', 'longHelp' => 'modules/TimePeriods/clients/base/api/help/TimePeriodsGetByDateApi.html', 'file' => 'modules/TimePeriods/clients/base/api/TimePeriodsCurrentApi.php', 'className' => 'TimePeriodsCurrentApi', 'score' => 7.75, ), ), ), 'Mail' => array ( 'outboundEmails' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Mail', 1 => 'outboundEmails', ), 'pathVars' => array ( 0 => '', ), 'method' => 'getOutboundEmails', 'shortHelp' => 'Find the outbound emails current user can use', 'longHelp' => 'modules/Emails/clients/base/api/help/mail_outboundEmails_get.html', 'file' => 'modules/Emails/clients/base/api/MailApi.php', 'className' => 'MailApi', 'score' => 8.75, ), ), 'findByEmail' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Mail', 1 => 'findByEmail', ), 'pathVars' => array ( 0 => '', ), 'method' => 'findByEmail', 'shortHelp' => 'Find the email by email address', 'longHelp' => 'modules/Emails/clients/base/api/help/mail_findByEmail_get.html', 'file' => 'modules/Emails/clients/base/api/MailApi.php', 'className' => 'MailApi', 'score' => 8.75, ), ), ), 'Emails' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Emails', 1 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', ), 'method' => 'retrieveRecord', 'shortHelp' => 'Returns a single Emails record', 'longHelp' => 'modules/Emails/clients/base/api/help/emails_record_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionMissingParameter', 1 => 'SugarApiExceptionNotAuthorized', 2 => 'SugarApiExceptionNotFound', ), 'file' => 'modules/Emails/clients/base/api/EmailsApi.php', 'className' => 'EmailsApi', 'score' => 7.75, ), ), 'filter' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Emails', 1 => 'filter', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'filterList', 'jsonParams' => array ( 0 => 'filter', ), 'shortHelp' => 'Lists filtered records.', 'longHelp' => 'modules/Emails/clients/base/api/help/emails_filter_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionInvalidParameter', 3 => 'SugarApiExceptionNotAuthorized', ), 'file' => 'modules/Emails/clients/base/api/EmailsFilterApi.php', 'className' => 'EmailsFilterApi', 'score' => 8.75, ), ), 'count' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Emails', 1 => 'count', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'jsonParams' => array ( 0 => 'filter', ), 'method' => 'getFilterListCount', 'shortHelp' => 'List of all records in this module', 'longHelp' => 'modules/Emails/clients/base/api/help/emails_filter_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionNotAuthorized', 3 => 'SugarApiExceptionInvalidParameter', ), 'file' => 'modules/Emails/clients/base/api/EmailsFilterApi.php', 'className' => 'EmailsFilterApi', 'score' => 8.75, ), ), 'total' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Emails', 1 => 'total', ), 'pathVars' => array ( 0 => 'module', 1 => '', 2 => '', ), 'method' => 'getFilterListSum', 'shortHelp' => 'Lists field sum by filtered records.', 'longHelp' => 'include/api/help/module_sum_by_filter_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionNotAuthorized', 3 => 'SugarApiExceptionInvalidParameter', ), 'minVersion' => '11.21', 'file' => 'modules/Emails/clients/base/api/EmailsFilterApi.php', 'className' => 'EmailsFilterApi', 'score' => 8.75, ), ), ), 'Dashboards' => array ( '<module>' => array ( 0 => array ( 'reqType' => 'GET', 'minVersion' => '10', 'maxVersion' => '10', 'path' => array ( 0 => 'Dashboards', 1 => '<module>', ), 'pathVars' => array ( 0 => '', 1 => 'module', ), 'method' => 'getDashboards', 'shortHelp' => 'Get dashboards for a module', 'longHelp' => 'include/api/help/get_dashboards.html', 'cacheEtag' => true, 'exceptions' => array ( 0 => 'SugarApiExceptionInvalidParameter', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionNotAuthorized', ), 'file' => 'modules/Dashboards/clients/base/api/DashboardListApi.php', 'className' => 'DashboardListApi', 'score' => 8.0, ), ), 'Activities' => array ( 0 => array ( 'reqType' => 'GET', 'minVersion' => '10', 'maxVersion' => '10', 'path' => array ( 0 => 'Dashboards', 1 => 'Activities', ), 'pathVars' => array ( 0 => '', 1 => 'module', ), 'method' => 'getDashboards', 'shortHelp' => 'Get dashboards for activity stream', 'longHelp' => 'include/api/help/get_activities_dashboards.html', 'cacheEtag' => true, 'exceptions' => array ( 0 => 'SugarApiExceptionInvalidParameter', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionNotAuthorized', ), 'file' => 'modules/Dashboards/clients/base/api/DashboardListApi.php', 'className' => 'DashboardListApi', 'score' => 8.75, ), ), 'count' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Dashboards', 1 => 'count', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'jsonParams' => array ( 0 => 'filter', ), 'method' => 'getFilterListCount', 'minVersion' => '11.24', 'shortHelp' => 'Counts all filtered dashboards', 'longHelp' => 'include/api/help/dashboards_filter_count_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionNotAuthorized', 3 => 'SugarApiExceptionInvalidParameter', ), 'file' => 'modules/Dashboards/clients/base/api/DashboardListApi.php', 'className' => 'DashboardListApi', 'score' => 8.75, ), 1 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Dashboards', 1 => 'count', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'jsonParams' => array ( 0 => 'filter', ), 'method' => 'getFilterListCount', 'shortHelp' => 'List of all records in this module', 'longHelp' => 'include/api/help/module_filter_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionNotAuthorized', 3 => 'SugarApiExceptionInvalidParameter', ), 'file' => 'modules/Dashboards/clients/base/api/DashboardsFilterApi.php', 'className' => 'DashboardsFilterApi', 'score' => 8.75, ), ), 'filter' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Dashboards', 1 => 'filter', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'filterList', 'jsonParams' => array ( 0 => 'filter', ), 'shortHelp' => 'Lists filtered records.', 'longHelp' => 'include/api/help/module_filter_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionInvalidParameter', 3 => 'SugarApiExceptionNotAuthorized', ), 'file' => 'modules/Dashboards/clients/base/api/DashboardsFilterApi.php', 'className' => 'DashboardsFilterApi', 'score' => 8.75, ), ), 'total' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Dashboards', 1 => 'total', ), 'pathVars' => array ( 0 => 'module', 1 => '', 2 => '', ), 'method' => 'getFilterListSum', 'shortHelp' => 'Lists field sum by filtered records.', 'longHelp' => 'include/api/help/module_sum_by_filter_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionNotAuthorized', 3 => 'SugarApiExceptionInvalidParameter', ), 'minVersion' => '11.21', 'file' => 'modules/Dashboards/clients/base/api/DashboardsFilterApi.php', 'className' => 'DashboardsFilterApi', 'score' => 8.75, ), ), ), 'EAPM' => array ( 'auth' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'EAPM', 1 => 'auth', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'getAuthInfo', 'shortHelp' => 'Get auth info for an application', 'longHelp' => 'include/api/help/module_get_help.html', 'file' => 'modules/EAPM/clients/base/api/AuthApi.php', 'className' => 'AuthApi', 'score' => 8.75, ), ), 'list' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'EAPM', 1 => 'list', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'getFullAPIList', 'minVersion' => '11.23', 'shortHelp' => 'Get full API list for the application', 'longHelp' => 'include/api/help/eapm_list.html', 'file' => 'modules/EAPM/clients/base/api/AuthApi.php', 'className' => 'AuthApi', 'score' => 8.75, ), ), 'test' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'EAPM', 1 => 'test', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'testConnection', 'shortHelp' => 'This method tests if the service is available', 'longHelp' => 'include/api/help/eapm_test_connection_get_help.html', 'minVersion' => '11.26', 'file' => 'modules/EAPM/clients/base/api/AuthApi.php', 'className' => 'AuthApi', 'score' => 8.75, ), ), ), 'Metrics' => array ( 'visible' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Metrics', 1 => 'visible', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'getVisibleMetrics', 'shortHelp' => 'This method will return all metrics user has configured as visible.', 'minVersion' => '11.18', 'file' => 'modules/Metrics/clients/base/api/MetricsApi.php', 'className' => 'MetricsApi', 'score' => 8.75, ), ), 'hidden' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Metrics', 1 => 'hidden', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'getHiddenMetrics', 'shortHelp' => 'This method will return all metrics user hide.', 'minVersion' => '11.18', 'file' => 'modules/Metrics/clients/base/api/MetricsApi.php', 'className' => 'MetricsApi', 'score' => 8.75, ), ), 'restore-defaults' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Metrics', 1 => 'restore-defaults', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'restoreAdminDefaults', 'shortHelp' => 'This method will return metrics.', 'minVersion' => '11.18', 'file' => 'modules/Metrics/clients/base/api/MetricsApi.php', 'className' => 'MetricsApi', 'score' => 8.75, ), ), ), 'ConsoleConfiguration' => array ( 'default-metadata' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'ConsoleConfiguration', 1 => 'default-metadata', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'getDefaultMetadata', 'shortHelp' => 'This method will return the original metadata for the module.', 'longHelp' => 'modules/ConsoleConfiguration/clients/base/api/help/default_metadata.html', 'minVersion' => '11.9', 'file' => 'modules/ConsoleConfiguration/clients/base/api/ConsoleConfigDefaultMetaDataApi.php', 'className' => 'ConsoleConfigDefaultMetaDataApi', 'score' => 8.75, ), ), ), 'Meetings' => array ( 'Agenda' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Meetings', 1 => 'Agenda', ), 'pathVars' => array ( 0 => '', 1 => '', ), 'method' => 'getAgenda', 'shortHelp' => 'Fetch an agenda for a user', 'longHelp' => 'include/api/html/meetings_agenda_get_help', 'file' => 'modules/Meetings/clients/base/api/MeetingsApi.php', 'className' => 'MeetingsApi', 'score' => 8.75, ), ), ), 'Activities' => array ( 'filter' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Activities', 1 => 'filter', ), 'pathVars' => array ( 0 => '', ), 'method' => 'getHomeActivities', 'shortHelp' => 'This method gets a filtered list of homepage activities for a user', 'longHelp' => 'modules/ActivityStream/clients/base/api/help/homeActivities.html', 'file' => 'modules/ActivityStream/clients/base/api/ActivitiesApi.php', 'className' => 'ActivitiesApi', 'score' => 8.75, ), ), ), 'DocuSign' => array ( 'sendReturn' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'DocuSign', 1 => 'sendReturn', ), 'pathVars' => array ( 0 => '', 1 => '', ), 'method' => 'sendReturn', 'shortHelp' => 'This method will be called when DocuSign tab completes', 'longHelp' => 'modules/DocuSignEnvelopes/clients/base/api/help/docusignenvelopes_send_return_get_help.html', 'noLoginRequired' => true, 'rawReply' => true, 'minVersion' => '11.16', 'file' => 'modules/DocuSignEnvelopes/clients/base/api/DocuSignApi.php', 'className' => 'DocuSignApi', 'score' => 8.75, ), ), 'loadPage' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'DocuSign', 1 => 'loadPage', ), 'pathVars' => array ( 0 => '', 1 => '', ), 'method' => 'docusignLoadPage', 'shortHelp' => 'Page given until DocuSign is loaded', 'longHelp' => 'modules/DocuSignEnvelopes/clients/base/api/help/docusignenvelopes_docusign_load_page_get_help.html', 'noLoginRequired' => true, 'rawReply' => true, 'minVersion' => '11.16', 'file' => 'modules/DocuSignEnvelopes/clients/base/api/DocuSignApi.php', 'className' => 'DocuSignApi', 'score' => 8.75, ), ), 'downloadDocument' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'DocuSign', 1 => 'downloadDocument', ), 'pathVars' => array ( 0 => '', 1 => '', ), 'method' => 'downloadDocumentGet', 'shortHelp' => 'Download combined documents', 'longHelp' => 'modules/DocuSignEnvelopes/clients/base/api/help/docusignenvelopes_download_document_get_help.html', 'rawReply' => true, 'noLoginRequired' => true, 'minVersion' => '11.16', 'file' => 'modules/DocuSignEnvelopes/clients/base/api/DocuSignApi.php', 'className' => 'DocuSignApi', 'score' => 8.75, ), ), 'checkEAPM' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'DocuSign', 1 => 'checkEAPM', ), 'pathVars' => array ( 0 => '', 1 => '', ), 'method' => 'checkEAPM', 'shortHelp' => 'Check if user has DocuSign EAPM bean', 'longHelp' => 'modules/DocuSignEnvelopes/clients/base/api/help/docusignenvelopes_checkeapm_get_help.html', 'minVersion' => '11.16', 'file' => 'modules/DocuSignEnvelopes/clients/base/api/DocuSignApi.php', 'className' => 'DocuSignApi', 'score' => 8.75, ), ), 'getGlobalConfig' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'DocuSign', 1 => 'getGlobalConfig', ), 'pathVars' => array ( 0 => '', 1 => '', ), 'method' => 'getGlobalConfig', 'shortHelp' => 'Get global configs', 'longHelp' => 'modules/DocuSignEnvelopes/clients/base/api/help/docusignenvelopes_getGlobalConfig_get_help.html', 'minVersion' => '11.18', 'file' => 'modules/DocuSignEnvelopes/clients/base/api/DocuSignApi.php', 'className' => 'DocuSignApi', 'score' => 8.75, ), ), 'getListOfPossibleRecipients' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'DocuSign', 1 => 'getListOfPossibleRecipients', ), 'pathVars' => array ( 0 => '', 1 => '', ), 'method' => 'getListOfPossibleRecipients', 'shortHelp' => 'Returns a list of possible recipients', 'longHelp' => 'modules/DocuSignEnvelopes/clients/base/api/help/docusignenvelopes_listPossibleRecipients_get_help.html', 'minVersion' => '11.18', 'file' => 'modules/DocuSignEnvelopes/clients/base/api/DocuSignApi.php', 'className' => 'DocuSignApi', 'score' => 8.75, ), ), 'listTemplates' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'DocuSign', 1 => 'listTemplates', ), 'pathVars' => array ( 0 => '', 1 => '', ), 'method' => 'listTemplates', 'shortHelp' => 'Fetch user templates from DocuSign', 'longHelp' => 'modules/DocuSignEnvelopes/clients/base/api/help/docusignenvelopes_list_templates_get_help.html', 'minVersion' => '11.18', 'file' => 'modules/DocuSignEnvelopes/clients/base/api/DocuSignApi.php', 'className' => 'DocuSignApi', 'score' => 8.75, ), ), ), 'CommentLog' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'CommentLog', 1 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', ), 'method' => 'retrieveRecord', 'shortHelp' => 'Returns a single parent record of the given commentlog', 'longHelp' => 'include/api/help/module_record_get_help.html', 'file' => 'modules/CommentLog/clients/base/api/CommentLogApi.php', 'className' => 'CommentLogApi', 'score' => 7.75, ), ), ), 'OutboundEmailConfiguration' => array ( 'list' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'OutboundEmailConfiguration', 1 => 'list', ), 'pathVars' => array ( 0 => '', 1 => '', ), 'method' => 'listConfigurations', 'shortHelp' => 'A list of outbound email configurations', 'longHelp' => 'modules/OutboundEmailConfiguration/clients/base/api/help/outbound_email_configuration_list_get_help.html', 'file' => 'modules/OutboundEmailConfiguration/clients/base/api/OutboundEmailConfigurationApi.php', 'className' => 'OutboundEmailConfigurationApi', 'score' => 8.75, ), ), ), 'PubSub_ModuleEvent_PushSubs' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'PubSub_ModuleEvent_PushSubs', 1 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', ), 'method' => 'retrieveRecord', 'minVersion' => '11.20', 'file' => 'modules/PubSub_ModuleEvent_PushSubs/clients/base/api/PubSub_ModuleEvent_PushSubsApi.php', 'className' => 'PubSub_ModuleEvent_PushSubsApi', 'score' => 7.75, ), ), ), 'ProductTemplates' => array ( 'tree' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'ProductTemplates', 1 => 'tree', ), 'pathVars' => array ( 0 => 'module', 1 => 'type', ), 'method' => 'getTemplateTree', 'shortHelp' => 'Returns a filterable tree structure of all Product Templates and Product Categories', 'longHelp' => 'modules/ProductTemplates/clients/base/api/help/tree.html', 'file' => 'modules/ProductTemplates/clients/base/api/ProductTemplateTreeApi.php', 'className' => 'ProductTemplateTreeApi', 'score' => 8.75, ), ), ), 'Users' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Users', 1 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', ), 'method' => 'retrieveRecord', 'shortHelp' => 'Returns a single record', 'longHelp' => 'include/api/help/module_record_get_help.html', 'file' => 'modules/Users/clients/base/api/UsersApi.php', 'className' => 'UsersApi', 'score' => 7.75, ), ), ), 'Notes' => array ( 'count' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Notes', 1 => 'count', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'jsonParams' => array ( 0 => 'filter', ), 'method' => 'getFilterListCount', 'shortHelp' => 'List of all records in this module', 'longHelp' => 'include/api/help/module_filter_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionNotAuthorized', 3 => 'SugarApiExceptionInvalidParameter', ), 'file' => 'modules/Notes/clients/base/api/NotesFilterApi.php', 'className' => 'NotesFilterApi', 'score' => 8.75, ), ), ), 'RevenueLineItems' => array ( 'by_country' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'RevenueLineItems', 1 => 'by_country', ), 'pathVars' => array ( 0 => 'module', 1 => '', 2 => '', ), 'method' => 'salesByCountry', 'shortHelp' => 'Get opportunities won by country', 'longHelp' => '', 'file' => 'modules/RevenueLineItems/clients/base/api/RevenueLineItemsGlobeChartApi.php', 'className' => 'RevenueLineItemsGlobeChartApi', 'score' => 8.75, ), ), ), 'ForecastWorksheets' => array ( 'export' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'ForecastWorksheets', 1 => 'export', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'export', 'rawReply' => true, 'allowDownloadCookie' => true, 'shortHelp' => 'Returns a record set in CSV format along with HTTP headers to indicate content type.', 'longHelp' => 'include/api/help/module_export_get_help.html', 'file' => 'modules/ForecastWorksheets/clients/base/api/ForecastWorksheetsExportApi.php', 'className' => 'ForecastWorksheetsExportApi', 'score' => 8.75, ), ), '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'ForecastWorksheets', 1 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'timeperiod_id', ), 'method' => 'forecastWorksheetsGet', 'jsonParams' => array ( ), 'shortHelp' => 'Filter records from a single module', 'longHelp' => 'modules/Forecasts/clients/base/api/help/ForecastWorksheetGet.html', 'exceptions' => array ( 0 => 'SugarApiExceptionError', 1 => 'SugarApiExceptionInvalidParameter', 2 => 'SugarApiExceptionNotAuthorized', 3 => 'SugarApiExceptionNotFound', ), 'file' => 'modules/ForecastWorksheets/clients/base/api/ForecastWorksheetsFilterApi.php', 'className' => 'ForecastWorksheetsFilterApi', 'score' => 7.75, ), ), 'chart' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'ForecastWorksheets', 1 => 'chart', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'forecastWorksheetsChartGet', 'jsonParams' => array ( ), 'shortHelp' => 'Filter records and reformat data for chart presentation', 'longHelp' => 'modules/Forecasts/clients/base/api/help/ForecastsWorksheetChartGet.html', 'exceptions' => array ( 0 => 'SugarApiExceptionError', 1 => 'SugarApiExceptionInvalidParameter', 2 => 'SugarApiExceptionNotAuthorized', 3 => 'SugarApiExceptionNotFound', ), 'file' => 'modules/ForecastWorksheets/clients/base/api/ForecastWorksheetsFilterApi.php', 'className' => 'ForecastWorksheetsFilterApi', 'score' => 8.75, ), ), 'filter' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'ForecastWorksheets', 1 => 'filter', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'forecastWorksheetsGet', 'jsonParams' => array ( 0 => 'filter', ), 'shortHelp' => 'Filter records from a single module', 'longHelp' => 'modules/Forecasts/clients/base/api/help/ForecastWorksheetFilter.html', 'exceptions' => array ( 0 => 'SugarApiExceptionError', 1 => 'SugarApiExceptionInvalidParameter', 2 => 'SugarApiExceptionNotAuthorized', 3 => 'SugarApiExceptionNotFound', ), 'file' => 'modules/ForecastWorksheets/clients/base/api/ForecastWorksheetsFilterApi.php', 'className' => 'ForecastWorksheetsFilterApi', 'score' => 8.75, ), ), ), 'Forecasts' => array ( 'filter' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Forecasts', 1 => 'filter', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'filterList', 'jsonParams' => array ( 0 => 'filter', ), 'shortHelp' => 'Filter records from a single module', 'longHelp' => 'modules/Forecasts/clients/base/api/help/ForecastsFilter.html', 'exceptions' => array ( 0 => 'SugarApiExceptionError', 1 => 'SugarApiExceptionInvalidParameter', 2 => 'SugarApiExceptionNotAuthorized', 3 => 'SugarApiExceptionNotFound', ), 'file' => 'modules/Forecasts/clients/base/api/ForecastsFilterApi.php', 'className' => 'ForecastsFilterApi', 'score' => 8.75, ), ), 'config' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Forecasts', 1 => 'config', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'config', 'shortHelp' => 'Retrieves the config settings for a given module', 'longHelp' => 'include/api/help/config_get_help.html', 'file' => 'modules/Forecasts/clients/base/api/ForecastsConfigApi.php', 'className' => 'ForecastsConfigApi', 'score' => 8.75, ), ), 'init' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Forecasts', 1 => 'init', ), 'pathVars' => array ( ), 'method' => 'forecastsInitialization', 'shortHelp' => 'Returns forecasts initialization data and additional user data', 'longHelp' => 'modules/Forecasts/clients/base/api/help/ForecastsApiInitGet.html', 'file' => 'modules/Forecasts/clients/base/api/ForecastsApi.php', 'className' => 'ForecastsApi', 'score' => 8.75, ), ), ), 'forecastOpportunities' => array ( 'count' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'forecastOpportunities', 1 => 'count', ), 'pathVars' => array ( ), 'method' => 'getForecastOpportunitiesCount', 'shortHelp' => 'Gets a count of Opportunities in the requested Forecast', 'longHelp' => 'modules/Forecasts/clients/base/api/help/ForecastOpportunityCountAPI.html', 'file' => 'modules/Forecasts/clients/base/api/ForecastsOpportunityApi.php', 'className' => 'ForecastsOpportunityApi', 'score' => 8.75, ), ), ), 'Reports' => array ( 'saved_reports' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Reports', 1 => 'saved_reports', ), 'pathVars' => array ( 0 => '', 1 => '', ), 'method' => 'getSavedReports', 'shortHelp' => 'Returns items from the saved_reports table based on a few criteria', 'longHelp' => 'modules/Reports/clients/base/api/help/ReportsDashletApiGetSavedReports.html', 'file' => 'modules/Reports/clients/base/api/ReportsDashletsApi.php', 'className' => 'ReportsDashletsApi', 'score' => 8.75, ), ), ), 'pmse_Inbox' => array ( 'filter' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'pmse_Inbox', 1 => 'filter', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'filterList', 'jsonParams' => array ( 0 => 'filter', ), 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionInvalidParameter', 3 => 'SugarApiExceptionNotAuthorized', ), 'shortHelp' => 'Returns a list of Processes by user', 'longHelp' => 'modules/pmse_Inbox/clients/base/api/help/process_filter_list_help.html', 'file' => 'modules/pmse_Inbox/clients/base/api/PMSEEngineFilterApi.php', 'className' => 'PMSEEngineFilterApi', 'score' => 8.75, ), ), 'count' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'pmse_Inbox', 1 => 'count', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'jsonParams' => array ( 0 => 'filter', ), 'method' => 'filterListCount', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionNotAuthorized', ), 'file' => 'modules/pmse_Inbox/clients/base/api/PMSEEngineFilterApi.php', 'className' => 'PMSEEngineFilterApi', 'score' => 8.75, ), ), 'casesList' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'pmse_Inbox', 1 => 'casesList', ), 'pathVars' => array ( 0 => 'module', 1 => 'casesList', ), 'method' => 'selectCasesList', 'jsonParams' => array ( 0 => 'filter', ), 'acl' => 'adminOrDev', 'shortHelp' => 'Returns a list with the processes for Process Management', 'longHelp' => 'modules/pmse_Inbox/clients/base/api/help/process_select_cases_list_help.html', 'file' => 'modules/pmse_Inbox/clients/base/api/PMSECasesListApi.php', 'className' => 'PMSECasesListApi', 'score' => 8.75, ), ), 'getLog' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'pmse_Inbox', 1 => 'getLog', ), 'pathVars' => array ( 0 => 'module', 1 => 'getLog', ), 'method' => 'selectLogLoad', 'jsonParams' => array ( ), 'acl' => 'adminOrDev', 'shortHelp' => 'Return the text of the PMSE.log file', 'longHelp' => 'modules/pmse_Inbox/clients/base/api/help/process_select_log_load_help.html', 'file' => 'modules/pmse_Inbox/clients/base/api/PMSECasesListApi.php', 'className' => 'PMSECasesListApi', 'score' => 8.75, ), ), 'logGetConfig' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'pmse_Inbox', 1 => 'logGetConfig', ), 'pathVars' => array ( 0 => 'module', 1 => 'logGetConfig', ), 'method' => 'configLogLoad', 'jsonParams' => array ( ), 'acl' => 'adminOrDev', 'file' => 'modules/pmse_Inbox/clients/base/api/PMSECasesListApi.php', 'className' => 'PMSECasesListApi', 'score' => 8.75, ), ), 'unattendedCases' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'pmse_Inbox', 1 => 'unattendedCases', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'getUnattendedCases', 'keepSession' => true, 'acl' => 'adminOrDev', 'shortHelp' => 'Retrieves the processes to show on Unattended Process view', 'longHelp' => 'modules/pmse_Inbox/clients/base/api/help/process_get_unattended_cases_help.html', 'file' => 'modules/pmse_Inbox/clients/base/api/PMSEEngineApi.php', 'className' => 'PMSEEngineApi', 'score' => 8.75, ), ), 'settings' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'pmse_Inbox', 1 => 'settings', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'getSettingsEngine', 'keepSession' => true, 'acl' => 'adminOrDev', 'shortHelp' => 'Retrieve settings for the PA engine', 'longHelp' => 'modules/pmse_Inbox/clients/base/api/help/process_get_settings_engine_help.html', 'file' => 'modules/pmse_Inbox/clients/base/api/PMSEEngineApi.php', 'className' => 'PMSEEngineApi', 'score' => 8.75, ), ), ), 'DRI_Workflow_Task_Templates' => array ( 'available-modules' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'DRI_Workflow_Task_Templates', 1 => 'available-modules', ), 'pathVars' => array ( 0 => 'module', ), 'method' => 'getTemplateAvailableModules', 'shortHelp' => 'Get modules for which template is enabled ', 'longHelp' => '/include/api/help/customer_journeyTask_TemplatesgetTemplateModules.html', 'minVersion' => '11.19', 'file' => 'modules/DRI_Workflow_Task_Templates/clients/base/api/DRI_Workflow_Task_TemplatesApi.php', 'className' => 'DRI_Workflow_Task_TemplatesApi', 'score' => 8.75, ), ), ), 'PdfManager' => array ( 'generate' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'PdfManager', 1 => 'generate', ), 'pathVars' => array ( 0 => '', 1 => '', ), 'method' => 'generatePdf', 'rawReply' => true, 'allowDownloadCookie' => true, 'shortHelp' => 'Generate a PDF', 'longHelp' => 'modules/PdfManager/clients/base/api/help/generate_pdf_api.html', 'file' => 'modules/PdfManager/clients/base/api/PdfManagerGeneratePdfApi.php', 'className' => 'PdfManagerGeneratePdfApi', 'score' => 8.75, ), ), ), 'ExpressionEngine' => array ( 'functions' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'ExpressionEngine', 1 => 'functions', ), 'pathVars' => array ( 0 => '', 1 => '', ), 'method' => 'getSugarLogicFunctions', 'shortHelp' => 'Retrieve the js for SugarLogic Expressions and Actions', 'longHelp' => '', 'noLoginRequired' => true, 'rawReply' => true, 'noEtag' => true, 'ignoreMetaHash' => true, 'ignoreSystemStatusError' => true, 'file' => 'modules/ExpressionEngine/clients/base/api/SugarLogicFunctionsApi.php', 'className' => 'SugarLogicFunctionsApi', 'score' => 8.75, ), ), ), 'DocumentMerge' => array ( 'mergeModules' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'DocumentMerge', 1 => 'mergeModules', ), 'pathVars' => array ( 0 => 'DocumentMerge', 1 => 'mergeModules', ), 'method' => 'getMergeModules', 'shortHelp' => 'Retrieves the modules that are compatible with document merging', 'longHelp' => 'include/api/help/document_merges_get_merge_modules.html', 'minVersion' => '11.15', 'file' => 'modules/DocumentMerges/clients/base/api/DocumentMergeApi.php', 'className' => 'DocumentMergeApi', 'score' => 8.75, ), ), ), ), 'POST' => array ( '<module>' => array ( 'config' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => '<module>', 1 => 'config', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'configSave', 'shortHelp' => 'Creates the config entries for the given module', 'longHelp' => 'include/api/help/module_config_post_help.html', 'file' => 'clients/base/api/ConfigModuleApi.php', 'className' => 'ConfigModuleApi', 'score' => 8.0, ), 1 => array ( 'reqType' => 'POST', 'path' => array ( 0 => '<module>', 1 => 'config', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'configSave', 'shortHelp' => 'Creates the config entries for the given module', 'longHelp' => 'include/api/help/module_config_post_help.html', 'file' => 'modules/KBContents/clients/base/api/KBContentsConfigApi.php', 'className' => 'KBContentsConfigApi', 'score' => 8.0, ), ), 'filter' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => '<module>', 1 => 'filter', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'filterList', 'shortHelp' => 'Lists filtered records.', 'longHelp' => 'include/api/help/module_filter_post_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionInvalidParameter', 3 => 'SugarApiExceptionNotAuthorized', ), 'file' => 'clients/base/api/FilterApi.php', 'className' => 'FilterApi', 'score' => 8.0, ), 1 => array ( 'reqType' => 'POST', 'path' => array ( 0 => '<module>', 1 => 'filter', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'filterList', 'shortHelp' => 'Lists filtered records.', 'longHelp' => 'include/api/help/module_filter_post_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionInvalidParameter', 3 => 'SugarApiExceptionNotAuthorized', ), 'file' => 'modules/Opportunities/clients/base/api/OpportunitiesFilterApi.php', 'className' => 'OpportunitiesFilterApi', 'score' => 8.0, ), 2 => array ( 'reqType' => 'POST', 'path' => array ( 0 => '<module>', 1 => 'filter', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'filterList', 'shortHelp' => 'Lists filtered records.', 'longHelp' => 'include/api/help/module_filter_post_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionInvalidParameter', 3 => 'SugarApiExceptionNotAuthorized', ), 'file' => 'modules/pmse_Project/clients/base/api/PMSEFilterOutboundEmailsApi.php', 'className' => 'PMSEFilterOutboundEmailsApi', 'score' => 8.0, ), 3 => array ( 'reqType' => 'POST', 'path' => array ( 0 => '<module>', 1 => 'filter', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'filterList', 'shortHelp' => 'Lists filtered records.', 'longHelp' => 'include/api/help/module_filter_post_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionInvalidParameter', 3 => 'SugarApiExceptionNotAuthorized', ), 'file' => 'modules/Notes/clients/base/api/NotesFilterApi.php', 'className' => 'NotesFilterApi', 'score' => 8.0, ), 4 => array ( 'reqType' => 'POST', 'path' => array ( 0 => '<module>', 1 => 'filter', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'filterList', 'shortHelp' => 'Lists filtered records.', 'longHelp' => 'include/api/help/module_filter_post_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionInvalidParameter', 3 => 'SugarApiExceptionNotAuthorized', ), 'file' => 'modules/DataArchiver/clients/base/api/DataArchiverFilterApi.php', 'className' => 'DataArchiverFilterApi', 'score' => 8.0, ), ), 'record_list' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => '<module>', 1 => 'record_list', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'jsonParams' => array ( 0 => 'filter', ), 'method' => 'recordListCreate', 'shortHelp' => 'An API to create and save lists of records', 'longHelp' => 'include/api/help/module_recordlist_post.html', 'file' => 'clients/base/api/RecordListApi.php', 'className' => 'RecordListApi', 'score' => 8.0, ), ), 'globalsearch' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => '<module>', 1 => 'globalsearch', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'globalSearch', 'shortHelp' => 'Global search', 'longHelp' => 'include/api/help/globalsearch_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotAuthorized', 1 => 'SugarApiExceptionSearchUnavailable', 2 => 'SugarApiExceptionSearchRuntime', ), 'file' => 'clients/base/api/GlobalSearchApi.php', 'className' => 'GlobalSearchApi', 'score' => 8.0, ), ), 'link_by_sync_keys' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => '<module>', 1 => 'link_by_sync_keys', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'relateByFields', 'shortHelp' => 'Create a relationship based on both sync_keys given from the query params. If both the LHS and RHS records can be found with the respective sync_key, then relate the RHS record to the LHS record.', 'file' => 'clients/base/api/IntegrateRelateApi.php', 'className' => 'IntegrateRelateApi', 'score' => 8.0, ), ), 'duplicateCheck' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => '<module>', 1 => 'duplicateCheck', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'checkForDuplicates', 'shortHelp' => 'Check for duplicate records within a module', 'longHelp' => 'include/api/help/module_duplicatecheck_post_help.html', 'file' => 'clients/base/api/DuplicateCheckApi.php', 'className' => 'DuplicateCheckApi', 'score' => 8.0, ), ), 'customfield' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => '<module>', 1 => 'customfield', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'createCustomField', 'shortHelp' => 'This method creates a new custom field of the specified module', 'longHelp' => 'include/api/help/module_field_post_help.html', 'minVersion' => '11.11', 'file' => 'clients/base/api/FieldApi.php', 'className' => 'FieldApi', 'score' => 8.0, ), ), 'recent-product' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => '<module>', 1 => 'recent-product', ), 'pathVars' => array ( 0 => 'module', 1 => 'recent-product', ), 'minVersion' => '11.4', 'method' => 'getRecentRecords', 'shortHelp' => 'Get top 10 recently used items in reverse Chronological order', 'longHelp' => 'modules/Opportunities/clients/base/api/help/recent_product_post_help.html', 'file' => 'modules/Opportunities/clients/base/api/RecentProductApi.php', 'className' => 'RecentProductApi', 'score' => 8.0, ), ), 'favorites' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => '<module>', 1 => 'favorites', ), 'pathVars' => array ( 0 => 'module', 1 => 'favorites', ), 'minVersion' => '11.4', 'method' => 'getFavoriteRecords', 'shortHelp' => 'Get all the favorite items in alphabetical order', 'longHelp' => 'modules/Opportunities/clients/base/api/help/favorites_post_help.html', 'file' => 'modules/Opportunities/clients/base/api/FavoritesApi.php', 'className' => 'FavoritesApi', 'score' => 8.0, ), ), ), 'maps' => array ( 'generateMap' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'maps', 1 => 'generateMap', ), 'pathVars' => array ( 0 => '', ), 'method' => 'generateMap', 'shortHelp' => 'Generate Map as Document', 'longHelp' => 'include/api/help/maps_generate_pdf_post_help.html', 'minVersion' => '11.16', 'file' => 'clients/base/api/MapsApi.php', 'className' => 'MapsApi', 'score' => 8.75, ), ), 'updateGeocodeStatus' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'maps', 1 => 'updateGeocodeStatus', ), 'pathVars' => array ( 0 => '', ), 'method' => 'updateGeocodeStatus', 'shortHelp' => 'Update the geocode status of the parent record', 'longHelp' => 'include/api/help/maps_update_geocode_status_post_help.html', 'minVersion' => '11.17', 'file' => 'clients/base/api/MapsApi.php', 'className' => 'MapsApi', 'score' => 8.75, ), ), ), 'oauth2' => array ( 'token' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'oauth2', 1 => 'token', ), 'pathVars' => array ( 0 => '', 1 => '', ), 'method' => 'token', 'shortHelp' => 'OAuth2 token requests.', 'longHelp' => 'include/api/help/oauth2_token_post_help.html', 'noLoginRequired' => true, 'keepSession' => true, 'ignoreMetaHash' => true, 'ignoreSystemStatusError' => true, 'file' => 'clients/base/api/OAuth2Api.php', 'className' => 'OAuth2Api', 'score' => 8.75, ), ), 'logout' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'oauth2', 1 => 'logout', ), 'pathVars' => array ( 0 => '', 1 => '', ), 'method' => 'logout', 'shortHelp' => 'OAuth2 logout.', 'longHelp' => 'include/api/help/oauth2_logout_post_help.html', 'keepSession' => true, 'ignoreMetaHash' => true, 'ignoreSystemStatusError' => true, 'file' => 'clients/base/api/OAuth2Api.php', 'className' => 'OAuth2Api', 'score' => 8.75, ), ), ), 'Leads' => array ( 'register' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Leads', 1 => 'register', ), 'pathVars' => array ( 0 => 'module', ), 'method' => 'createLeadRecord', 'shortHelp' => 'This method registers leads', 'longHelp' => 'include/api/help/leads_register_post_help.html', 'noLoginRequired' => true, 'file' => 'clients/base/api/RegisterLeadApi.php', 'className' => 'RegisterLeadApi', 'score' => 8.75, ), ), ), 'password' => array ( 'adminRequest' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'password', 1 => 'adminRequest', ), 'pathVars' => array ( 0 => '', 1 => '', ), 'method' => 'adminRequestPassword', 'shortHelp' => 'This method allows a User admin to request that an email be sent to a User to reset their password', 'longHelp' => 'include/api/help/password_admin_request_post_help.html', 'minVersion' => '11.24', 'file' => 'clients/base/api/PasswordApi.php', 'className' => 'PasswordApi', 'score' => 8.75, ), ), ), 'actionButton' => array ( 'evaluateBPMEmailTemplate' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'actionButton', 1 => 'evaluateBPMEmailTemplate', ), 'pathVars' => array ( 0 => '', ), 'method' => 'evaluateBPMEmailTemplate', 'shortHelp' => 'Merges a BPM Email Template and returns the merged data', 'longHelp' => 'include/api/help/actionbutton_evaluatebpmemailtemplate_post_help.html', 'minVersion' => '11.13', 'file' => 'clients/base/api/ActionButtonApi.php', 'className' => 'ActionButtonApi', 'score' => 8.75, ), ), 'evaluateEmailTemplate' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'actionButton', 1 => 'evaluateEmailTemplate', ), 'pathVars' => array ( 0 => '', ), 'method' => 'evaluateEmailTemplate', 'shortHelp' => 'Merges a standard Sugar Email Template and returns the merged data', 'longHelp' => 'include/api/help/actionbutton_evaluateemailtemplate_post_help.html', 'minVersion' => '11.13', 'file' => 'clients/base/api/ActionButtonApi.php', 'className' => 'ActionButtonApi', 'score' => 8.75, ), ), 'evaluateExpression' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'actionButton', 1 => 'evaluateExpression', ), 'pathVars' => array ( 0 => '', 1 => '', ), 'method' => 'evaluateExpression', 'shortHelp' => 'Evaluates an Sugar Expression and returns the result', 'longHelp' => 'include/api/help/actionbutton_evaluateexpression_post_help.html', 'minVersion' => '11.13', 'file' => 'clients/base/api/ActionButtonApi.php', 'className' => 'ActionButtonApi', 'score' => 8.75, ), ), 'evaluateCalculatedUrl' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'actionButton', 1 => 'evaluateCalculatedUrl', ), 'pathVars' => array ( 0 => '', 1 => '', ), 'method' => 'evaluateCalculatedUrl', 'shortHelp' => 'Evaluates a calculated URL expression and returns the result', 'longHelp' => 'include/api/help/actionbutton_evaluatecalculatedurl_post_help.html', 'minVersion' => '11.13', 'file' => 'clients/base/api/ActionButtonApi.php', 'className' => 'ActionButtonApi', 'score' => 8.75, ), ), ), 'me' => array ( 'password' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'me', 1 => 'password', ), 'pathVars' => array ( 0 => '', ), 'method' => 'verifyPassword', 'shortHelp' => 'Verifies current user\'s password', 'longHelp' => 'include/api/help/me_password_post_help.html', 'ignoreSystemStatusError' => true, 'file' => 'clients/base/api/CurrentUserApi.php', 'className' => 'CurrentUserApi', 'score' => 8.75, ), ), ), 'hint' => array ( 'config' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'hint', 1 => 'config', ), 'pathVars' => array ( 0 => '', ), 'method' => 'updateConfig', 'shortHelp' => 'Updates Hint configuration', 'longHelp' => 'include/api/help/hint_config_post_help.html', 'minVersion' => '11.16', 'file' => 'clients/base/api/HintApi.php', 'className' => 'HintApi', 'score' => 8.75, ), ), ), 'stage2' => array ( 'token' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'stage2', 1 => 'token', ), 'pathVars' => array ( 0 => '', ), 'method' => 'createToken', 'shortHelp' => 'Generates a new Stage2 access token for the user', 'longHelp' => 'include/api/help/hint_stage2_token_post_help.html', 'minVersion' => '11.16', 'file' => 'clients/base/api/HintApi.php', 'className' => 'HintApi', 'score' => 8.75, ), ), 'notificationsServiceToken' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'stage2', 1 => 'notificationsServiceToken', ), 'pathVars' => array ( 0 => '', ), 'method' => 'createNotificationsServiceToken', 'shortHelp' => 'Generates a new notifications service access token for the user', 'longHelp' => 'include/api/help/hint_stage2_notificationsServiceToken_post_help.html', 'minVersion' => '11.16', 'file' => 'clients/base/api/HintApi.php', 'className' => 'HintApi', 'score' => 8.75, ), ), ), 'CloudDrive' => array ( 'download' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'CloudDrive', 1 => 'download', ), 'pathVars' => array ( 0 => 'CloudDrive', 1 => 'download', ), 'method' => 'downloadFile', 'shortHelp' => 'downloads a file', 'longHelp' => 'include/api/help/cloud_drive_download_file.html', 'minVersion' => '11.16', 'file' => 'clients/base/api/CloudDriveApi.php', 'className' => 'CloudDriveApi', 'score' => 8.75, ), ), 'delete' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'CloudDrive', 1 => 'delete', ), 'pathVars' => array ( 0 => 'CloudDrive', 1 => 'delete', ), 'method' => 'deleteFile', 'shortHelp' => 'deletes a file', 'longHelp' => 'include/api/help/cloud_drive_delete_file.html', 'minVersion' => '11.16', 'file' => 'clients/base/api/CloudDriveApi.php', 'className' => 'CloudDriveApi', 'score' => 8.75, ), ), 'createSugarDocument' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'CloudDrive', 1 => 'createSugarDocument', ), 'pathVars' => array ( 0 => 'CloudDrive', 1 => 'createSugarDocument', ), 'method' => 'createSugarDocument', 'shortHelp' => 'creates a sugar document', 'longHelp' => 'include/api/help/cloud_drive_create_document.html', 'minVersion' => '11.16', 'file' => 'clients/base/api/CloudDriveApi.php', 'className' => 'CloudDriveApi', 'score' => 8.75, ), ), 'path' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'CloudDrive', 1 => 'path', ), 'pathVars' => array ( 0 => 'CloudDrive', 1 => 'path', ), 'method' => 'createDrivePath', 'shortHelp' => 'creates a drive path', 'longHelp' => 'include/api/help/cloud_drive_path_create.html', 'minVersion' => '11.16', 'file' => 'clients/base/api/CloudDriveApi.php', 'className' => 'CloudDriveApi', 'score' => 8.75, ), ), 'folder' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'CloudDrive', 1 => 'folder', ), 'pathVars' => array ( 0 => 'CloudDrive', 1 => 'folder', ), 'method' => 'createFolder', 'shortHelp' => 'creates a drive folder', 'longHelp' => 'include/api/help/cloud_drive_create_folder.html', 'minVersion' => '11.16', 'file' => 'clients/base/api/CloudDriveApi.php', 'className' => 'CloudDriveApi', 'score' => 8.75, ), ), 'file' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'CloudDrive', 1 => 'file', ), 'pathVars' => array ( 0 => 'CloudDrive', 1 => 'file', ), 'method' => 'uploadToDrive', 'shortHelp' => 'creates a file on the drive', 'longHelp' => 'include/api/help/cloud_drive_create_file.html', 'minVersion' => '11.16', 'file' => 'clients/base/api/CloudDriveApi.php', 'className' => 'CloudDriveApi', 'score' => 8.75, ), ), 'document' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'CloudDrive', 1 => 'document', ), 'pathVars' => array ( 0 => 'CloudDrive', 1 => 'document', ), 'method' => 'uploadDocumentToDrive', 'shortHelp' => 'create a file on the drive', 'longHelp' => 'include/api/help/cloud_drive_create_file_from_doc.html', 'minVersion' => '11.18', 'file' => 'clients/base/api/CloudDriveApi.php', 'className' => 'CloudDriveApi', 'score' => 8.75, ), ), ), 'formulaBuilder' => array ( 'meta' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'formulaBuilder', 1 => 'meta', ), 'pathVars' => array ( 0 => '', 1 => '', ), 'method' => 'meta', 'shortHelp' => 'Retrieve metadata needed by the Formula Builder component', 'longHelp' => 'include/api/help/formulabuilder_meta_post_help.html', 'ignoreMetaHash' => true, 'minVersion' => '11.13', 'file' => 'clients/base/api/FormulaBuilderApi.php', 'className' => 'FormulaBuilderApi', 'score' => 8.75, ), ), ), 'Opportunities' => array ( 'config' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Opportunities', 1 => 'config', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'configSave', 'shortHelp' => 'Save the config settings for the Opportunities Module', 'longHelp' => 'modules/Opportunities/clients/base/api/help/config_post_help.html', 'file' => 'modules/Opportunities/clients/base/api/OpportunitiesConfigApi.php', 'className' => 'OpportunitiesConfigApi', 'score' => 8.75, ), ), ), 'Calendar' => array ( 'getEvents' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Calendar', 1 => 'getEvents', ), 'pathVars' => array ( 0 => 'module', 1 => 'action', ), 'method' => 'getEvents', 'shortHelp' => 'Retrieve events to show in calendar', 'longHelp' => 'modules/Calendar/clients/base/api/help/calendar_getevents_post_help.html', 'minVersion' => '11.14', 'file' => 'modules/Calendar/clients/base/api/CalendarApi.php', 'className' => 'CalendarApi', 'score' => 8.75, ), ), 'calendars' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Calendar', 1 => 'calendars', ), 'pathVars' => array ( 0 => 'module', 1 => 'target', ), 'method' => 'listCalendars', 'shortHelp' => 'Lists my calendars and others', 'longHelp' => 'modules/Calendar/clients/base/api/help/calendar_listcalendars_post_help.html', 'minVersion' => '11.14', 'file' => 'modules/Calendar/clients/base/api/CalendarApi.php', 'className' => 'CalendarApi', 'score' => 8.75, ), ), 'getCalendarDefs' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Calendar', 1 => 'getCalendarDefs', ), 'pathVars' => array ( 0 => 'module', 1 => 'action', ), 'method' => 'getCalendarDefs', 'shortHelp' => 'Get Calendar Definitions.', 'longHelp' => 'modules/Calendar/clients/base/api/help/calendar_getcalendardefs_post_help.html', 'minVersion' => '11.14', 'file' => 'modules/Calendar/clients/base/api/CalendarApi.php', 'className' => 'CalendarApi', 'score' => 8.75, ), ), 'getICalConfigurationsUID' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Calendar', 1 => 'getICalConfigurationsUID', ), 'pathVars' => array ( 0 => 'module', 1 => 'action', ), 'method' => 'getICalConfigurationsUID', 'shortHelp' => 'getICalConfigurationsUID', 'longHelp' => 'modules/Calendar/clients/base/api/help/calendar_geticalconfigurationsuid_post_help.html', 'minVersion' => '11.14', 'file' => 'modules/Calendar/clients/base/api/CalendarApi.php', 'className' => 'CalendarApi', 'score' => 8.75, ), ), 'getICalPublishUrl' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Calendar', 1 => 'getICalPublishUrl', ), 'pathVars' => array ( 0 => 'module', 1 => 'action', ), 'method' => 'getICalPublishUrl', 'shortHelp' => 'getICalPublishUrl', 'longHelp' => 'modules/Calendar/clients/base/api/help/calendar_geticalpublishurl_post_help.html', 'minVersion' => '11.14', 'file' => 'modules/Calendar/clients/base/api/CalendarApi.php', 'className' => 'CalendarApi', 'score' => 8.75, ), ), ), 'SugarLive' => array ( 'config' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'SugarLive', 1 => 'config', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'configSave', 'shortHelp' => 'Creates the config entries for the SugarLive module', 'longHelp' => 'modules/SugarLive/clients/base/api/help/module_config_post_help.html', 'minVersion' => '11.12', 'file' => 'modules/SugarLive/clients/base/api/SugarLiveConfigModuleApi.php', 'className' => 'SugarLiveConfigModuleApi', 'score' => 8.75, ), ), ), 'Administration' => array ( 'package' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Administration', 1 => 'package', ), 'pathVars' => array ( 0 => '', 1 => '', ), 'method' => 'createPackage', 'shortHelp' => 'Create a package', 'longHelp' => 'include/api/help/administration_package_post_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionInvalidParameter', 1 => 'SugarApiExceptionNotAuthorized', ), 'file' => 'modules/Administration/clients/base/api/PackageBuilderApi.php', 'className' => 'PackageBuilderApi', 'score' => 8.75, ), ), 'packages' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Administration', 1 => 'packages', ), 'pathVars' => array ( 0 => '', 1 => '', ), 'method' => 'uploadPackage', 'rawPostContents' => true, 'shortHelp' => 'Uploads a package to an instance. Does not install or enable the package', 'longHelp' => 'include/api/help/administration_packages_upload_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotAuthorized', 1 => 'SugarApiException', ), 'file' => 'modules/Administration/clients/base/api/PackageApiRest.php', 'className' => 'PackageApiRest', 'score' => 8.75, ), ), 'aws' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Administration', 1 => 'aws', ), 'pathVars' => array ( 0 => '', ), 'method' => 'setAWSConfig', 'shortHelp' => 'Sets configuration settings for Amazon Web Services integrations', 'longHelp' => 'include/api/help/administration_set_aws_config_post_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotAuthorized', ), 'ignoreSystemStatusError' => true, 'maxVersion' => '11.14', 'file' => 'modules/Administration/clients/base/api/AdministrationApi.php', 'className' => 'AdministrationApi', 'score' => 8.75, ), ), 'csp' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Administration', 1 => 'csp', ), 'pathVars' => array ( 0 => '', ), 'method' => 'setCSPConfig', 'shortHelp' => 'Sets configuration settings for Content Security Policy', 'longHelp' => 'include/api/help/administration_set_csp_setting_post_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotAuthorized', ), 'ignoreSystemStatusError' => true, 'maxVersion' => '11.14', 'file' => 'modules/Administration/clients/base/api/AdministrationApi.php', 'className' => 'AdministrationApi', 'score' => 8.75, ), ), ), 'Quotes' => array ( 'config' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Quotes', 1 => 'config', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'minVersion' => '11.3', 'method' => 'configSave', 'shortHelp' => 'Save the config settings for the Quotes Module', 'longHelp' => 'modules/Quotes/clients/base/api/help/quotes_module_config_post_help.html', 'file' => 'modules/Quotes/clients/base/api/QuotesConfigApi.php', 'className' => 'QuotesConfigApi', 'score' => 8.75, ), ), ), 'DRI_Workflows' => array ( 'cancel' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'DRI_Workflows', 1 => 'cancel', ), 'pathVars' => array ( 0 => 'module', 1 => 'action', ), 'method' => 'cancel', 'shortHelp' => 'Cancel current journey and also related stages and activities', 'longHelp' => '/include/api/help/customer_journeyDRI_Workflowscancel.html', 'noEtag' => true, 'minVersion' => '11.19', 'file' => 'modules/DRI_Workflows/clients/base/api/DRI_WorkflowsApi.php', 'className' => 'DRI_WorkflowsApi', 'score' => 8.75, ), ), 'not-applicable' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'DRI_Workflows', 1 => 'not-applicable', ), 'pathVars' => array ( 0 => 'module', 1 => 'action', ), 'method' => 'notApplicableSubActivities', 'shortHelp' => 'Set Activty and its sub activities status to Not Applicable', 'longHelp' => '/include/api/help/customer_journeyDRI_WorkflowsnotApplicableSubActivities.html', 'noEtag' => true, 'minVersion' => '11.19', 'file' => 'modules/DRI_Workflows/clients/base/api/DRI_WorkflowsApi.php', 'className' => 'DRI_WorkflowsApi', 'score' => 8.75, ), ), 'update-activity-state' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'DRI_Workflows', 1 => 'update-activity-state', ), 'pathVars' => array ( 0 => 'module', 1 => 'action', ), 'method' => 'updateActivityState', 'shortHelp' => 'Set status, update start and end dates of the specific activity', 'longHelp' => '/include/api/help/customer_journeyDRI_WorkflowsupdateActivityState.html', 'noEtag' => true, 'minVersion' => '11.19', 'file' => 'modules/DRI_Workflows/clients/base/api/DRI_WorkflowsApi.php', 'className' => 'DRI_WorkflowsApi', 'score' => 8.75, ), ), 'delete-stage-journey' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'DRI_Workflows', 1 => 'delete-stage-journey', ), 'pathVars' => array ( 0 => 'module', 1 => 'action', ), 'method' => 'deleteStageOrJourney', 'shortHelp' => 'Delete journey or stage according to the provide module and id', 'longHelp' => '/include/api/help/customer_journeyDRI_WorkflowsDeleteStageOrJourney.html', 'minVersion' => '11.21', 'file' => 'modules/DRI_Workflows/clients/base/api/DRI_WorkflowsApi.php', 'className' => 'DRI_WorkflowsApi', 'score' => 8.75, ), ), ), 'KBContents' => array ( 'config' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'KBContents', 1 => 'config', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'configSave', 'shortHelp' => 'Creates the config entries for the KBContents module.', 'longHelp' => 'modules/KBContents/clients/base/api/help/kb_config_put_help.html', 'file' => 'modules/KBContents/clients/base/api/KBContentsConfigApi.php', 'className' => 'KBContentsConfigApi', 'score' => 8.75, ), ), 'duplicateCheck' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'KBContents', 1 => 'duplicateCheck', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'checkForDuplicates', 'shortHelp' => 'Check for duplicate records within a module', 'longHelp' => 'include/api/help/module_duplicatecheck_post_help.html', 'file' => 'modules/KBContents/clients/base/api/KBSDuplicateCheckApi.php', 'className' => 'KBSDuplicateCheckApi', 'score' => 8.75, ), ), ), 'CJ_Forms' => array ( 'performTargetActions' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'CJ_Forms', 1 => 'performTargetActions', ), 'pathVars' => array ( 0 => 'module', 1 => 'action', ), 'method' => 'performTargetActions', 'shortHelp' => 'Perform the target actions against the given chunk of activities', 'longHelp' => '/include/api/help/customer_journeyCJ_FormsperformTargetActions.html', 'minVersion' => '11.22', 'file' => 'modules/CJ_Forms/clients/base/api/CJ_FormsApi.php', 'className' => 'CJ_FormsApi', 'score' => 8.75, ), ), ), 'ForecastManagerWorksheets' => array ( 'assignQuota' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'ForecastManagerWorksheets', 1 => 'assignQuota', ), 'pathVars' => array ( 0 => 'module', 1 => 'action', ), 'method' => 'assignQuota', 'shortHelp' => 'Assign the Quota for Users with out actually committing', 'longHelp' => 'modules/Forecasts/clients/base/api/help/ForecastWorksheetManagerAssignQuota.html', 'file' => 'modules/ForecastManagerWorksheets/clients/base/api/ForecastManagerWorksheetsApi.php', 'className' => 'ForecastManagerWorksheetsApi', 'score' => 8.75, ), ), 'filter' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'ForecastManagerWorksheets', 1 => 'filter', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'filterList', 'jsonParams' => array ( 0 => 'filter', ), 'shortHelp' => 'Filter records from a single module', 'longHelp' => 'modules/Forecasts/clients/base/api/help/ForecastManagerWorksheetFilter.html', 'exceptions' => array ( 0 => 'SugarApiExceptionError', 1 => 'SugarApiExceptionInvalidParameter', 2 => 'SugarApiExceptionNotFound', ), 'file' => 'modules/ForecastManagerWorksheets/clients/base/api/ForecastManagerWorksheetsFilterApi.php', 'className' => 'ForecastManagerWorksheetsFilterApi', 'score' => 8.75, ), ), ), 'Mail' => array ( 'archive' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Mail', 1 => 'archive', ), 'pathVars' => array ( 0 => '', ), 'method' => 'archiveMail', 'shortHelp' => 'Archive Mail Item', 'longHelp' => 'modules/Emails/clients/base/api/help/mail_archive_help.html', 'file' => 'modules/Emails/clients/base/api/MailApi.php', 'className' => 'MailApi', 'score' => 8.75, ), ), 'attachment' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Mail', 1 => 'attachment', ), 'pathVars' => array ( 0 => '', 1 => '', ), 'method' => 'saveAttachment', 'rawPostContents' => true, 'shortHelp' => 'Saves a mail attachment.', 'longHelp' => 'modules/Emails/clients/base/api/help/mail_attachment_post_help.html', 'file' => 'modules/Emails/clients/base/api/MailApi.php', 'className' => 'MailApi', 'score' => 8.75, ), ), ), 'Emails' => array ( 'filter' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Emails', 1 => 'filter', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'filterList', 'shortHelp' => 'Lists filtered records.', 'longHelp' => 'include/api/help/module_filter_post_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionInvalidParameter', 3 => 'SugarApiExceptionNotAuthorized', ), 'file' => 'modules/Emails/clients/base/api/EmailsFilterApi.php', 'className' => 'EmailsFilterApi', 'score' => 8.75, ), ), ), 'Dashboards' => array ( 'filter' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Dashboards', 1 => 'filter', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'filterList', 'shortHelp' => 'Lists filtered records.', 'longHelp' => 'include/api/help/module_filter_post_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionInvalidParameter', 3 => 'SugarApiExceptionNotAuthorized', ), 'file' => 'modules/Dashboards/clients/base/api/DashboardsFilterApi.php', 'className' => 'DashboardsFilterApi', 'score' => 8.75, ), ), '<module>' => array ( 0 => array ( 'reqType' => 'POST', 'minVersion' => '10', 'maxVersion' => '10', 'path' => array ( 0 => 'Dashboards', 1 => '<module>', ), 'pathVars' => array ( 0 => '', 1 => 'module', ), 'method' => 'createDashboard', 'shortHelp' => 'Create a new dashboard for a module', 'longHelp' => 'include/api/help/create_dashboard.html', 'file' => 'modules/Dashboards/clients/base/api/DashboardApi.php', 'className' => 'DashboardApi', 'score' => 8.0, ), ), ), 'Metrics' => array ( 'config' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Metrics', 1 => 'config', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'configSave', 'shortHelp' => 'This method will return metrics.', 'minVersion' => '11.18', 'file' => 'modules/Metrics/clients/base/api/MetricsApi.php', 'className' => 'MetricsApi', 'score' => 8.75, ), ), ), 'ConsoleConfiguration' => array ( 'config' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'ConsoleConfiguration', 1 => 'config', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'configSave', 'shortHelp' => 'Creates the config entries for the ConsoleConfiguration module', 'longHelp' => 'modules/ConsoleConfiguration/clients/base/api/help/module_config_post_help.html', 'minVersion' => '11.9', 'file' => 'modules/ConsoleConfiguration/clients/base/api/ConsoleConfigModuleApi.php', 'className' => 'ConsoleConfigModuleApi', 'score' => 8.75, ), ), ), 'Meetings' => array ( 'updateOccurrence' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Meetings', 1 => 'updateOccurrence', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'updateOccurrenceEvent', 'shortHelp' => 'This method updates a single event record of the specified type', 'longHelp' => 'include/api/help/calendar_events_record_update_occurrence_help.html', 'minVersion' => '11.23', 'file' => 'modules/Meetings/clients/base/api/MeetingsApi.php', 'className' => 'MeetingsApi', 'score' => 8.75, ), ), 'retrieveOccurrences' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Meetings', 1 => 'retrieveOccurrences', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'retrieveOccurrencesEvents', 'shortHelp' => 'This method retrieves some of all occurrences of a certain type', 'longHelp' => 'include/api/help/calendar_events_retrieve_occurrences_help.html', 'minVersion' => '11.23', 'file' => 'modules/Meetings/clients/base/api/MeetingsApi.php', 'className' => 'MeetingsApi', 'score' => 8.75, ), ), ), 'DocuSign' => array ( 'send' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'DocuSign', 1 => 'send', ), 'pathVars' => array ( 0 => 'module', 1 => 'action', ), 'method' => 'send', 'shortHelp' => 'Send envelope', 'longHelp' => 'modules/DocuSignEnvelopes/clients/base/api/help/docusignenvelopes_send_post_help.html', 'minVersion' => '11.16', 'file' => 'modules/DocuSignEnvelopes/clients/base/api/DocuSignApi.php', 'className' => 'DocuSignApi', 'score' => 8.75, ), ), 'saveBean' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'DocuSign', 1 => 'saveBean', ), 'pathVars' => array ( 0 => '', 1 => '', ), 'method' => 'docusignSaveBean', 'shortHelp' => 'This method is used to update the envelope locally', 'longHelp' => 'modules/DocuSignEnvelopes/clients/base/api/help/docusignenvelopes_save_bean_post_help.html', 'minVersion' => '11.16', 'file' => 'modules/DocuSignEnvelopes/clients/base/api/DocuSignApi.php', 'className' => 'DocuSignApi', 'score' => 8.75, ), ), 'stats' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'DocuSign', 1 => 'stats', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'stats', 'shortHelp' => 'Returns envelope count grouped by status', 'longHelp' => 'modules/DocuSignEnvelopes/clients/base/api/help/docusignenvelopes_stats_post_help.html', 'minVersion' => '11.16', 'file' => 'modules/DocuSignEnvelopes/clients/base/api/DocuSignApi.php', 'className' => 'DocuSignApi', 'score' => 8.75, ), ), 'getCompletedDocument' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'DocuSign', 1 => 'getCompletedDocument', ), 'pathVars' => array ( 0 => 'module', 1 => 'action', ), 'method' => 'getCompletedDocument', 'shortHelp' => 'Download and add the completed document onto the record', 'longHelp' => 'modules/DocuSignEnvelopes/clients/base/api/help/docusignenvelopes_get_completed_document_post_help.html', 'minVersion' => '11.16', 'file' => 'modules/DocuSignEnvelopes/clients/base/api/DocuSignApi.php', 'className' => 'DocuSignApi', 'score' => 8.75, ), ), 'downloadDocument' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'DocuSign', 1 => 'downloadDocument', ), 'pathVars' => array ( 0 => '', 1 => '', ), 'method' => 'downloadDocumentPost', 'shortHelp' => 'Download combined documents from DocuSign', 'longHelp' => 'modules/DocuSignEnvelopes/clients/base/api/help/docusignenvelopes_download_document_post_help.html', 'minVersion' => '11.16', 'file' => 'modules/DocuSignEnvelopes/clients/base/api/DocuSignApi.php', 'className' => 'DocuSignApi', 'score' => 8.75, ), ), 'resendEnvelope' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'DocuSign', 1 => 'resendEnvelope', ), 'pathVars' => array ( 0 => '', 1 => '', ), 'method' => 'resendEnvelope', 'shortHelp' => 'Resend Envelope', 'longHelp' => 'modules/DocuSignEnvelopes/clients/base/api/help/docusignenvelopes_resend_envelope_post_help.html', 'minVersion' => '11.16', 'file' => 'modules/DocuSignEnvelopes/clients/base/api/DocuSignApi.php', 'className' => 'DocuSignApi', 'score' => 8.75, ), ), 'updateEnvelope' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'DocuSign', 1 => 'updateEnvelope', ), 'pathVars' => array ( 0 => '', 1 => '', ), 'method' => 'updateEnvelope', 'shortHelp' => 'Update Envelope in Sugar', 'longHelp' => 'modules/DocuSignEnvelopes/clients/base/api/help/docusignenvelopes_update_envelope_post_help.html', 'minVersion' => '11.16', 'file' => 'modules/DocuSignEnvelopes/clients/base/api/DocuSignApi.php', 'className' => 'DocuSignApi', 'score' => 8.75, ), ), 'removeEnvelope' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'DocuSign', 1 => 'removeEnvelope', ), 'pathVars' => array ( 0 => '', 1 => '', ), 'method' => 'removeEnvelope', 'shortHelp' => 'Deletes envelope record from Sugar', 'longHelp' => 'modules/DocuSignEnvelopes/clients/base/api/help/docusignenvelopes_remove_envelope_post_help.html', 'minVersion' => '11.16', 'file' => 'modules/DocuSignEnvelopes/clients/base/api/DocuSignApi.php', 'className' => 'DocuSignApi', 'score' => 8.75, ), ), 'setGlobalConfig' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'DocuSign', 1 => 'setGlobalConfig', ), 'pathVars' => array ( 0 => '', 1 => '', ), 'method' => 'setGlobalConfig', 'shortHelp' => 'Set global configs', 'longHelp' => 'modules/DocuSignEnvelopes/clients/base/api/help/docusignenvelopes_setGlobalConfig_post_help.html', 'minVersion' => '11.18', 'file' => 'modules/DocuSignEnvelopes/clients/base/api/DocuSignApi.php', 'className' => 'DocuSignApi', 'score' => 8.75, ), ), 'getTemplateDetails' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'DocuSign', 1 => 'getTemplateDetails', ), 'pathVars' => array ( 0 => '', 1 => '', ), 'method' => 'getTemplateDetails', 'shortHelp' => 'Fetch template details', 'longHelp' => 'modules/DocuSignEnvelopes/clients/base/api/help/docusignenvelopes_get_template_details_get_help.html', 'minVersion' => '11.18', 'file' => 'modules/DocuSignEnvelopes/clients/base/api/DocuSignApi.php', 'className' => 'DocuSignApi', 'score' => 8.75, ), ), ), 'VisualPipeline' => array ( 'config' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'VisualPipeline', 1 => 'config', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'configSave', 'shortHelp' => 'Creates the config entries for the given module', 'longHelp' => 'include/api/help/module_config_post_help.html', 'file' => 'modules/VisualPipeline/clients/base/api/VisualPipelineApi.php', 'className' => 'VisualPipelineApi', 'score' => 8.75, ), ), ), 'Calls' => array ( 'updateOccurrence' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Calls', 1 => 'updateOccurrence', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'updateOccurrenceEvent', 'shortHelp' => 'This method updates a single event record of the specified type', 'longHelp' => 'include/api/help/calendar_events_record_update_occurrence_help.html', 'minVersion' => '11.23', 'file' => 'modules/Calls/clients/base/api/CallsApi.php', 'className' => 'CallsApi', 'score' => 8.75, ), ), 'retrieveOccurrences' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Calls', 1 => 'retrieveOccurrences', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'retrieveOccurrencesEvents', 'shortHelp' => 'This method retrieves some of all occurrences of a certain type', 'longHelp' => 'include/api/help/calendar_events_retrieve_occurrences_help.html', 'minVersion' => '11.23', 'file' => 'modules/Calls/clients/base/api/CallsApi.php', 'className' => 'CallsApi', 'score' => 8.75, ), ), ), 'ProductTemplates' => array ( 'tree' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'ProductTemplates', 1 => 'tree', ), 'pathVars' => array ( 0 => 'module', 1 => 'type', ), 'method' => 'getTemplateTree', 'shortHelp' => 'Returns a filterable tree structure of all Product Templates and Product Categories', 'longHelp' => 'modules/ProductTemplates/clients/base/api/help/tree.html', 'file' => 'modules/ProductTemplates/clients/base/api/ProductTemplateTreeApi.php', 'className' => 'ProductTemplateTreeApi', 'score' => 8.75, ), ), ), 'RevenueLineItems' => array ( 'multi-quote' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'RevenueLineItems', 1 => 'multi-quote', ), 'pathVars' => array ( 0 => 'module', 1 => 'action', ), 'method' => 'multiConvertToQuote', 'shortHelp' => 'Convert a Revenue Line Item Into A Quote Record', 'longHelp' => 'modules/RevenueLineItems/clients/base/api/help/multi_convert_to_quote.html', 'file' => 'modules/RevenueLineItems/clients/base/api/RevenueLineItemToQuoteConvertApi.php', 'className' => 'RevenueLineItemToQuoteConvertApi', 'score' => 8.75, ), ), ), 'ForecastWorksheets' => array ( 'filter' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'ForecastWorksheets', 1 => 'filter', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'forecastWorksheetsGet', 'shortHelp' => 'Filter records from a single module', 'longHelp' => 'modules/Forecasts/clients/base/api/help/ForecastWorksheetFilter.html', 'exceptions' => array ( 0 => 'SugarApiExceptionError', 1 => 'SugarApiExceptionInvalidParameter', 2 => 'SugarApiExceptionNotAuthorized', 3 => 'SugarApiExceptionNotFound', ), 'file' => 'modules/ForecastWorksheets/clients/base/api/ForecastWorksheetsFilterApi.php', 'className' => 'ForecastWorksheetsFilterApi', 'score' => 8.75, ), ), ), 'OutboundEmail' => array ( 'testUserOverride' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'OutboundEmail', 1 => 'testUserOverride', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'testUserSystemOverrideEmail', 'shortHelp' => 'This method tests the system override email account for a user', 'longHelp' => 'modules/OutboundEmail/clients/base/api/help/outbound_email_test_user_override_post_help.html', 'minVersion' => '11.23', 'file' => 'modules/OutboundEmail/clients/base/api/OutboundEmailApi.php', 'className' => 'OutboundEmailApi', 'score' => 8.75, ), ), ), 'Forecasts' => array ( 'filter' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Forecasts', 1 => 'filter', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'filterList', 'shortHelp' => 'Filter records from a single module', 'longHelp' => 'modules/Forecasts/clients/base/api/help/ForecastsFilter.html', 'exceptions' => array ( 0 => 'SugarApiExceptionError', 1 => 'SugarApiExceptionInvalidParameter', 2 => 'SugarApiExceptionNotAuthorized', 3 => 'SugarApiExceptionNotFound', ), 'file' => 'modules/Forecasts/clients/base/api/ForecastsFilterApi.php', 'className' => 'ForecastsFilterApi', 'score' => 8.75, ), ), 'metrics' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Forecasts', 1 => 'metrics', ), 'pathVars' => array ( 0 => '', 1 => '', ), 'method' => 'getMetrics', 'shortHelp' => 'Retrieve metrics for Forecast data', 'longHelp' => 'modules/Forecasts/clients/base/api/help/ForecastMetricsApiPost.html', 'file' => 'modules/Forecasts/clients/base/api/ForecastMetricsApi.php', 'className' => 'ForecastMetricsApi', 'score' => 8.75, ), ), 'config' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Forecasts', 1 => 'config', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'forecastsConfigSave', 'shortHelp' => 'Creates the config entries for the Forecasts module.', 'longHelp' => 'modules/Forecasts/clients/base/api/help/ForecastsConfigPut.html', 'file' => 'modules/Forecasts/clients/base/api/ForecastsConfigApi.php', 'className' => 'ForecastsConfigApi', 'score' => 8.75, ), ), ), 'forecastOpportunities' => array ( 'count' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'forecastOpportunities', 1 => 'count', ), 'pathVars' => array ( ), 'method' => 'getForecastOpportunitiesCount', 'shortHelp' => 'Gets a count of Opportunities in the requested Forecast', 'longHelp' => 'modules/Forecasts/clients/base/api/help/ForecastOpportunityCountAPI.html', 'file' => 'modules/Forecasts/clients/base/api/ForecastsOpportunityApi.php', 'className' => 'ForecastsOpportunityApi', 'score' => 8.75, ), ), ), 'Reports' => array ( 'retrieveSavedReportsRecords' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Reports', 1 => 'retrieveSavedReportsRecords', ), 'pathVars' => array ( 0 => 'module', ), 'method' => 'retrieveSavedReportRecordsById', 'shortHelp' => 'An API to retrieve records list data for a saved report, alos support runtime filters', 'longHelp' => 'modules/Reports/clients/base/api/help/retrieve_saved_report_records_by_id.html', 'minVersion' => '11.17', 'file' => 'modules/Reports/clients/base/api/ReportsApi.php', 'className' => 'ReportsApi', 'score' => 8.75, ), ), 'retrieveReportPreviewData' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Reports', 1 => 'retrieveReportPreviewData', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'retrieveReportPreviewData', 'shortHelp' => 'An API that builds and retrieves complete report preview data', 'longHelp' => 'modules/Reports/clients/base/api/help/retrieve_report_preview_post_help.html', 'minVersion' => '11.17', 'file' => 'modules/Reports/clients/base/api/ReportsApi.php', 'className' => 'ReportsApi', 'score' => 8.75, ), ), ), 'pmse_Inbox' => array ( 'save_notes' => array ( 0 => array ( 'reqType' => 'POST', 'acl' => 'adminOrDev', 'path' => array ( 0 => 'pmse_Inbox', 1 => 'save_notes', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'saveNotes', 'keepSession' => true, 'shortHelp' => 'Creates a new note for a process', 'longHelp' => 'modules/pmse_Inbox/clients/base/api/help/process_save_notes_help.html', 'file' => 'modules/pmse_Inbox/clients/base/api/PMSEEngineApi.php', 'className' => 'PMSEEngineApi', 'score' => 8.75, ), ), ), 'DocumentMerge' => array ( 'merge' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'DocumentMerge', 1 => 'merge', ), 'pathVars' => array ( ), 'method' => 'merge', 'shortHelp' => 'Merge the document', 'longHelp' => 'include/api/help/document_merges_merge.html', 'file' => 'modules/DocumentMerges/clients/base/api/DocumentMergeApi.php', 'className' => 'DocumentMergeApi', 'score' => 8.75, ), ), 'createDocument' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'DocumentMerge', 1 => 'createDocument', ), 'pathVars' => array ( ), 'method' => 'createDocument', 'shortHelp' => 'Create the document', 'longHelp' => 'include/api/help/document_merges_create_document.html', 'file' => 'modules/DocumentMerges/clients/base/api/DocumentMergeApi.php', 'className' => 'DocumentMergeApi', 'score' => 8.75, ), ), ), 'TL_ActiveCampaigns' => array ( 'SyncAcContacts' => array ( 0 => array ( 'reqType' => 'POST', 'noLoginRequired' => true, 'path' => array ( 0 => 'TL_ActiveCampaigns', 1 => 'SyncAcContacts', ), 'pathVars' => array ( 0 => 'module', 1 => 'action', ), 'method' => 'SyncContactz', 'shortHelp' => 'create newly created contact in crm also.', 'longHelp' => '', 'file' => 'custom/modules/TL_ActiveCampaigns/clients/base/api/TL_ActiveCampaignsApi.php', 'className' => 'TL_ActiveCampaignsApi', 'score' => 9.25, ), ), 'CampaignStats' => array ( 0 => array ( 'reqType' => 'POST', 'noLoginRequired' => true, 'path' => array ( 0 => 'TL_ActiveCampaigns', 1 => 'CampaignStats', ), 'pathVars' => array ( 0 => 'module', 1 => 'action', ), 'method' => 'GetCampaignStats', 'shortHelp' => 'Save Campaing Stats.', 'longHelp' => '', 'file' => 'custom/modules/TL_ActiveCampaigns/clients/base/api/TL_ActiveCampaignsApi.php', 'className' => 'TL_ActiveCampaignsApi', 'score' => 9.25, ), ), ), ), 'PUT' => array ( '<module>' => array ( 'config' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => '<module>', 1 => 'config', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'configSave', 'shortHelp' => 'Updates the config entries for given module', 'longHelp' => 'include/api/help/module_config_put_help.html', 'file' => 'clients/base/api/ConfigModuleApi.php', 'className' => 'ConfigModuleApi', 'score' => 8.0, ), 1 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => '<module>', 1 => 'config', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'configSave', 'shortHelp' => 'Updates the config entries for given module', 'longHelp' => 'include/api/help/module_config_put_help.html', 'file' => 'modules/KBContents/clients/base/api/KBContentsConfigApi.php', 'className' => 'KBContentsConfigApi', 'score' => 8.0, ), ), 'sync_key' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => '<module>', 1 => 'sync_key', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'upsertByField', 'shortHelp' => 'Upsert based on sync_key given from the query params. If the record can be found with sync_key, then update. If the record does not exist, then create it. Recommended use of PATCH HTTP verb.', 'file' => 'clients/base/api/IntegrateApi.php', 'className' => 'IntegrateApi', 'score' => 8.0, ), ), 'MassUpdate' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => '<module>', 1 => 'MassUpdate', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'jsonParams' => array ( 0 => 'filter', ), 'method' => 'massUpdate', 'shortHelp' => 'An API to handle mass update.', 'longHelp' => 'include/api/help/module_massupdate_put_help.html', 'file' => 'clients/base/api/MassUpdateApi.php', 'className' => 'MassUpdateApi', 'score' => 8.0, ), ), '?' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => '<module>', 1 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', ), 'method' => 'updateRecord', 'shortHelp' => 'This method updates a record of the specified type', 'longHelp' => 'include/api/help/module_record_put_help.html', 'file' => 'clients/base/api/ModuleApi.php', 'className' => 'ModuleApi', 'score' => 7.0, ), ), ), 'integrate' => array ( '<module>' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'integrate', 1 => '<module>', ), 'pathVars' => array ( 0 => '', 1 => 'module', ), 'method' => 'upsertByField', 'shortHelp' => 'Upsert based on a field given from the query params. If the record can be found with the provided field, then update. If the record does not exist, then create it. Recommended use of PATCH HTTP verb.', 'file' => 'clients/base/api/IntegrateApi.php', 'className' => 'IntegrateApi', 'score' => 8.0, ), ), ), 'me' => array ( 'password' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'me', 1 => 'password', ), 'pathVars' => array ( 0 => '', ), 'method' => 'updatePassword', 'shortHelp' => 'Updates current user\'s password', 'longHelp' => 'include/api/help/me_password_put_help.html', 'ignoreSystemStatusError' => true, 'file' => 'clients/base/api/CurrentUserApi.php', 'className' => 'CurrentUserApi', 'score' => 8.75, ), ), 'preferences' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'me', 1 => 'preferences', ), 'pathVars' => array ( ), 'method' => 'userPreferencesSave', 'shortHelp' => 'Mass Save Updated Preferences For a User', 'longHelp' => 'include/api/help/me_preferences_put_help.html', 'ignoreSystemStatusError' => true, 'file' => 'clients/base/api/CurrentUserApi.php', 'className' => 'CurrentUserApi', 'score' => 8.75, ), ), 'last_states' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'me', 1 => 'last_states', ), 'pathVars' => array ( 0 => '', 1 => '', ), 'method' => 'updateLastStates', 'shortHelp' => 'Perform an update to the set of last state data for the current user', 'longHelp' => 'include/api/help/me_last_states_put_help.html', 'ignoreSystemStatusError' => true, 'file' => 'clients/base/api/CurrentUserApi.php', 'className' => 'CurrentUserApi', 'score' => 8.75, ), ), ), 'mfa' => array ( 'reset' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'mfa', 1 => 'reset', ), 'pathVars' => array ( 0 => '', 1 => '', ), 'method' => 'mfaReset', 'shortHelp' => 'Reset multi-factor authentication for user', 'longHelp' => 'include/api/help/mfa_reset_help.html', 'minVersion' => '11.13', 'ignoreSystemStatusError' => true, 'file' => 'clients/base/api/CurrentUserApi.php', 'className' => 'CurrentUserApi', 'score' => 8.75, ), ), ), 'hint' => array ( 'config' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'hint', 1 => 'config', ), 'pathVars' => array ( 0 => '', ), 'method' => 'updateConfig', 'shortHelp' => 'Updates Hint configuration', 'longHelp' => 'include/api/help/hint_config_put_help.html', 'minVersion' => '11.16', 'file' => 'clients/base/api/HintApi.php', 'className' => 'HintApi', 'score' => 8.75, ), ), ), 'Opportunities' => array ( '?' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'Opportunities', 1 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', ), 'method' => 'updateRecord', 'shortHelp' => 'This method updates a record of the specified type', 'longHelp' => 'include/api/help/module_record_put_help.html', 'file' => 'modules/Opportunities/clients/base/api/OpportunitiesApi.php', 'className' => 'OpportunitiesApi', 'score' => 7.75, ), ), ), 'Calendar' => array ( '?' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'Calendar', 1 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', ), 'method' => 'updateRecord', 'shortHelp' => 'This method updates a record of the specified type', 'longHelp' => 'include/api/help/module_record_put_help.html', 'file' => 'modules/Calendar/clients/base/api/CalendarModuleApi.php', 'className' => 'CalendarModuleApi', 'score' => 7.75, ), ), ), 'SugarLive' => array ( 'config' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'SugarLive', 1 => 'config', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'configSave', 'shortHelp' => 'Creates the config entries for the SugarLive module', 'longHelp' => 'modules/SugarLive/clients/base/api/help/module_config_post_help.html', 'minVersion' => '11.12', 'file' => 'modules/SugarLive/clients/base/api/SugarLiveConfigModuleApi.php', 'className' => 'SugarLiveConfigModuleApi', 'score' => 8.75, ), ), ), 'KBContents' => array ( 'config' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'KBContents', 1 => 'config', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'configSave', 'shortHelp' => 'Updates the config entries for the KBContents module', 'longHelp' => 'modules/KBContents/clients/base/api/help/kb_config_put_help.html', 'file' => 'modules/KBContents/clients/base/api/KBContentsConfigApi.php', 'className' => 'KBContentsConfigApi', 'score' => 8.75, ), ), ), 'EmailAddresses' => array ( '?' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'EmailAddresses', 1 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', ), 'method' => 'updateRecord', 'shortHelp' => 'This method updates an EmailAddresses record', 'longHelp' => 'modules/EmailAddresses/clients/base/api/help/email_addresses_record_put_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionInvalidParameter', 1 => 'SugarApiExceptionMissingParameter', 2 => 'SugarApiExceptionNotAuthorized', 3 => 'SugarApiExceptionNotFound', ), 'file' => 'modules/EmailAddresses/clients/base/api/EmailAddressesApi.php', 'className' => 'EmailAddressesApi', 'score' => 7.75, ), ), ), 'Emails' => array ( '?' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'Emails', 1 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', ), 'method' => 'updateRecord', 'shortHelp' => 'This method updates an Emails record', 'longHelp' => 'modules/Emails/clients/base/api/help/emails_record_put_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionInvalidParameter', 1 => 'SugarApiExceptionMissingParameter', 2 => 'SugarApiExceptionNotAuthorized', 3 => 'SugarApiExceptionNotFound', 4 => 'SugarApiException', 5 => 'SugarApiExceptionError', ), 'file' => 'modules/Emails/clients/base/api/EmailsApi.php', 'className' => 'EmailsApi', 'score' => 7.75, ), ), ), 'ExternalUsers' => array ( '?' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'ExternalUsers', 1 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', ), 'method' => 'updateRecord', 'shortHelp' => 'This method updates a record of the specified type', 'longHelp' => 'include/api/help/module_record_put_help.html', 'file' => 'modules/ExternalUsers/clients/base/api/ExternalUsersApi.php', 'className' => 'ExternalUsersApi', 'score' => 7.75, ), ), ), 'ConsoleConfiguration' => array ( 'config' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'ConsoleConfiguration', 1 => 'config', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'configSave', 'shortHelp' => 'Creates the config entries for the ConsoleConfiguration module', 'longHelp' => 'modules/ConsoleConfiguration/clients/base/api/help/module_config_post_help.html', 'minVersion' => '11.9', 'file' => 'modules/ConsoleConfiguration/clients/base/api/ConsoleConfigModuleApi.php', 'className' => 'ConsoleConfigModuleApi', 'score' => 8.75, ), ), ), 'Meetings' => array ( '?' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'Meetings', 1 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', ), 'method' => 'updateCalendarEvent', 'shortHelp' => 'This method updates a single event record or a series of event records of the specified type', 'longHelp' => 'include/api/help/calendar_events_record_update_help.html', 'file' => 'modules/Meetings/clients/base/api/MeetingsApi.php', 'className' => 'MeetingsApi', 'score' => 7.75, ), ), ), 'pmse_Project' => array ( '?' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'pmse_Project', 1 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', ), 'method' => 'updateRecord', 'file' => 'modules/pmse_Project/clients/base/api/PMSEProjectCRUDApi.php', 'className' => 'PMSEProjectCRUDApi', 'score' => 7.75, ), ), ), 'DRI_Workflows' => array ( 'config' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'DRI_Workflows', 1 => 'config', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'saveConfigureModules', 'shortHelp' => 'Saves the config for enabled modules of CJ', 'longHelp' => 'include/api/help/customer_journeyDRI_Workflows_config_module_put_help.html', 'minVersion' => '11.18', 'file' => 'modules/DRI_Workflow_Templates/clients/base/api/DRICustomerJourneyConfigApi.php', 'className' => 'DRICustomerJourneyConfigApi', 'score' => 8.75, ), ), ), 'Tags' => array ( '?' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'Tags', 1 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', ), 'method' => 'updateRecord', 'shortHelp' => 'This method updates a record of the specified type', 'longHelp' => 'include/api/help/module_record_put_help.html', 'file' => 'modules/Tags/clients/base/api/TagsApi.php', 'className' => 'TagsApi', 'score' => 7.75, ), ), ), 'Calls' => array ( '?' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'Calls', 1 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', ), 'method' => 'updateCalendarEvent', 'shortHelp' => 'This method updates a single event record or a series of event records of the specified type', 'longHelp' => 'include/api/help/calendar_events_record_update_help.html', 'file' => 'modules/Calls/clients/base/api/CallsApi.php', 'className' => 'CallsApi', 'score' => 7.75, ), ), ), 'PubSub_ModuleEvent_PushSubs' => array ( '?' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'PubSub_ModuleEvent_PushSubs', 1 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', ), 'method' => 'updateRecord', 'minVersion' => '11.20', 'file' => 'modules/PubSub_ModuleEvent_PushSubs/clients/base/api/PubSub_ModuleEvent_PushSubsApi.php', 'className' => 'PubSub_ModuleEvent_PushSubsApi', 'score' => 7.75, ), ), ), 'Users' => array ( '?' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'Users', 1 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', ), 'method' => 'updateUser', 'minVersion' => '11.6', 'shortHelp' => 'This method updates a User record', 'longHelp' => 'modules/Users/clients/base/api/help/UsersApi_update.html', 'ignoreSystemStatusError' => true, 'file' => 'modules/Users/clients/base/api/UsersApi.php', 'className' => 'UsersApi', 'score' => 7.75, ), ), ), 'ForecastWorksheets' => array ( '?' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'ForecastWorksheets', 1 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', ), 'method' => 'forecastWorksheetSave', 'shortHelp' => 'Updates a ForecastWorksheet model', 'longHelp' => 'modules/Forecasts/clients/base/api/help/ForecastWorksheetPut.html', 'file' => 'modules/ForecastWorksheets/clients/base/api/ForecastWorksheetsApi.php', 'className' => 'ForecastWorksheetsApi', 'score' => 7.75, ), ), ), 'OutboundEmail' => array ( '?' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'OutboundEmail', 1 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', ), 'method' => 'updateRecord', 'shortHelp' => 'This method updates an OutboundEmail record', 'longHelp' => 'modules/OutboundEmail/clients/base/api/help/outbound_email_record_put_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionInvalidParameter', 1 => 'SugarApiExceptionMissingParameter', 2 => 'SugarApiExceptionNotAuthorized', 3 => 'SugarApiExceptionNotFound', 4 => 'SugarApiException', ), 'file' => 'modules/OutboundEmail/clients/base/api/OutboundEmailApi.php', 'className' => 'OutboundEmailApi', 'score' => 7.75, ), ), ), 'Forecasts' => array ( 'config' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'Forecasts', 1 => 'config', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'forecastsConfigSave', 'shortHelp' => 'Updates the config entries for the Forecasts module', 'longHelp' => 'modules/Forecasts/clients/base/api/help/ForecastsConfigPut.html', 'file' => 'modules/Forecasts/clients/base/api/ForecastsConfigApi.php', 'className' => 'ForecastsConfigApi', 'score' => 8.75, ), ), ), 'pmse_Inbox' => array ( 'logSetConfig' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'pmse_Inbox', 1 => 'logSetConfig', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'configLogPut', 'acl' => 'adminOrDev', 'file' => 'modules/pmse_Inbox/clients/base/api/PMSECasesListApi.php', 'className' => 'PMSECasesListApi', 'score' => 8.75, ), ), 'engine_route' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'pmse_Inbox', 1 => 'engine_route', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'jsonParams' => array ( 0 => 'filter', ), 'method' => 'engineRoute', 'keepSession' => true, 'shortHelp' => 'Evaluates the response of the user form Show Process [Approve, Reject, Route]', 'longHelp' => 'modules/pmse_Inbox/clients/base/api/help/process_engine_route_help.html', 'file' => 'modules/pmse_Inbox/clients/base/api/PMSEEngineApi.php', 'className' => 'PMSEEngineApi', 'score' => 8.75, ), ), 'engine_claim' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'pmse_Inbox', 1 => 'engine_claim', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'engineClaim', 'keepSession' => true, 'shortHelp' => 'Claims the processes to the current user', 'longHelp' => 'modules/pmse_Inbox/clients/base/api/help/process_engine_claim_help.html', 'file' => 'modules/pmse_Inbox/clients/base/api/PMSEEngineApi.php', 'className' => 'PMSEEngineApi', 'score' => 8.75, ), ), 'ReassignForm' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'pmse_Inbox', 1 => 'ReassignForm', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'reassignRecord', 'keepSession' => true, 'shortHelp' => 'Update the user assigned to the record associated to the process. DEPRECATED', 'longHelp' => 'modules/pmse_Inbox/clients/base/api/help/process_deprecate.html', 'file' => 'modules/pmse_Inbox/clients/base/api/PMSEEngineApi.php', 'className' => 'PMSEEngineApi', 'score' => 8.75, ), ), 'AdhocReassign' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'pmse_Inbox', 1 => 'AdhocReassign', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'adhocReassign', 'keepSession' => true, 'shortHelp' => 'Update the process user associated to the process. DEPRECATED', 'longHelp' => 'modules/pmse_Inbox/clients/base/api/help/process_deprecate.html', 'file' => 'modules/pmse_Inbox/clients/base/api/PMSEEngineApi.php', 'className' => 'PMSEEngineApi', 'score' => 8.75, ), ), 'reactivateFlows' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'pmse_Inbox', 1 => 'reactivateFlows', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'jsonParams' => array ( 0 => 'filter', ), 'method' => 'reactivateFlows', 'keepSession' => true, 'acl' => 'adminOrDev', 'shortHelp' => 'Call methods to re-execute processes. DEPRECATED', 'longHelp' => 'modules/pmse_Inbox/clients/base/api/help/process_deprecate.html', 'file' => 'modules/pmse_Inbox/clients/base/api/PMSEEngineApi.php', 'className' => 'PMSEEngineApi', 'score' => 8.75, ), ), 'reassignFlows' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'pmse_Inbox', 1 => 'reassignFlows', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'jsonParams' => array ( 0 => 'filter', ), 'method' => 'reassignFlows', 'keepSession' => true, 'acl' => 'adminOrDev', 'shortHelp' => 'Call methods to reassign processes', 'longHelp' => 'modules/pmse_Inbox/clients/base/api/help/process_reassign_flows_help.html', 'file' => 'modules/pmse_Inbox/clients/base/api/PMSEEngineApi.php', 'className' => 'PMSEEngineApi', 'score' => 8.75, ), ), 'cancelCases' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'pmse_Inbox', 1 => 'cancelCases', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'jsonParams' => array ( 0 => 'filter', ), 'method' => 'cancelCase', 'keepSession' => true, 'acl' => 'adminOrDev', 'shortHelp' => 'Call methods to cancel a process', 'longHelp' => 'modules/pmse_Inbox/clients/base/api/help/process_cancel_case_help.html', 'file' => 'modules/pmse_Inbox/clients/base/api/PMSEEngineApi.php', 'className' => 'PMSEEngineApi', 'score' => 8.75, ), ), 'settings' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'pmse_Inbox', 1 => 'settings', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'putSettingsEngine', 'keepSession' => true, 'acl' => 'adminOrDev', 'shortHelp' => 'Update settings for the PA engine', 'longHelp' => 'modules/pmse_Inbox/clients/base/api/help/process_put_settings_engine_help.html', 'file' => 'modules/pmse_Inbox/clients/base/api/PMSEEngineApi.php', 'className' => 'PMSEEngineApi', 'score' => 8.75, ), ), ), ), 'DELETE' => array ( '<module>' => array ( 'sync_key' => array ( 0 => array ( 'reqType' => 'DELETE', 'path' => array ( 0 => '<module>', 1 => 'sync_key', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'deleteByField', 'shortHelp' => 'Delete record with given sync_key from the query params.', 'file' => 'clients/base/api/IntegrateApi.php', 'className' => 'IntegrateApi', 'score' => 8.0, ), ), 'MassUpdate' => array ( 0 => array ( 'reqType' => 'DELETE', 'path' => array ( 0 => '<module>', 1 => 'MassUpdate', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'jsonParams' => array ( 0 => 'filter', ), 'method' => 'massDelete', 'shortHelp' => 'An API to handle mass delete.', 'longHelp' => 'include/api/help/module_massupdate_delete_help.html', 'file' => 'clients/base/api/MassUpdateApi.php', 'className' => 'MassUpdateApi', 'score' => 8.0, ), ), 'link_by_sync_keys' => array ( 0 => array ( 'reqType' => 'DELETE', 'path' => array ( 0 => '<module>', 1 => 'link_by_sync_keys', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'unrelateByFields', 'shortHelp' => 'Remove a relationship based on both sync_keys given from the query params. If both the LHS and RHS records can be found with the respective sync_key, and those records are related, then remove the relationship of the RHS record to the LHS record.', 'file' => 'clients/base/api/IntegrateRelateApi.php', 'className' => 'IntegrateRelateApi', 'score' => 8.0, ), ), '?' => array ( 0 => array ( 'reqType' => 'DELETE', 'path' => array ( 0 => '<module>', 1 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', ), 'method' => 'deleteRecord', 'shortHelp' => 'This method deletes a record of the specified type', 'longHelp' => 'include/api/help/module_record_delete_help.html', 'file' => 'clients/base/api/ModuleApi.php', 'className' => 'ModuleApi', 'score' => 7.0, ), ), ), 'integrate' => array ( '<module>' => array ( 0 => array ( 'reqType' => 'DELETE', 'path' => array ( 0 => 'integrate', 1 => '<module>', ), 'pathVars' => array ( 0 => '', 1 => 'module', ), 'method' => 'deleteByField', 'shortHelp' => 'Delete record with given field from the query params.', 'file' => 'clients/base/api/IntegrateApi.php', 'className' => 'IntegrateApi', 'score' => 8.0, ), ), ), 'CloudDrive' => array ( 'path' => array ( 0 => array ( 'reqType' => 'DELETE', 'path' => array ( 0 => 'CloudDrive', 1 => 'path', ), 'pathVars' => array ( 0 => 'CloudDrive', 1 => 'path', ), 'method' => 'removeDrivePath', 'shortHelp' => 'removes a drive path', 'longHelp' => 'include/api/help/cloud_drive_remove_path.html', 'exceptions' => array ( 0 => 'SugarApiExceptionInvalidParameter', 1 => 'SugarApiExceptionNotFound', 2 => 'SugarQueryException', ), 'minVersion' => '11.16', 'file' => 'clients/base/api/CloudDriveApi.php', 'className' => 'CloudDriveApi', 'score' => 8.75, ), ), ), 'Meetings' => array ( '?' => array ( 0 => array ( 'reqType' => 'DELETE', 'path' => array ( 0 => 'Meetings', 1 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', ), 'method' => 'deleteCalendarEvent', 'shortHelp' => 'This method deletes a single event record or a series of event records of the specified type', 'longHelp' => 'include/api/help/calendar_events_record_delete_help.html', 'file' => 'modules/Meetings/clients/base/api/MeetingsApi.php', 'className' => 'MeetingsApi', 'score' => 7.75, ), ), ), 'pmse_Project' => array ( '?' => array ( 0 => array ( 'reqType' => 'DELETE', 'path' => array ( 0 => 'pmse_Project', 1 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', ), 'method' => 'deleteRecord', 'file' => 'modules/pmse_Project/clients/base/api/PMSEProjectCRUDApi.php', 'className' => 'PMSEProjectCRUDApi', 'score' => 7.75, ), ), ), 'Calls' => array ( '?' => array ( 0 => array ( 'reqType' => 'DELETE', 'path' => array ( 0 => 'Calls', 1 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', ), 'method' => 'deleteCalendarEvent', 'shortHelp' => 'This method deletes a single event record or a series of event records of the specified type', 'longHelp' => 'include/api/help/calendar_events_record_delete_help.html', 'file' => 'modules/Calls/clients/base/api/CallsApi.php', 'className' => 'CallsApi', 'score' => 7.75, ), ), ), 'PubSub_ModuleEvent_PushSubs' => array ( '?' => array ( 0 => array ( 'reqType' => 'DELETE', 'path' => array ( 0 => 'PubSub_ModuleEvent_PushSubs', 1 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', ), 'method' => 'deleteRecord', 'minVersion' => '11.20', 'file' => 'modules/PubSub_ModuleEvent_PushSubs/clients/base/api/PubSub_ModuleEvent_PushSubsApi.php', 'className' => 'PubSub_ModuleEvent_PushSubsApi', 'score' => 7.75, ), ), ), 'Users' => array ( '?' => array ( 0 => array ( 'reqType' => 'DELETE', 'path' => array ( 0 => 'Users', 1 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', ), 'method' => 'deleteUser', 'shortHelp' => 'This method deletes a User record', 'longHelp' => 'modules/Users/clients/base/api/help/UsersApi.html', 'ignoreSystemStatusError' => true, 'file' => 'modules/Users/clients/base/api/UsersApi.php', 'className' => 'UsersApi', 'score' => 7.75, ), ), ), ), 'PATCH' => array ( '<module>' => array ( 'sync_key' => array ( 0 => array ( 'reqType' => 'PATCH', 'path' => array ( 0 => '<module>', 1 => 'sync_key', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'upsertByField', 'shortHelp' => 'Upsert based on sync_key given from the query params. If the record can be found with sync_key, then update. If the record does not exist, then create it. Recommended use of PATCH HTTP verb.', 'file' => 'clients/base/api/IntegrateApi.php', 'className' => 'IntegrateApi', 'score' => 8.0, ), ), ), 'integrate' => array ( '<module>' => array ( 0 => array ( 'reqType' => 'PATCH', 'path' => array ( 0 => 'integrate', 1 => '<module>', ), 'pathVars' => array ( 0 => '', 1 => 'module', ), 'method' => 'upsertByField', 'shortHelp' => 'Upsert based on a field given from the query params. If the record can be found with the provided field, then update. If the record does not exist, then create it. Recommended use of PATCH HTTP verb.', 'file' => 'clients/base/api/IntegrateApi.php', 'className' => 'IntegrateApi', 'score' => 8.0, ), ), ), ), '?' => array ( 'KBDocuments' => array ( '?' => array ( 0 => array ( 'reqType' => '?', 'path' => array ( 0 => 'KBDocuments', 1 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'extraScore' => 1, 'method' => 'disableApi', 'shortHelp' => 'Disable KBDocuments', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', ), 'file' => 'modules/KBContents/clients/base/api/KBContentsApi.php', 'className' => 'KBContentsApi', 'score' => 7.75, ), ), ), 'KBArticles' => array ( '?' => array ( 0 => array ( 'reqType' => '?', 'path' => array ( 0 => 'KBArticles', 1 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'extraScore' => 1, 'method' => 'disableApi', 'shortHelp' => 'Disable KBArticles', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', ), 'file' => 'modules/KBContents/clients/base/api/KBContentsApi.php', 'className' => 'KBContentsApi', 'score' => 7.75, ), ), ), ), ), 'mobile' => array ( 'POST' => array ( 'oauth2' => array ( 'token' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'oauth2', 1 => 'token', ), 'pathVars' => array ( 0 => '', 1 => '', ), 'method' => 'token', 'shortHelp' => 'OAuth2 token requests.', 'longHelp' => 'include/api/help/oauth2_token_post_help.html', 'noLoginRequired' => true, 'keepSession' => true, 'ignoreMetaHash' => true, 'ignoreSystemStatusError' => true, 'file' => 'clients/mobile/api/OAuth2MobileApi.php', 'className' => 'OAuth2MobileApi', 'score' => 8.75, ), ), 'logout' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'oauth2', 1 => 'logout', ), 'pathVars' => array ( 0 => '', 1 => '', ), 'method' => 'logout', 'shortHelp' => 'OAuth2 logout.', 'longHelp' => 'include/api/help/oauth2_logout_post_help.html', 'keepSession' => true, 'ignoreMetaHash' => true, 'ignoreSystemStatusError' => true, 'file' => 'clients/mobile/api/OAuth2MobileApi.php', 'className' => 'OAuth2MobileApi', 'score' => 8.75, ), ), ), 'me' => array ( 'password' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'me', 1 => 'password', ), 'pathVars' => array ( 0 => '', ), 'method' => 'verifyPassword', 'shortHelp' => 'Verifies current user\'s password', 'longHelp' => 'include/api/help/me_password_post_help.html', 'ignoreSystemStatusError' => true, 'file' => 'clients/mobile/api/CurrentUserMobileApi.php', 'className' => 'CurrentUserMobileApi', 'score' => 8.75, ), ), ), ), 'PUT' => array ( 'me' => array ( 'password' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'me', 1 => 'password', ), 'pathVars' => array ( 0 => '', ), 'method' => 'updatePassword', 'shortHelp' => 'Updates current user\'s password', 'longHelp' => 'include/api/help/me_password_put_help.html', 'ignoreSystemStatusError' => true, 'file' => 'clients/mobile/api/CurrentUserMobileApi.php', 'className' => 'CurrentUserMobileApi', 'score' => 8.75, ), ), 'preferences' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'me', 1 => 'preferences', ), 'pathVars' => array ( ), 'method' => 'userPreferencesSave', 'shortHelp' => 'Mass Save Updated Preferences For a User', 'longHelp' => 'include/api/help/me_preferences_put_help.html', 'ignoreSystemStatusError' => true, 'file' => 'clients/mobile/api/CurrentUserMobileApi.php', 'className' => 'CurrentUserMobileApi', 'score' => 8.75, ), ), 'last_states' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'me', 1 => 'last_states', ), 'pathVars' => array ( 0 => '', 1 => '', ), 'method' => 'updateLastStates', 'shortHelp' => 'Perform an update to the set of last state data for the current user', 'longHelp' => 'include/api/help/me_last_states_put_help.html', 'ignoreSystemStatusError' => true, 'file' => 'clients/mobile/api/CurrentUserMobileApi.php', 'className' => 'CurrentUserMobileApi', 'score' => 8.75, ), ), ), 'mfa' => array ( 'reset' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'mfa', 1 => 'reset', ), 'pathVars' => array ( 0 => '', 1 => '', ), 'method' => 'mfaReset', 'shortHelp' => 'Reset multi-factor authentication for user', 'longHelp' => 'include/api/help/mfa_reset_help.html', 'minVersion' => '11.13', 'ignoreSystemStatusError' => true, 'file' => 'clients/mobile/api/CurrentUserMobileApi.php', 'className' => 'CurrentUserMobileApi', 'score' => 8.75, ), ), ), ), 'GET' => array ( 'me' => array ( 'preferences' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'me', 1 => 'preferences', ), 'pathVars' => array ( ), 'method' => 'userPreferences', 'shortHelp' => 'Returns all the current user\'s stored preferences', 'longHelp' => 'include/api/help/me_preferences_get_help.html', 'ignoreMetaHash' => true, 'ignoreSystemStatusError' => true, 'file' => 'clients/mobile/api/CurrentUserMobileApi.php', 'className' => 'CurrentUserMobileApi', 'score' => 8.75, ), ), 'following' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'me', 1 => 'following', ), 'pathVars' => array ( 0 => '', 1 => '', ), 'method' => 'getMyFollowedRecords', 'shortHelp' => 'This method retrieves all followed methods for the user.', 'longHelp' => 'include/api/help/me_getfollowed_help.html', 'ignoreSystemStatusError' => true, 'file' => 'clients/mobile/api/CurrentUserMobileApi.php', 'className' => 'CurrentUserMobileApi', 'score' => 8.75, ), ), 'last_states' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'me', 1 => 'last_states', ), 'pathVars' => array ( 0 => '', 1 => '', ), 'method' => 'retrieveLastStates', 'ignoreMetaHash' => true, 'shortHelp' => 'Retrieve the set of last state data for the current user', 'longHelp' => 'include/api/help/me_last_states_get_help.html', 'ignoreSystemStatusError' => true, 'file' => 'clients/mobile/api/CurrentUserMobileApi.php', 'className' => 'CurrentUserMobileApi', 'score' => 8.75, ), ), 'plugins' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'me', 1 => 'plugins', ), 'pathVars' => array ( 0 => '', ), 'method' => 'getPlugins', 'shortHelp' => 'Retrieves a list of all Sugar plugins available for Word, Excel, etc.', 'longHelp' => 'include/api/help/plugins_get_help.html', 'minVersion' => '11.23', 'file' => 'clients/mobile/api/CurrentUserMobileApi.php', 'className' => 'CurrentUserMobileApi', 'score' => 8.75, ), ), ), ), ), 'portal' => array ( 'GET' => array ( '<module>' => array ( 'globalsearch' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', 1 => 'globalsearch', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'globalSearchPortal', 'shortHelp' => 'Global search', 'exceptions' => array ( 0 => 'SugarApiExceptionNoMethod', ), 'file' => 'clients/portal/api/GlobalSearchPortalApi.php', 'className' => 'GlobalSearchPortalApi', 'score' => 8.0, ), ), 'filter' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', 1 => 'filter', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'filterList', 'jsonParams' => array ( 0 => 'filter', ), 'shortHelp' => 'Lists filtered records.', 'longHelp' => 'include/api/help/module_filter_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionInvalidParameter', 3 => 'SugarApiExceptionNotAuthorized', ), 'file' => 'clients/portal/api/FilterPortalApi.php', 'className' => 'FilterPortalApi', 'score' => 8.0, ), ), 'count' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', 1 => 'count', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'jsonParams' => array ( 0 => 'filter', ), 'method' => 'getFilterListCount', 'shortHelp' => 'List of all records in this module', 'longHelp' => 'include/api/help/module_filter_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionNotAuthorized', 3 => 'SugarApiExceptionInvalidParameter', ), 'file' => 'clients/portal/api/FilterPortalApi.php', 'className' => 'FilterPortalApi', 'score' => 8.0, ), ), 'total' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', 1 => 'total', ), 'pathVars' => array ( 0 => 'module', 1 => '', 2 => '', ), 'method' => 'getFilterListSum', 'shortHelp' => 'Lists field sum by filtered records.', 'longHelp' => 'include/api/help/module_sum_by_filter_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionNotAuthorized', 3 => 'SugarApiExceptionInvalidParameter', ), 'minVersion' => '11.21', 'file' => 'clients/portal/api/FilterPortalApi.php', 'className' => 'FilterPortalApi', 'score' => 8.0, ), ), ), 'me' => array ( 'preferences' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'me', 1 => 'preferences', ), 'pathVars' => array ( ), 'method' => 'userPreferences', 'shortHelp' => 'Returns all the current user\'s stored preferences', 'longHelp' => 'include/api/help/me_preferences_get_help.html', 'ignoreMetaHash' => true, 'ignoreSystemStatusError' => true, 'file' => 'clients/portal/api/CurrentUserPortalApi.php', 'className' => 'CurrentUserPortalApi', 'score' => 8.75, ), ), 'following' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'me', 1 => 'following', ), 'pathVars' => array ( 0 => '', 1 => '', ), 'method' => 'getMyFollowedRecords', 'shortHelp' => 'This method retrieves all followed methods for the user.', 'longHelp' => 'include/api/help/me_getfollowed_help.html', 'ignoreSystemStatusError' => true, 'file' => 'clients/portal/api/CurrentUserPortalApi.php', 'className' => 'CurrentUserPortalApi', 'score' => 8.75, ), ), 'last_states' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'me', 1 => 'last_states', ), 'pathVars' => array ( 0 => '', 1 => '', ), 'method' => 'retrieveLastStates', 'ignoreMetaHash' => true, 'shortHelp' => 'Retrieve the set of last state data for the current user', 'longHelp' => 'include/api/help/me_last_states_get_help.html', 'ignoreSystemStatusError' => true, 'file' => 'clients/portal/api/CurrentUserPortalApi.php', 'className' => 'CurrentUserPortalApi', 'score' => 8.75, ), ), 'plugins' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'me', 1 => 'plugins', ), 'pathVars' => array ( 0 => '', ), 'method' => 'getPlugins', 'shortHelp' => 'Retrieves a list of all Sugar plugins available for Word, Excel, etc.', 'longHelp' => 'include/api/help/plugins_get_help.html', 'minVersion' => '11.23', 'file' => 'clients/portal/api/CurrentUserPortalApi.php', 'className' => 'CurrentUserPortalApi', 'score' => 8.75, ), ), ), 'password' => array ( 'resetemail' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'password', 1 => 'resetemail', ), 'pathVars' => array ( ), 'method' => 'resetEmailPortalPassword', 'shortHelp' => 'This method sends email requests to reset passwords for Portal users', 'longHelp' => 'include/api/help/portal_password_reset_email_get_help.html', 'noLoginRequired' => true, 'ignoreSystemStatusError' => true, 'minVersion' => '11.6', 'file' => 'clients/portal/api/PortalPasswordApi.php', 'className' => 'PortalPasswordApi', 'score' => 8.75, ), ), ), ), 'POST' => array ( '<module>' => array ( 'globalsearch' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => '<module>', 1 => 'globalsearch', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'globalSearchPortal', 'shortHelp' => 'Global search', 'exceptions' => array ( 0 => 'SugarApiExceptionNoMethod', ), 'file' => 'clients/portal/api/GlobalSearchPortalApi.php', 'className' => 'GlobalSearchPortalApi', 'score' => 8.0, ), ), 'filter' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => '<module>', 1 => 'filter', ), 'pathVars' => array ( 0 => 'module', 1 => '', ), 'method' => 'filterList', 'shortHelp' => 'Lists filtered records.', 'longHelp' => 'include/api/help/module_filter_post_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionInvalidParameter', 3 => 'SugarApiExceptionNotAuthorized', ), 'file' => 'clients/portal/api/FilterPortalApi.php', 'className' => 'FilterPortalApi', 'score' => 8.0, ), ), ), 'Contacts' => array ( 'register' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Contacts', 1 => 'register', ), 'pathVars' => array ( 0 => 'module', ), 'method' => 'createContactRecord', 'shortHelp' => 'This method registers contacts', 'longHelp' => 'include/api/help/contacts_register_post_help.html', 'noLoginRequired' => true, 'minVersion' => '11.6', 'file' => 'clients/portal/api/RegisterContactApi.php', 'className' => 'RegisterContactApi', 'score' => 8.75, ), ), ), 'me' => array ( 'password' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'me', 1 => 'password', ), 'pathVars' => array ( 0 => '', ), 'method' => 'verifyPassword', 'shortHelp' => 'Verifies current user\'s password', 'longHelp' => 'include/api/help/me_password_post_help.html', 'ignoreSystemStatusError' => true, 'file' => 'clients/portal/api/CurrentUserPortalApi.php', 'className' => 'CurrentUserPortalApi', 'score' => 8.75, ), ), ), ), 'PUT' => array ( 'me' => array ( 'password' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'me', 1 => 'password', ), 'pathVars' => array ( 0 => '', ), 'method' => 'updatePassword', 'shortHelp' => 'Updates current user\'s password', 'longHelp' => 'include/api/help/me_password_put_help.html', 'ignoreSystemStatusError' => true, 'file' => 'clients/portal/api/CurrentUserPortalApi.php', 'className' => 'CurrentUserPortalApi', 'score' => 8.75, ), ), 'preferences' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'me', 1 => 'preferences', ), 'pathVars' => array ( ), 'method' => 'userPreferencesSave', 'shortHelp' => 'Mass Save Updated Preferences For a User', 'longHelp' => 'include/api/help/me_preferences_put_help.html', 'ignoreSystemStatusError' => true, 'file' => 'clients/portal/api/CurrentUserPortalApi.php', 'className' => 'CurrentUserPortalApi', 'score' => 8.75, ), ), 'last_states' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'me', 1 => 'last_states', ), 'pathVars' => array ( 0 => '', 1 => '', ), 'method' => 'updateLastStates', 'shortHelp' => 'Perform an update to the set of last state data for the current user', 'longHelp' => 'include/api/help/me_last_states_put_help.html', 'ignoreSystemStatusError' => true, 'file' => 'clients/portal/api/CurrentUserPortalApi.php', 'className' => 'CurrentUserPortalApi', 'score' => 8.75, ), ), ), 'mfa' => array ( 'reset' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'mfa', 1 => 'reset', ), 'pathVars' => array ( 0 => '', 1 => '', ), 'method' => 'mfaReset', 'shortHelp' => 'Reset multi-factor authentication for user', 'longHelp' => 'include/api/help/mfa_reset_help.html', 'minVersion' => '11.13', 'ignoreSystemStatusError' => true, 'file' => 'clients/portal/api/CurrentUserPortalApi.php', 'className' => 'CurrentUserPortalApi', 'score' => 8.75, ), ), ), 'portal_password' => array ( 'reset' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'portal_password', 1 => 'reset', ), 'pathVars' => array ( ), 'method' => 'resetPassword', 'shortHelp' => 'This method resets the password of a portal user associated with a password reset token', 'longHelp' => 'include/api/help/portal_password_reset_put_help.html', 'noLoginRequired' => true, 'ignoreSystemStatusError' => true, 'minVersion' => '11.6', 'file' => 'clients/portal/api/PortalPasswordApi.php', 'className' => 'PortalPasswordApi', 'score' => 8.75, ), ), ), ), ), ), 1 => array ( 'base' => array ( 'GET' => array ( 'Users' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Users', ), 'jsonParams' => array ( 0 => 'filter', ), 'pathVars' => array ( 0 => 'module_list', ), 'method' => 'filterList', 'shortHelp' => 'Search User records', 'longHelp' => 'include/api/help/module_filter_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionInvalidParameter', 1 => 'SugarApiExceptionNotAuthorized', 2 => 'SugarApiExceptionError', ), 'file' => 'clients/base/api/PersonFilterApi.php', 'className' => 'PersonFilterApi', 'score' => 7.0, ), ), 'Employees' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Employees', ), 'jsonParams' => array ( 0 => 'filter', ), 'pathVars' => array ( 0 => 'module_list', ), 'method' => 'filterList', 'shortHelp' => 'Search Employee records', 'longHelp' => 'include/api/help/module_filter_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionInvalidParameter', 1 => 'SugarApiExceptionNotAuthorized', 2 => 'SugarApiExceptionError', ), 'file' => 'clients/base/api/PersonFilterApi.php', 'className' => 'PersonFilterApi', 'score' => 7.0, ), ), '<module>' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', ), 'pathVars' => array ( 0 => 'module', ), 'method' => 'filterList', 'jsonParams' => array ( 0 => 'filter', ), 'shortHelp' => 'List of all records in this module', 'longHelp' => 'include/api/help/module_filter_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionInvalidParameter', 3 => 'SugarApiExceptionNotAuthorized', ), 'file' => 'clients/base/api/FilterApi.php', 'className' => 'FilterApi', 'score' => 6.25, ), 1 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', ), 'pathVars' => array ( 0 => 'module', ), 'method' => 'filterList', 'jsonParams' => array ( 0 => 'filter', ), 'shortHelp' => 'List of all records in this module', 'longHelp' => 'include/api/help/module_filter_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionInvalidParameter', 3 => 'SugarApiExceptionNotAuthorized', ), 'file' => 'modules/pmse_Project/clients/base/api/PMSEFilterOutboundEmailsApi.php', 'className' => 'PMSEFilterOutboundEmailsApi', 'score' => 6.25, ), 2 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', ), 'pathVars' => array ( 0 => 'module', ), 'method' => 'filterList', 'jsonParams' => array ( 0 => 'filter', ), 'shortHelp' => 'List of all records in this module', 'longHelp' => 'include/api/help/module_filter_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionInvalidParameter', 3 => 'SugarApiExceptionNotAuthorized', ), 'file' => 'modules/DataArchiver/clients/base/api/DataArchiverFilterApi.php', 'className' => 'DataArchiverFilterApi', 'score' => 6.25, ), ), 'recent' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'recent', ), 'pathVars' => array ( 0 => '', 1 => '', ), 'method' => 'getRecentlyViewed', 'shortHelp' => 'This method retrieves recently viewed records for the user.', 'longHelp' => 'include/api/help/me_recently_viewed_help.html', 'file' => 'clients/base/api/RecentApi.php', 'className' => 'RecentApi', 'score' => 7.0, ), ), 'metadata' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'metadata', ), 'pathVars' => array ( 0 => '', ), 'method' => 'getAllMetadata', 'shortHelp' => 'This method will return all metadata for the system', 'longHelp' => 'include/api/html/metadata_all_help.html', 'noEtag' => true, 'ignoreMetaHash' => true, 'ignoreSystemStatusError' => true, 'file' => 'clients/base/api/MetadataApi.php', 'className' => 'MetadataApi', 'score' => 7.0, ), ), 'dropdownsStyle' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'dropdownsStyle', ), 'pathVars' => array ( 0 => '', ), 'method' => 'getDropdownsStyle', 'shortHelp' => 'Returns the dropdowns style for the application', 'longHelp' => 'include/api/html/dropdowns_style_get_help.html', 'rawReply' => true, 'noEtag' => true, 'ignoreMetaHash' => true, 'ignoreSystemStatusError' => true, 'noLoginRequired' => true, 'minVersion' => '11.25', 'file' => 'clients/base/api/MetadataApi.php', 'className' => 'MetadataApi', 'score' => 7.0, ), ), 'VCardDownload' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'VCardDownload', ), 'pathVars' => array ( 0 => '', ), 'method' => 'vCardSave', 'rawReply' => true, 'allowDownloadCookie' => true, 'shortHelp' => 'An API to download a contact as a vCard.', 'longHelp' => 'include/api/help/vcarddownload_get_help.html', 'file' => 'clients/base/api/vCardApi.php', 'className' => 'vCardApi', 'score' => 7.0, ), ), 'rssfeed' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'rssfeed', ), 'pathVars' => array ( ), 'method' => 'getFeed', 'shortHelp' => 'Consumes an RSS Feed and returns the content of the feed to the client', 'longHelp' => 'include/api/help/rssfeed_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionInvalidParameter', 1 => 'SugarApiExceptionConnectorResponse', ), 'file' => 'clients/base/api/RSSFeedApi.php', 'className' => 'RSSFeedApi', 'score' => 7.0, ), ), 'prospect_lists_prospects' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'prospect_lists_prospects', ), 'pathVars' => array ( 0 => '', 1 => '', ), 'method' => 'getProspectListsProspects', 'shortHelp' => 'Gets prospect_list_prospects (from a given date)', 'longHelp' => 'include/api/help/prospect_lists_prospects.html', 'exceptions' => array ( 0 => 'SugarApiExceptionInvalidParameter', ), 'file' => 'clients/base/api/SalesFusionApi.php', 'className' => 'SalesFusionApi', 'score' => 7.0, ), ), 'globalsearch' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'globalsearch', ), 'pathVars' => array ( 0 => '', ), 'method' => 'globalSearch', 'shortHelp' => 'Global search', 'longHelp' => 'include/api/help/globalsearch_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotAuthorized', 1 => 'SugarApiExceptionSearchUnavailable', 2 => 'SugarApiExceptionSearchRuntime', ), 'file' => 'clients/base/api/GlobalSearchApi.php', 'className' => 'GlobalSearchApi', 'score' => 7.0, ), ), 'connectors' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'connectors', ), 'pathVars' => array ( 0 => 'connectors', ), 'method' => 'getConnectors', 'shortHelp' => 'Gets connector information', 'longHelp' => 'include/api/help/connectors_get_help.html', 'file' => 'clients/base/api/ConnectorApi.php', 'className' => 'ConnectorApi', 'score' => 7.0, ), ), 'ping' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'ping', ), 'pathVars' => array ( 0 => '', ), 'method' => 'ping', 'shortHelp' => 'An example API only responds with pong', 'longHelp' => 'include/api/help/ping_get_help.html', 'ignoreSystemStatusError' => true, 'file' => 'clients/base/api/PingApi.php', 'className' => 'PingApi', 'score' => 7.0, ), ), 'search' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'search', ), 'pathVars' => array ( 0 => '', ), 'method' => 'globalSearch', 'jsonParams' => array ( 0 => 'fields', ), 'shortHelp' => 'Globally search records', 'longHelp' => 'include/api/help/module_get_help.html', 'file' => 'clients/base/api/UnifiedSearchApi.php', 'className' => 'UnifiedSearchApi', 'score' => 7.0, ), ), 'me' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'me', ), 'pathVars' => array ( ), 'method' => 'retrieveCurrentUser', 'shortHelp' => 'Returns current user', 'longHelp' => 'include/api/help/me_get_help.html', 'ignoreMetaHash' => true, 'ignoreSystemStatusError' => true, 'noEtag' => true, 'file' => 'clients/base/api/CurrentUserApi.php', 'className' => 'CurrentUserApi', 'score' => 7.0, ), ), 'genericsearch' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'genericsearch', ), 'pathVars' => array ( 0 => '', ), 'method' => 'genericSearch', 'shortHelp' => 'Generic search', 'longHelp' => 'include/api/help/generic_search_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotAuthorized', 1 => 'SugarApiExceptionSearchUnavailable', 2 => 'SugarApiExceptionSearchRuntime', 3 => 'SugarApiExceptionMissingParameter', 4 => 'SugarApiExceptionRequestMethodFailure', 5 => 'SugarApiExceptionInvalidParameter', ), 'file' => 'clients/base/api/GenericSearchApi.php', 'className' => 'GenericSearchApi', 'score' => 7.0, ), ), 'help' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'help', ), 'pathVars' => array ( 0 => '', ), 'method' => 'getHelp', 'shortHelp' => 'Shows Help information', 'longHelp' => 'include/api/help/help_get_help.html', 'rawReply' => true, 'noLoginRequired' => true, 'file' => 'clients/base/api/HelpApi.php', 'className' => 'HelpApi', 'score' => 7.0, ), ), 'locale' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'locale', ), 'pathVars' => array ( ), 'method' => 'localeOptions', 'shortHelp' => 'Gets locale options so UI can populate the corresponding dropdowns', 'longHelp' => 'include/api/help/locale_options_get_help.html', 'ignoreMetaHash' => true, 'keepSession' => true, 'file' => 'clients/base/api/LocaleApi.php', 'className' => 'LocaleApi', 'score' => 7.0, ), ), 'css' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'css', ), 'pathVars' => array ( 0 => '', ), 'method' => 'getCSSURLs', 'shortHelp' => 'Get (or generate) the css files for a platform and a theme', 'longHelp' => 'include/api/help/css_get_help.html', 'noLoginRequired' => true, 'file' => 'clients/base/api/ThemeApi.php', 'className' => 'ThemeApi', 'score' => 7.0, ), ), 'theme' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'theme', ), 'pathVars' => array ( 0 => '', ), 'method' => 'getCustomThemeVars', 'shortHelp' => 'Get the customizable variables of a custom theme', 'longHelp' => 'include/api/help/theme_get_help.html', 'noLoginRequired' => true, 'file' => 'clients/base/api/ThemeApi.php', 'className' => 'ThemeApi', 'score' => 7.0, ), ), 'Opportunities' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Opportunities', ), 'pathVars' => array ( 0 => 'module', ), 'method' => 'filterList', 'jsonParams' => array ( 0 => 'filter', ), 'shortHelp' => 'List of all records in this module', 'longHelp' => 'include/api/help/module_filter_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionInvalidParameter', 3 => 'SugarApiExceptionNotAuthorized', ), 'file' => 'modules/Opportunities/clients/base/api/OpportunitiesFilterApi.php', 'className' => 'OpportunitiesFilterApi', 'score' => 7.0, ), ), 'Filters' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Filters', ), 'pathVars' => array ( 0 => 'module', ), 'method' => 'filterList', 'jsonParams' => array ( 0 => 'filter', ), 'shortHelp' => 'List of all records in this module', 'longHelp' => 'include/api/help/module_filter_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionInvalidParameter', 3 => 'SugarApiExceptionNotAuthorized', ), 'cacheEtag' => true, 'file' => 'modules/Filters/clients/base/api/FiltersFilterApi.php', 'className' => 'FiltersFilterApi', 'score' => 7.0, ), ), 'KBContents' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'KBContents', ), 'pathVars' => array ( 0 => 'module', ), 'method' => 'filterList', 'jsonParams' => array ( 0 => 'filter', ), 'shortHelp' => 'List of all records in this module', 'longHelp' => 'include/api/help/module_filter_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionInvalidParameter', 3 => 'SugarApiExceptionNotAuthorized', ), 'file' => 'modules/KBContents/clients/base/api/KBContentsFilterApi.php', 'className' => 'KBContentsFilterApi', 'score' => 7.0, ), ), 'ForecastManagerWorksheets' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'ForecastManagerWorksheets', ), 'pathVars' => array ( 0 => 'module', ), 'method' => 'ForecastManagerWorksheetsGet', 'jsonParams' => array ( ), 'shortHelp' => 'Filter records from a single module', 'longHelp' => 'modules/Forecasts/clients/base/api/help/ForecastManagerWorksheetGet.html', 'exceptions' => array ( 0 => 'SugarApiExceptionError', 1 => 'SugarApiExceptionInvalidParameter', 2 => 'SugarApiExceptionNotFound', ), 'file' => 'modules/ForecastManagerWorksheets/clients/base/api/ForecastManagerWorksheetsFilterApi.php', 'className' => 'ForecastManagerWorksheetsFilterApi', 'score' => 7.0, ), ), 'TimePeriods' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'TimePeriods', ), 'pathVars' => array ( 0 => 'module', ), 'method' => 'filterList', 'jsonParams' => array ( 0 => 'filter', ), 'shortHelp' => 'List of all records in this module', 'longHelp' => 'include/api/help/module_filter_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionInvalidParameter', 3 => 'SugarApiExceptionNotAuthorized', ), 'file' => 'modules/TimePeriods/clients/base/api/TimePeriodsFilterApi.php', 'className' => 'TimePeriodsFilterApi', 'score' => 7.0, ), ), 'Emails' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Emails', ), 'pathVars' => array ( 0 => 'module', ), 'method' => 'filterList', 'jsonParams' => array ( 0 => 'filter', ), 'shortHelp' => 'List of all records in this module', 'longHelp' => 'modules/Emails/clients/base/api/help/emails_filter_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionInvalidParameter', 3 => 'SugarApiExceptionNotAuthorized', ), 'file' => 'modules/Emails/clients/base/api/EmailsFilterApi.php', 'className' => 'EmailsFilterApi', 'score' => 7.0, ), ), 'Dashboards' => array ( 0 => array ( 'reqType' => 'GET', 'minVersion' => '10', 'maxVersion' => '10', 'path' => array ( 0 => 'Dashboards', ), 'pathVars' => array ( 0 => '', ), 'method' => 'getDashboards', 'shortHelp' => 'Get dashboards for home', 'longHelp' => 'include/api/help/get_home_dashboards.html', 'exceptions' => array ( 0 => 'SugarApiExceptionInvalidParameter', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionNotAuthorized', ), 'file' => 'modules/Dashboards/clients/base/api/DashboardListApi.php', 'className' => 'DashboardListApi', 'score' => 7.0, ), 1 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Dashboards', ), 'pathVars' => array ( 0 => 'module', ), 'method' => 'filterList', 'jsonParams' => array ( 0 => 'filter', ), 'shortHelp' => 'List of all records in this module', 'longHelp' => 'include/api/help/module_filter_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionInvalidParameter', 3 => 'SugarApiExceptionNotAuthorized', ), 'file' => 'modules/Dashboards/clients/base/api/DashboardsFilterApi.php', 'className' => 'DashboardsFilterApi', 'score' => 7.0, ), ), 'Metrics' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Metrics', ), 'pathVars' => array ( 0 => 'module', ), 'method' => 'filterList', 'jsonParams' => array ( 0 => 'filter', ), 'shortHelp' => 'List of all records in this module', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionInvalidParameter', 3 => 'SugarApiExceptionNotAuthorized', ), 'file' => 'modules/Metrics/clients/base/api/MetricsFilterApi.php', 'className' => 'MetricsFilterApi', 'score' => 7.0, ), ), 'pmse_Project' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'pmse_Project', ), 'pathVars' => array ( 0 => 'module', ), 'method' => 'filterList', 'jsonParams' => array ( 0 => 'filter', ), 'shortHelp' => 'List of all records in this module', 'longHelp' => 'include/api/help/module_filter_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionInvalidParameter', 3 => 'SugarApiExceptionNotAuthorized', ), 'file' => 'modules/pmse_Project/clients/base/api/PMSEProjectFilterApi.php', 'className' => 'PMSEProjectFilterApi', 'score' => 7.0, ), ), 'Activities' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Activities', ), 'pathVars' => array ( 0 => '', ), 'method' => 'getHomeActivities', 'shortHelp' => 'This method gets homepage activities for a user', 'longHelp' => 'modules/ActivityStream/clients/base/api/help/homeActivities.html', 'file' => 'modules/ActivityStream/clients/base/api/ActivitiesApi.php', 'className' => 'ActivitiesApi', 'score' => 7.0, ), ), 'DocuSignEnvelopes' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'DocuSignEnvelopes', ), 'pathVars' => array ( 0 => 'module', ), 'method' => 'filterList', 'jsonParams' => array ( 0 => 'filter', ), 'shortHelp' => 'List of all records in this module', 'longHelp' => 'include/api/help/module_filter_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionInvalidParameter', 1 => 'SugarApiExceptionNotAuthorized', ), 'minVersion' => '11.16', 'file' => 'modules/DocuSignEnvelopes/clients/base/api/DocuSignEnvelopesFilterApi.php', 'className' => 'DocuSignEnvelopesFilterApi', 'score' => 7.0, ), ), 'CommentLog' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'CommentLog', ), 'pathVars' => array ( 0 => 'module', ), 'method' => 'accessBlocker', 'shortHelp' => 'This method is not available', 'file' => 'modules/CommentLog/clients/base/api/CommentLogApi.php', 'className' => 'CommentLogApi', 'score' => 7.0, ), ), 'Notes' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Notes', ), 'pathVars' => array ( 0 => 'module', ), 'method' => 'filterList', 'jsonParams' => array ( 0 => 'filter', ), 'shortHelp' => 'List of all records in this module', 'longHelp' => 'include/api/help/module_filter_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionInvalidParameter', 3 => 'SugarApiExceptionNotAuthorized', ), 'file' => 'modules/Notes/clients/base/api/NotesFilterApi.php', 'className' => 'NotesFilterApi', 'score' => 7.0, ), ), 'mostactiveusers' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'mostactiveusers', ), 'pathVars' => array ( ), 'method' => 'getMostActiveUsers', 'shortHelp' => 'Returns most active users', 'longHelp' => 'modules/Home/clients/base/api/help/MostActiveUsersApi.html', 'file' => 'modules/Home/clients/base/api/MostActiveUsersApi.php', 'className' => 'MostActiveUsersApi', 'score' => 7.0, ), ), 'Notifications' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Notifications', ), 'pathVars' => array ( 0 => 'module', ), 'method' => 'filterList', 'jsonParams' => array ( 0 => 'filter', ), 'shortHelp' => 'List of all records in this module', 'longHelp' => 'include/api/help/module_filter_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionInvalidParameter', 3 => 'SugarApiExceptionNotAuthorized', ), 'cacheEtag' => true, 'file' => 'modules/Notifications/clients/base/api/NotificationsFilterApi.php', 'className' => 'NotificationsFilterApi', 'score' => 7.0, ), ), 'Currencies' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Currencies', ), 'pathVars' => array ( 0 => 'module', ), 'method' => 'currenciesGet', 'jsonParams' => array ( ), 'shortHelp' => 'Filter records from a single module', 'longHelp' => 'modules/Currencies/clients/base/api/help/CurrenciesGet.html', 'file' => 'modules/Currencies/clients/base/api/CurrenciesFilterApi.php', 'className' => 'CurrenciesFilterApi', 'score' => 7.0, ), ), 'pmse_Emails_Templates' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'pmse_Emails_Templates', ), 'pathVars' => array ( 0 => 'module', ), 'method' => 'filterList', 'jsonParams' => array ( 0 => 'filter', ), 'shortHelp' => 'List of all records in this module', 'longHelp' => 'include/api/help/module_filter_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionInvalidParameter', 3 => 'SugarApiExceptionNotAuthorized', ), 'file' => 'modules/pmse_Emails_Templates/clients/base/api/PMSEEmailsTemplatesFilterApi.php', 'className' => 'PMSEEmailsTemplatesFilterApi', 'score' => 7.0, ), ), 'ForecastWorksheets' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'ForecastWorksheets', ), 'pathVars' => array ( 0 => 'module', ), 'method' => 'forecastWorksheetsGet', 'jsonParams' => array ( ), 'shortHelp' => 'Filter records from a single module', 'longHelp' => 'modules/Forecasts/clients/base/api/help/ForecastWorksheetGet.html', 'exceptions' => array ( 0 => 'SugarApiExceptionError', 1 => 'SugarApiExceptionInvalidParameter', 2 => 'SugarApiExceptionNotAuthorized', 3 => 'SugarApiExceptionNotFound', ), 'file' => 'modules/ForecastWorksheets/clients/base/api/ForecastWorksheetsFilterApi.php', 'className' => 'ForecastWorksheetsFilterApi', 'score' => 7.0, ), ), 'forecastOpportunities' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'forecastOpportunities', ), 'pathVars' => array ( ), 'method' => 'getForecastOpportunities', 'shortHelp' => 'Gets a list of Opportunities in the requested Forecast', 'longHelp' => 'modules/Forecasts/clients/base/api/help/ForecastOpportunityFilterGetAPI.html', 'file' => 'modules/Forecasts/clients/base/api/ForecastsOpportunityApi.php', 'className' => 'ForecastsOpportunityApi', 'score' => 7.0, ), ), 'Forecasts' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Forecasts', ), 'pathVars' => array ( 0 => 'module', ), 'method' => 'returnEmptySet', 'shortHelp' => 'Forecast list endpoint returns an empty set', 'longHelp' => 'include/api/help/module_record_favorite_put_help.html', 'file' => 'modules/Forecasts/clients/base/api/ForecastsApi.php', 'className' => 'ForecastsApi', 'score' => 7.0, ), ), 'Reports' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Reports', ), 'pathVars' => array ( 0 => 'module_list', ), 'method' => 'filterList', 'shortHelp' => 'Search Reports', 'longHelp' => 'include/api/help/getListModule.html', 'file' => 'modules/Reports/clients/base/api/ReportsSearchApi.php', 'className' => 'ReportsSearchApi', 'score' => 7.0, ), ), 'pmse_Inbox' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'pmse_Inbox', ), 'pathVars' => array ( 0 => 'module', ), 'method' => 'filterListAllPA', 'jsonParams' => array ( 0 => 'filter', ), 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionInvalidParameter', 3 => 'SugarApiExceptionNotAuthorized', ), 'shortHelp' => 'Returns a list of Processes by user using filters', 'longHelp' => 'modules/pmse_Inbox/clients/base/api/help/process_filter_list_all_pa_help.html', 'file' => 'modules/pmse_Inbox/clients/base/api/PMSEEngineFilterApi.php', 'className' => 'PMSEEngineFilterApi', 'score' => 7.0, ), ), 'pmse_Business_Rules' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'pmse_Business_Rules', ), 'pathVars' => array ( 0 => 'module', ), 'method' => 'filterList', 'jsonParams' => array ( 0 => 'filter', ), 'shortHelp' => 'List of all records in this module', 'longHelp' => 'include/api/help/module_filter_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionInvalidParameter', 3 => 'SugarApiExceptionNotAuthorized', ), 'file' => 'modules/pmse_Business_Rules/clients/base/api/PMSEBusinessRulesFilterApi.php', 'className' => 'PMSEBusinessRulesFilterApi', 'score' => 7.0, ), ), 'PdfManager' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'PdfManager', ), 'pathVars' => array ( 0 => 'module', ), 'method' => 'filterList', 'jsonParams' => array ( 0 => 'filter', ), 'shortHelp' => 'List of all records in this module', 'longHelp' => 'include/api/help/module_filter_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionInvalidParameter', 3 => 'SugarApiExceptionNotAuthorized', ), 'cacheEtag' => true, 'file' => 'modules/PdfManager/clients/base/api/PdfManagerFilterApi.php', 'className' => 'PdfManagerFilterApi', 'score' => 7.0, ), ), ), 'POST' => array ( 'metadata' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'metadata', ), 'pathVars' => array ( 0 => '', ), 'method' => 'getAllMetadata', 'shortHelp' => 'This method will return all metadata for the system, filtered by the array of hashes sent to the server', 'longHelp' => 'include/api/html/metadata_all_help.html', 'noEtag' => true, 'ignoreMetaHash' => true, 'ignoreSystemStatusError' => true, 'file' => 'clients/base/api/MetadataApi.php', 'className' => 'MetadataApi', 'score' => 7.0, ), ), 'globalsearch' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'globalsearch', ), 'pathVars' => array ( 0 => '', ), 'method' => 'globalSearch', 'shortHelp' => 'Global search', 'longHelp' => 'include/api/help/globalsearch_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotAuthorized', 1 => 'SugarApiExceptionSearchUnavailable', 2 => 'SugarApiExceptionSearchRuntime', ), 'file' => 'clients/base/api/GlobalSearchApi.php', 'className' => 'GlobalSearchApi', 'score' => 7.0, ), ), 'userUtilities' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'userUtilities', ), 'pathVars' => array ( 0 => 'userUtilities', ), 'method' => 'performActions', 'shortHelp' => 'Execute user utility actions', 'longHelp' => 'include/api/help/user_utilities_performactions_post_help.html', 'minVersion' => '11.15', 'file' => 'clients/base/api/UserUtilitiesApi.php', 'className' => 'UserUtilitiesApi', 'score' => 7.0, ), ), 'bulk' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'bulk', ), 'pathVars' => array ( 0 => '', ), 'method' => 'bulkCall', 'shortHelp' => 'Run several API call in a sequence', 'longHelp' => 'include/api/help/bulk_post_help.html', 'file' => 'clients/base/api/BulkApi.php', 'className' => 'BulkApi', 'score' => 7.0, ), ), 'logger' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'logger', ), 'pathVars' => array ( ), 'method' => 'logMessage', 'shortHelp' => 'Writes a message out to the log prefaced by a channel name', 'longHelp' => 'include/api/help/logger_help.html', 'file' => 'clients/base/api/LoggerApi.php', 'className' => 'LoggerApi', 'score' => 7.0, ), ), 'genericsearch' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'genericsearch', ), 'pathVars' => array ( 0 => '', ), 'method' => 'genericSearch', 'shortHelp' => 'Generic search', 'longHelp' => 'include/api/help/generic_search_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotAuthorized', 1 => 'SugarApiExceptionSearchUnavailable', 2 => 'SugarApiExceptionSearchRuntime', 3 => 'SugarApiExceptionMissingParameter', 4 => 'SugarApiExceptionRequestMethodFailure', 5 => 'SugarApiExceptionInvalidParameter', ), 'file' => 'clients/base/api/GenericSearchApi.php', 'className' => 'GenericSearchApi', 'score' => 7.0, ), ), 'theme' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'theme', ), 'pathVars' => array ( 0 => '', ), 'method' => 'updateCustomTheme', 'shortHelp' => 'Update the customizable variables of a custom theme', 'longHelp' => 'include/api/help/theme_post_help.html', 'file' => 'clients/base/api/ThemeApi.php', 'className' => 'ThemeApi', 'score' => 7.0, ), ), '<module>' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => '<module>', ), 'pathVars' => array ( 0 => 'module', ), 'method' => 'createRecord', 'shortHelp' => 'This method creates a new record of the specified type', 'longHelp' => 'include/api/help/module_post_help.html', 'file' => 'clients/base/api/ModuleApi.php', 'className' => 'ModuleApi', 'score' => 6.25, ), ), 'Calendar' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Calendar', ), 'pathVars' => array ( 0 => 'module', ), 'method' => 'createRecord', 'shortHelp' => 'This method creates a new record of the specified type', 'longHelp' => 'include/api/help/module_post_help.html', 'file' => 'modules/Calendar/clients/base/api/CalendarModuleApi.php', 'className' => 'CalendarModuleApi', 'score' => 7.0, ), ), 'Bugs' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Bugs', ), 'pathVars' => array ( 0 => 'module', ), 'method' => 'createRecord', 'shortHelp' => 'Deprecated api kept for backward compatibility', 'longHelp' => 'include/api/help/module_post_help.html', 'maxVersion' => '11.5', 'file' => 'modules/Bugs/clients/base/api/BugsApi.php', 'className' => 'BugsApi', 'score' => 7.0, ), ), 'EmailAddresses' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'EmailAddresses', ), 'pathVars' => array ( 0 => 'module', ), 'method' => 'createRecord', 'shortHelp' => 'This method creates a new EmailAddresses record', 'longHelp' => 'modules/EmailAddresses/clients/base/api/help/email_addresses_record_post_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionInvalidParameter', 1 => 'SugarApiExceptionMissingParameter', 2 => 'SugarApiExceptionNotAuthorized', 3 => 'SugarApiExceptionNotFound', ), 'file' => 'modules/EmailAddresses/clients/base/api/EmailAddressesApi.php', 'className' => 'EmailAddressesApi', 'score' => 7.0, ), ), 'Mail' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Mail', ), 'pathVars' => array ( 0 => '', ), 'method' => 'createMail', 'shortHelp' => 'Create Mail Item', 'longHelp' => 'modules/Emails/clients/base/api/help/mail_post_help.html', 'file' => 'modules/Emails/clients/base/api/MailApi.php', 'className' => 'MailApi', 'score' => 7.0, ), ), 'Emails' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Emails', ), 'pathVars' => array ( 0 => 'module', ), 'method' => 'createRecord', 'shortHelp' => 'This method creates a new Emails record', 'longHelp' => 'modules/Emails/clients/base/api/help/emails_record_post_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionInvalidParameter', 1 => 'SugarApiExceptionMissingParameter', 2 => 'SugarApiExceptionNotAuthorized', 3 => 'SugarApiExceptionNotFound', 4 => 'SugarApiException', 5 => 'SugarApiExceptionError', ), 'file' => 'modules/Emails/clients/base/api/EmailsApi.php', 'className' => 'EmailsApi', 'score' => 7.0, ), ), 'Dashboards' => array ( 0 => array ( 'reqType' => 'POST', 'minVersion' => '10', 'maxVersion' => '10', 'path' => array ( 0 => 'Dashboards', ), 'pathVars' => array ( 0 => '', ), 'method' => 'createDashboard', 'shortHelp' => 'Create a new dashboard for home', 'longHelp' => 'include/api/help/create_home_dashboard.html', 'file' => 'modules/Dashboards/clients/base/api/DashboardApi.php', 'className' => 'DashboardApi', 'score' => 7.0, ), ), 'ExternalUsers' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'ExternalUsers', ), 'pathVars' => array ( 0 => 'module', ), 'method' => 'createRecord', 'shortHelp' => 'This method creates a new record of the specified type', 'longHelp' => 'include/api/help/module_post_help.html', 'minVersion' => '11.8', 'file' => 'modules/ExternalUsers/clients/base/api/ExternalUsersApi.php', 'className' => 'ExternalUsersApi', 'score' => 7.0, ), ), 'Meetings' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Meetings', ), 'pathVars' => array ( 0 => 'module', ), 'method' => 'createRecord', 'shortHelp' => 'This method creates a single event record or a series of event records of the specified type', 'longHelp' => 'include/api/help/calendar_events_record_create_help.html', 'file' => 'modules/Meetings/clients/base/api/MeetingsApi.php', 'className' => 'MeetingsApi', 'score' => 7.0, ), ), 'pmse_Project' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'pmse_Project', ), 'pathVars' => array ( 0 => 'module', ), 'method' => 'createRecord', 'file' => 'modules/pmse_Project/clients/base/api/PMSEProjectCRUDApi.php', 'className' => 'PMSEProjectCRUDApi', 'score' => 7.0, ), ), 'Leads' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Leads', ), 'pathVars' => array ( 0 => 'module', ), 'method' => 'createRecord', 'shortHelp' => 'This method creates a new Lead record with option to add Target & Email relationships', 'longHelp' => 'modules/Leads/clients/base/api/help/LeadsApi.html', 'file' => 'modules/Leads/clients/base/api/LeadsApi.php', 'className' => 'LeadsApi', 'score' => 7.0, ), ), 'CommentLog' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'CommentLog', ), 'pathVars' => array ( 0 => 'module', ), 'method' => 'accessBlocker', 'shortHelp' => 'This method is not available', 'file' => 'modules/CommentLog/clients/base/api/CommentLogApi.php', 'className' => 'CommentLogApi', 'score' => 7.0, ), ), 'Cases' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Cases', ), 'pathVars' => array ( 0 => 'module', ), 'method' => 'createRecord', 'shortHelp' => 'Deprecated api kept for backward compatibility', 'longHelp' => 'include/api/help/module_post_help.html', 'maxVersion' => '11.5', 'file' => 'modules/Cases/clients/base/api/CasesApi.php', 'className' => 'CasesApi', 'score' => 7.0, ), ), 'Calls' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Calls', ), 'pathVars' => array ( 0 => 'module', ), 'method' => 'createRecord', 'shortHelp' => 'This method creates a single event record or a series of event records of the specified type', 'longHelp' => 'include/api/help/calendar_events_record_create_help.html', 'file' => 'modules/Calls/clients/base/api/CallsApi.php', 'className' => 'CallsApi', 'score' => 7.0, ), ), 'PubSub_ModuleEvent_PushSubs' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'PubSub_ModuleEvent_PushSubs', ), 'pathVars' => array ( 0 => 'module', ), 'method' => 'createRecord', 'minVersion' => '11.20', 'file' => 'modules/PubSub_ModuleEvent_PushSubs/clients/base/api/PubSub_ModuleEvent_PushSubsApi.php', 'className' => 'PubSub_ModuleEvent_PushSubsApi', 'score' => 7.0, ), ), 'Users' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Users', ), 'pathVars' => array ( 0 => 'module', ), 'method' => 'createUser', 'minVersion' => '11.6', 'shortHelp' => 'This method creates a User record', 'longHelp' => 'modules/Users/clients/base/api/help/UsersApi_create.html', 'ignoreSystemStatusError' => true, 'file' => 'modules/Users/clients/base/api/UsersApi.php', 'className' => 'UsersApi', 'score' => 7.0, ), ), 'Notes' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Notes', ), 'pathVars' => array ( 0 => 'module', ), 'method' => 'createRecord', 'shortHelp' => 'This method creates a new Note record', 'exceptions' => array ( 0 => 'SugarApiExceptionInvalidParameter', 1 => 'SugarApiExceptionMissingParameter', 2 => 'SugarApiExceptionNotAuthorized', 3 => 'SugarApiExceptionNotFound', ), 'file' => 'modules/Notes/clients/base/api/NotesModuleApi.php', 'className' => 'NotesModuleApi', 'score' => 7.0, ), ), 'OutboundEmail' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'OutboundEmail', ), 'pathVars' => array ( 0 => 'module', ), 'method' => 'createRecord', 'shortHelp' => 'This method creates a new OutboundEmail record', 'longHelp' => 'modules/OutboundEmail/clients/base/api/help/outbound_email_post_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionInvalidParameter', 1 => 'SugarApiExceptionMissingParameter', 2 => 'SugarApiExceptionNotAuthorized', 3 => 'SugarApiExceptionNotFound', 4 => 'SugarApiException', ), 'file' => 'modules/OutboundEmail/clients/base/api/OutboundEmailApi.php', 'className' => 'OutboundEmailApi', 'score' => 7.0, ), ), 'forecastOpportunities' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'forecastOpportunities', ), 'pathVars' => array ( ), 'method' => 'getForecastOpportunities', 'shortHelp' => 'Gets a list of Opportunities in the requested Forecast', 'longHelp' => 'modules/Forecasts/clients/base/api/help/ForecastOpportunityFilterPostAPI.html', 'file' => 'modules/Forecasts/clients/base/api/ForecastsOpportunityApi.php', 'className' => 'ForecastsOpportunityApi', 'score' => 7.0, ), ), 'Forecasts' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Forecasts', ), 'pathVars' => array ( 0 => 'module', ), 'method' => 'createRecord', 'shortHelp' => 'This method creates a new record of the specified type', 'longHelp' => 'include/api/help/module_new_help.html', 'file' => 'modules/Forecasts/clients/base/api/ForecastsModuleApi.php', 'className' => 'ForecastsModuleApi', 'score' => 7.0, ), ), ), 'PUT' => array ( 'me' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'me', ), 'pathVars' => array ( ), 'method' => 'updateCurrentUser', 'shortHelp' => 'Updates current user', 'longHelp' => 'include/api/help/me_put_help.html', 'ignoreMetaHash' => true, 'ignoreSystemStatusError' => true, 'file' => 'clients/base/api/CurrentUserApi.php', 'className' => 'CurrentUserApi', 'score' => 7.0, ), ), ), '?' => array ( 'KBDocuments' => array ( 0 => array ( 'reqType' => '?', 'path' => array ( 0 => 'KBDocuments', ), 'pathVars' => array ( 0 => 'module', ), 'method' => 'disableApi', 'extraScore' => 1, 'shortHelp' => 'Disable KBDocuments', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', ), 'file' => 'modules/KBContents/clients/base/api/KBContentsApi.php', 'className' => 'KBContentsApi', 'score' => 7.0, ), ), 'KBArticles' => array ( 0 => array ( 'reqType' => '?', 'path' => array ( 0 => 'KBArticles', ), 'pathVars' => array ( 0 => 'module', ), 'method' => 'disableApi', 'extraScore' => 1, 'shortHelp' => 'Disable KBArticles', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', ), 'file' => 'modules/KBContents/clients/base/api/KBContentsApi.php', 'className' => 'KBContentsApi', 'score' => 7.0, ), ), ), ), 'mobile' => array ( 'GET' => array ( 'me' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'me', ), 'pathVars' => array ( ), 'method' => 'retrieveCurrentUser', 'shortHelp' => 'Returns current user', 'longHelp' => 'include/api/help/me_get_help.html', 'ignoreMetaHash' => true, 'ignoreSystemStatusError' => true, 'noEtag' => true, 'file' => 'clients/mobile/api/CurrentUserMobileApi.php', 'className' => 'CurrentUserMobileApi', 'score' => 7.0, ), ), ), 'PUT' => array ( 'me' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'me', ), 'pathVars' => array ( ), 'method' => 'updateCurrentUser', 'shortHelp' => 'Updates current user', 'longHelp' => 'include/api/help/me_put_help.html', 'ignoreMetaHash' => true, 'ignoreSystemStatusError' => true, 'file' => 'clients/mobile/api/CurrentUserMobileApi.php', 'className' => 'CurrentUserMobileApi', 'score' => 7.0, ), ), ), ), 'portal' => array ( 'GET' => array ( 'globalsearch' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'globalsearch', ), 'pathVars' => array ( 0 => '', ), 'method' => 'globalSearchPortal', 'shortHelp' => 'Global search', 'exceptions' => array ( 0 => 'SugarApiExceptionNoMethod', ), 'file' => 'clients/portal/api/GlobalSearchPortalApi.php', 'className' => 'GlobalSearchPortalApi', 'score' => 7.0, ), ), 'search' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'search', ), 'pathVars' => array ( 0 => '', ), 'method' => 'globalSearch', 'jsonParams' => array ( 0 => 'fields', ), 'shortHelp' => 'Globally search records', 'longHelp' => 'include/api/help/module_get_help.html', 'file' => 'clients/portal/api/UnifiedSearchPortalApi.php', 'className' => 'UnifiedSearchPortalApi', 'score' => 7.0, ), ), 'portalsearch' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'portalsearch', ), 'pathVars' => array ( 0 => '', ), 'method' => 'portalSearch', 'shortHelp' => 'Portal search', 'longHelp' => 'include/api/help/portal_search_get_help.html', 'minVersion' => '11.6', 'exceptions' => array ( 0 => 'SugarApiExceptionNotAuthorized', 1 => 'SugarApiExceptionSearchUnavailable', 2 => 'SugarApiExceptionSearchRuntime', 3 => 'SugarApiExceptionMissingParameter', 4 => 'SugarApiExceptionRequestMethodFailure', 5 => 'SugarApiExceptionInvalidParameter', ), 'file' => 'clients/portal/api/SearchPortalApi.php', 'className' => 'SearchPortalApi', 'score' => 7.0, ), ), 'me' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'me', ), 'pathVars' => array ( ), 'method' => 'retrieveCurrentUser', 'shortHelp' => 'Returns current user', 'longHelp' => 'include/api/help/me_get_help.html', 'ignoreMetaHash' => true, 'ignoreSystemStatusError' => true, 'noEtag' => true, 'file' => 'clients/portal/api/CurrentUserPortalApi.php', 'className' => 'CurrentUserPortalApi', 'score' => 7.0, ), ), '<module>' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', ), 'pathVars' => array ( 0 => 'module', ), 'method' => 'filterList', 'jsonParams' => array ( 0 => 'filter', ), 'shortHelp' => 'List of all records in this module', 'longHelp' => 'include/api/help/module_filter_get_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionNotFound', 1 => 'SugarApiExceptionError', 2 => 'SugarApiExceptionInvalidParameter', 3 => 'SugarApiExceptionNotAuthorized', ), 'file' => 'clients/portal/api/FilterPortalApi.php', 'className' => 'FilterPortalApi', 'score' => 6.25, ), ), ), 'POST' => array ( 'globalsearch' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'globalsearch', ), 'pathVars' => array ( 0 => '', ), 'method' => 'globalSearchPortal', 'shortHelp' => 'Global search', 'exceptions' => array ( 0 => 'SugarApiExceptionNoMethod', ), 'file' => 'clients/portal/api/GlobalSearchPortalApi.php', 'className' => 'GlobalSearchPortalApi', 'score' => 7.0, ), ), 'portalsearch' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'portalsearch', ), 'pathVars' => array ( 0 => '', ), 'method' => 'portalSearch', 'shortHelp' => 'Portal search', 'longHelp' => 'include/api/help/portal_search_get_help.html', 'minVersion' => '11.6', 'exceptions' => array ( 0 => 'SugarApiExceptionNotAuthorized', 1 => 'SugarApiExceptionSearchUnavailable', 2 => 'SugarApiExceptionSearchRuntime', 3 => 'SugarApiExceptionMissingParameter', 4 => 'SugarApiExceptionRequestMethodFailure', 5 => 'SugarApiExceptionInvalidParameter', ), 'file' => 'clients/portal/api/SearchPortalApi.php', 'className' => 'SearchPortalApi', 'score' => 7.0, ), ), '<module>' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => '<module>', ), 'pathVars' => array ( 0 => 'module', ), 'method' => 'createRecord', 'shortHelp' => 'This API creates a new record through the portal platform and it relates automatically the Portal Contact (and optionally the Contact\'s Account) based on the portal visibility relationships', 'longHelp' => 'include/api/help/module_post_help.html', 'file' => 'clients/portal/api/ModulePortalApi.php', 'className' => 'ModulePortalApi', 'score' => 6.25, ), ), ), 'PUT' => array ( 'me' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'me', ), 'pathVars' => array ( ), 'method' => 'updateCurrentUser', 'shortHelp' => 'Updates current user', 'longHelp' => 'include/api/help/me_put_help.html', 'ignoreMetaHash' => true, 'ignoreSystemStatusError' => true, 'file' => 'clients/portal/api/CurrentUserPortalApi.php', 'className' => 'CurrentUserPortalApi', 'score' => 7.0, ), ), ), ), ), 5 => array ( 'base' => array ( 'PATCH' => array ( 'integrate' => array ( '<module>' => array ( '?' => array ( '?' => array ( '?' => array ( 0 => array ( 'reqType' => 'PATCH', 'path' => array ( 0 => 'integrate', 1 => '<module>', 2 => '?', 3 => '?', 4 => '?', ), 'pathVars' => array ( 0 => '', 1 => 'module', 2 => 'record_id', 3 => 'sync_key_field_name', 4 => 'sync_key_field_value', ), 'method' => 'setSyncKey', 'shortHelp' => 'Set synchronization key for a provided module and a record_id', 'file' => 'clients/base/api/IntegrateApi.php', 'className' => 'IntegrateApi', 'score' => 10.25, ), ), ), ), ), ), ), 'PUT' => array ( 'integrate' => array ( '<module>' => array ( '?' => array ( '?' => array ( '?' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => 'integrate', 1 => '<module>', 2 => '?', 3 => '?', 4 => '?', ), 'pathVars' => array ( 0 => '', 1 => 'module', 2 => 'record_id', 3 => 'sync_key_field_name', 4 => 'sync_key_field_value', ), 'method' => 'setSyncKey', 'shortHelp' => 'Set synchronization key for a provided module and a record_id', 'file' => 'clients/base/api/IntegrateApi.php', 'className' => 'IntegrateApi', 'score' => 10.25, ), ), ), ), ), ), '<module>' => array ( '?' => array ( 'link' => array ( '?' => array ( '?' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => '<module>', 1 => '?', 2 => 'link', 3 => '?', 4 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', 3 => 'link_name', 4 => 'remote_id', ), 'method' => 'updateRelatedLink', 'shortHelp' => 'Updates relationship specific information ', 'longHelp' => 'include/api/help/module_record_link_link_name_remote_id_put_help.html', 'file' => 'clients/base/api/RelateRecordApi.php', 'className' => 'RelateRecordApi', 'score' => 10.25, ), ), ), ), ), ), ), 'GET' => array ( '<module>' => array ( '?' => array ( 'link' => array ( '?' => array ( 'filter' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', 1 => '?', 2 => 'link', 3 => '?', 4 => 'filter', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', 3 => 'link_name', 4 => '', ), 'jsonParams' => array ( 0 => 'filter', ), 'method' => 'filterRelated', 'shortHelp' => 'Lists related filtered records.', 'longHelp' => 'include/api/help/module_record_link_link_name_filter_get_help.html', 'file' => 'clients/base/api/RelateApi.php', 'className' => 'RelateApi', 'score' => 11.25, ), ), 'count' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', 1 => '?', 2 => 'link', 3 => '?', 4 => 'count', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', 3 => 'link_name', 4 => '', ), 'jsonParams' => array ( 0 => 'filter', ), 'method' => 'filterRelatedCount', 'shortHelp' => 'Counts all filtered related records.', 'longHelp' => 'include/api/help/module_record_link_link_name_filter_get_help.html', 'file' => 'clients/base/api/RelateApi.php', 'className' => 'RelateApi', 'score' => 11.25, ), ), 'leancount' => array ( 0 => array ( 'reqType' => 'GET', 'minVersion' => '11.4', 'path' => array ( 0 => '<module>', 1 => '?', 2 => 'link', 3 => '?', 4 => 'leancount', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', 3 => 'link_name', 4 => '', ), 'jsonParams' => array ( 0 => 'filter', ), 'method' => 'filterRelatedLeanCount', 'shortHelp' => 'Gets the "lean" count of related items.The count should always be in the range: 0..max_num. The response has a boolean flag "has_more" that defines if there are more rows, than max_num parameter value.', 'longHelp' => 'include/api/help/module_record_link_link_name_filter_get_help.html', 'file' => 'clients/base/api/RelateApi.php', 'className' => 'RelateApi', 'score' => 11.25, ), ), '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', 1 => '?', 2 => 'link', 3 => '?', 4 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', 3 => 'link_name', 4 => 'remote_id', ), 'method' => 'getRelatedRecord', 'shortHelp' => 'Fetch a single record related to this module', 'longHelp' => 'include/api/help/module_record_link_link_name_remote_id_get_help.html', 'file' => 'clients/base/api/RelateRecordApi.php', 'className' => 'RelateRecordApi', 'score' => 10.25, ), ), ), 'activities' => array ( 'filter' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', 1 => '?', 2 => 'link', 3 => 'activities', 4 => 'filter', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', ), 'method' => 'getRecordActivities', 'shortHelp' => 'This method retrieves a filtered list of a record\'s activities', 'longHelp' => 'modules/ActivityStream/clients/base/api/help/recordActivities.html', 'file' => 'modules/ActivityStream/clients/base/api/ActivitiesApi.php', 'className' => 'ActivitiesApi', 'score' => 12.25, ), ), ), ), 'collection' => array ( '?' => array ( 'count' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', 1 => '?', 2 => 'collection', 3 => '?', 4 => 'count', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', 3 => 'collection_name', 4 => '', ), 'method' => 'getCollectionCount', 'shortHelp' => 'Counts collection records.', 'longHelp' => 'include/api/help/module_record_collection_collection_name_count_get_help.html', 'file' => 'clients/base/api/RelateCollectionApi.php', 'className' => 'RelateCollectionApi', 'score' => 11.25, ), ), ), ), ), 'temp' => array ( 'file' => array ( '?' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', 1 => 'temp', 2 => 'file', 3 => '?', 4 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', 3 => 'field', 4 => 'temp_id', ), 'method' => 'getTempImage', 'rawReply' => true, 'allowDownloadCookie' => true, 'shortHelp' => 'Reads a temporary image and deletes it.', 'longHelp' => 'include/api/help/module_temp_file_field_temp_id_get_help.html', 'file' => 'clients/base/api/FileTempApi.php', 'className' => 'FileTempApi', 'score' => 11.25, ), ), ), ), ), 'chart' => array ( 'pipeline' => array ( '?' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', 1 => 'chart', 2 => 'pipeline', 3 => '?', 4 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => '', 2 => '', 3 => 'timeperiod_id', 4 => 'type', ), 'method' => 'pipeline', 'shortHelp' => 'Get the current opportunity pipeline data for the current timeperiod', 'longHelp' => 'modules/Opportunities/clients/base/api/help/OpportunitiesPipelineChartApi.html', 'file' => 'clients/base/api/PipelineChartApi.php', 'className' => 'PipelineChartApi', 'score' => 11.25, ), ), ), ), ), ), 'Accounts' => array ( '?' => array ( 'link' => array ( '?' => array ( 'filter' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Accounts', 1 => '?', 2 => 'link', 3 => '?', 4 => 'filter', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', 3 => 'link_name', 4 => '', ), 'jsonParams' => array ( 0 => 'filter', ), 'method' => 'filterRelated', 'shortHelp' => 'Lists related filtered records.', 'longHelp' => 'include/api/help/module_record_link_link_name_filter_get_help.html', 'file' => 'modules/Accounts/clients/base/api/AccountsRelateApi.php', 'className' => 'AccountsRelateApi', 'score' => 12.0, ), ), ), ), ), ), 'Forecasts' => array ( '?' => array ( '?' => array ( 'chart' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Forecasts', 1 => '?', 2 => '?', 3 => 'chart', 4 => '?', ), 'pathVars' => array ( 0 => '', 1 => 'timeperiod_id', 2 => 'user_id', 3 => '', 4 => 'display_manager', ), 'method' => 'chart', 'shortHelp' => 'Retrieve the Chart data for the given data in the Forecast Module', 'longHelp' => 'modules/Forecasts/clients/base/api/help/ForecastChartApi.html', 'file' => 'modules/Forecasts/clients/base/api/ForecastsChartApi.php', 'className' => 'ForecastsChartApi', 'score' => 11.0, ), ), ), ), 'quotas' => array ( 'rollup' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Forecasts', 1 => '?', 2 => 'quotas', 3 => 'rollup', 4 => '?', ), 'pathVars' => array ( 0 => '', 1 => 'timeperiod_id', 2 => '', 3 => 'quota_type', 4 => 'user_id', ), 'method' => 'getQuota', 'shortHelp' => 'Returns the rollup quota for the user by timeperiod', 'longHelp' => 'modules/Forecasts/clients/base/api/help/ForecastsQuotasApiGet.html', 'file' => 'modules/Forecasts/clients/base/api/ForecastsApi.php', 'className' => 'ForecastsApi', 'score' => 12.0, ), ), ), 'direct' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'Forecasts', 1 => '?', 2 => 'quotas', 3 => 'direct', 4 => '?', ), 'pathVars' => array ( 0 => '', 1 => 'timeperiod_id', 2 => '', 3 => 'quota_type', 4 => 'user_id', ), 'method' => 'getQuota', 'shortHelp' => 'Returns the direct quota for the user by timeperiod', 'longHelp' => 'modules/Forecasts/clients/base/api/help/ForecastsQuotasApiGet.html', 'file' => 'modules/Forecasts/clients/base/api/ForecastsApi.php', 'className' => 'ForecastsApi', 'score' => 12.0, ), ), ), ), ), ), 'pmse_Inbox' => array ( 'temp' => array ( 'file' => array ( '?' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'pmse_Inbox', 1 => 'temp', 2 => 'file', 3 => '?', 4 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', 3 => 'field', 4 => 'temp_id', ), 'method' => 'getTempImage', 'rawReply' => true, 'allowDownloadCookie' => true, 'file' => 'modules/pmse_Inbox/clients/base/api/PMSEImageGeneratorApi.php', 'className' => 'PMSEImageGeneratorApi', 'score' => 12.0, ), ), ), ), ), ), 'pmse_Project' => array ( 'temp' => array ( 'file' => array ( '?' => array ( '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => 'pmse_Project', 1 => 'temp', 2 => 'file', 3 => '?', 4 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', 3 => 'field', 4 => 'temp_id', ), 'method' => 'getTempImage', 'rawReply' => true, 'allowDownloadCookie' => true, 'file' => 'modules/pmse_Inbox/clients/base/api/PMSEImageGeneratorApi.php', 'className' => 'PMSEImageGeneratorApi', 'score' => 12.0, ), ), ), ), ), ), ), 'POST' => array ( '<module>' => array ( '?' => array ( 'link_by_sync_keys' => array ( '?' => array ( '?' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => '<module>', 1 => '?', 2 => 'link_by_sync_keys', 3 => '?', 4 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'lhs_sync_key_field_value', 2 => '', 3 => 'link_name', 4 => 'rhs_sync_key_field_value', ), 'method' => 'relateByFields', 'shortHelp' => 'Create a relationship based on both sync_keys. If both the LHS and RHS records can be found with the respective sync_key, then relate the RHS record to the LHS record.', 'file' => 'clients/base/api/IntegrateRelateApi.php', 'className' => 'IntegrateRelateApi', 'score' => 10.25, ), ), ), ), 'link' => array ( '?' => array ( '?' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => '<module>', 1 => '?', 2 => 'link', 3 => '?', 4 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', 3 => 'link_name', 4 => 'remote_id', ), 'method' => 'createRelatedLink', 'shortHelp' => 'Relates an existing record to this module', 'longHelp' => 'include/api/help/module_record_link_link_name_remote_id_post_help.html', 'file' => 'clients/base/api/RelateRecordApi.php', 'className' => 'RelateRecordApi', 'score' => 10.25, ), ), ), ), ), ), 'Emails' => array ( '?' => array ( 'link' => array ( '?' => array ( '?' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Emails', 1 => '?', 2 => 'link', 3 => '?', 4 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', 3 => 'link_name', 4 => 'remote_id', ), 'method' => 'createRelatedLink', 'shortHelp' => 'Relates an existing record to an email', 'longHelp' => 'modules/Emails/clients/base/api/help/emails_record_link_link_name_remote_id_post_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionMissingParameter', 1 => 'SugarApiExceptionNotAuthorized', 2 => 'SugarApiExceptionNotFound', ), 'file' => 'modules/Emails/clients/base/api/EmailsRelateRecordApi.php', 'className' => 'EmailsRelateRecordApi', 'score' => 11.0, ), ), ), ), ), ), 'Users' => array ( '?' => array ( 'link' => array ( '?' => array ( '?' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Users', 1 => '?', 2 => 'link', 3 => '?', 4 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', 3 => 'link_name', 4 => 'remote_id', ), 'method' => 'createRelatedLink', 'shortHelp' => 'Relates an existing record to this module', 'longHelp' => 'include/api/help/module_record_link_link_name_remote_id_post_help.html', 'file' => 'modules/Users/clients/base/api/UsersRelateRecordApi.php', 'className' => 'UsersRelateRecordApi', 'score' => 11.0, ), ), ), ), ), ), 'Teams' => array ( '?' => array ( 'link' => array ( '?' => array ( '?' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Teams', 1 => '?', 2 => 'link', 3 => '?', 4 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', 3 => 'link_name', 4 => 'remote_id', ), 'method' => 'createRelatedLink', 'shortHelp' => 'Relates an existing record to this module', 'longHelp' => 'include/api/help/module_record_link_link_name_remote_id_post_help.html', 'file' => 'modules/Teams/clients/base/api/TeamsRelateRecordApi.php', 'className' => 'TeamsRelateRecordApi', 'score' => 11.0, ), ), ), ), ), ), ), 'DELETE' => array ( '<module>' => array ( '?' => array ( 'link_by_sync_keys' => array ( '?' => array ( '?' => array ( 0 => array ( 'reqType' => 'DELETE', 'path' => array ( 0 => '<module>', 1 => '?', 2 => 'link_by_sync_keys', 3 => '?', 4 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'lhs_sync_key_field_value', 2 => '', 3 => 'link_name', 4 => 'rhs_sync_key_field_value', ), 'method' => 'unrelateByFields', 'shortHelp' => 'Remove a relationship based on both sync_keys. If both the LHS and RHS records can be found with the respective sync_key, and those records are related, then remove the relationship of the RHS record to the LHS record.', 'file' => 'clients/base/api/IntegrateRelateApi.php', 'className' => 'IntegrateRelateApi', 'score' => 10.25, ), ), ), ), 'link' => array ( '?' => array ( '?' => array ( 0 => array ( 'reqType' => 'DELETE', 'path' => array ( 0 => '<module>', 1 => '?', 2 => 'link', 3 => '?', 4 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', 3 => 'link_name', 4 => 'remote_id', ), 'method' => 'deleteRelatedLink', 'shortHelp' => 'Deletes a relationship between two records', 'longHelp' => 'include/api/help/module_record_link_link_name_remote_id_delete_help.html', 'file' => 'clients/base/api/RelateRecordApi.php', 'className' => 'RelateRecordApi', 'score' => 10.25, ), ), ), ), ), ), 'Emails' => array ( '?' => array ( 'link' => array ( '?' => array ( '?' => array ( 0 => array ( 'reqType' => 'DELETE', 'path' => array ( 0 => 'Emails', 1 => '?', 2 => 'link', 3 => '?', 4 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', 3 => 'link_name', 4 => 'remote_id', ), 'method' => 'deleteRelatedLink', 'shortHelp' => 'Deletes a relationship between an email and another record', 'longHelp' => 'modules/Emails/clients/base/api/help/emails_record_link_link_name_remote_id_delete_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionMissingParameter', 1 => 'SugarApiExceptionNotAuthorized', 2 => 'SugarApiExceptionNotFound', ), 'file' => 'modules/Emails/clients/base/api/EmailsRelateRecordApi.php', 'className' => 'EmailsRelateRecordApi', 'score' => 11.0, ), ), ), ), ), ), 'Users' => array ( '?' => array ( 'link' => array ( '?' => array ( '?' => array ( 0 => array ( 'reqType' => 'DELETE', 'path' => array ( 0 => 'Users', 1 => '?', 2 => 'link', 3 => '?', 4 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', 3 => 'link_name', 4 => 'remote_id', ), 'method' => 'deleteRelatedLink', 'shortHelp' => 'Deletes a relationship between two records', 'longHelp' => 'include/api/help/module_record_link_link_name_remote_id_delete_help.html', 'file' => 'modules/Users/clients/base/api/UsersRelateRecordApi.php', 'className' => 'UsersRelateRecordApi', 'score' => 11.0, ), ), ), ), ), ), 'Teams' => array ( '?' => array ( 'link' => array ( '?' => array ( '?' => array ( 0 => array ( 'reqType' => 'DELETE', 'path' => array ( 0 => 'Teams', 1 => '?', 2 => 'link', 3 => '?', 4 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', 3 => 'link_name', 4 => 'remote_id', ), 'method' => 'deleteRelatedLink', 'shortHelp' => 'Deletes a relationship between two records', 'longHelp' => 'include/api/help/module_record_link_link_name_remote_id_delete_help.html', 'file' => 'modules/Teams/clients/base/api/TeamsRelateRecordApi.php', 'className' => 'TeamsRelateRecordApi', 'score' => 11.0, ), ), ), ), ), ), ), ), 'mobile' => array ( 'GET' => array ( '<module>' => array ( '?' => array ( 'link' => array ( '?' => array ( 'filter' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', 1 => '?', 2 => 'link', 3 => '?', 4 => 'filter', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', 3 => 'link_name', 4 => '', ), 'jsonParams' => array ( 0 => 'filter', ), 'method' => 'filterRelated', 'shortHelp' => 'Lists related filtered records.', 'longHelp' => 'include/api/help/module_record_link_link_name_filter_get_help.html', 'file' => 'clients/mobile/api/RelateMobileApi.php', 'className' => 'RelateMobileApi', 'score' => 11.25, ), ), 'count' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', 1 => '?', 2 => 'link', 3 => '?', 4 => 'count', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', 3 => 'link_name', 4 => '', ), 'jsonParams' => array ( 0 => 'filter', ), 'method' => 'filterRelatedCount', 'shortHelp' => 'Counts all filtered related records.', 'longHelp' => 'include/api/help/module_record_link_link_name_filter_get_help.html', 'file' => 'clients/mobile/api/RelateMobileApi.php', 'className' => 'RelateMobileApi', 'score' => 11.25, ), ), 'leancount' => array ( 0 => array ( 'reqType' => 'GET', 'minVersion' => '11.4', 'path' => array ( 0 => '<module>', 1 => '?', 2 => 'link', 3 => '?', 4 => 'leancount', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', 3 => 'link_name', 4 => '', ), 'jsonParams' => array ( 0 => 'filter', ), 'method' => 'filterRelatedLeanCount', 'shortHelp' => 'Gets the "lean" count of related items.The count should always be in the range: 0..max_num. The response has a boolean flag "has_more" that defines if there are more rows, than max_num parameter value.', 'longHelp' => 'include/api/help/module_record_link_link_name_filter_get_help.html', 'file' => 'clients/mobile/api/RelateMobileApi.php', 'className' => 'RelateMobileApi', 'score' => 11.25, ), ), '?' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', 1 => '?', 2 => 'link', 3 => '?', 4 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', 3 => 'link_name', 4 => 'remote_id', ), 'method' => 'getRelatedRecord', 'shortHelp' => 'Fetch a single record related to this module', 'longHelp' => 'include/api/help/module_record_link_link_name_remote_id_get_help.html', 'file' => 'clients/mobile/api/RelateRecordMobileApi.php', 'className' => 'RelateRecordMobileApi', 'score' => 10.25, ), ), ), ), ), ), ), 'POST' => array ( '<module>' => array ( '?' => array ( 'link' => array ( '?' => array ( '?' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => '<module>', 1 => '?', 2 => 'link', 3 => '?', 4 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', 3 => 'link_name', 4 => 'remote_id', ), 'method' => 'createRelatedLink', 'shortHelp' => 'Relates an existing record to this module', 'longHelp' => 'include/api/help/module_record_link_link_name_remote_id_post_help.html', 'file' => 'clients/mobile/api/RelateRecordMobileApi.php', 'className' => 'RelateRecordMobileApi', 'score' => 10.25, ), ), ), ), ), ), ), 'PUT' => array ( '<module>' => array ( '?' => array ( 'link' => array ( '?' => array ( '?' => array ( 0 => array ( 'reqType' => 'PUT', 'path' => array ( 0 => '<module>', 1 => '?', 2 => 'link', 3 => '?', 4 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', 3 => 'link_name', 4 => 'remote_id', ), 'method' => 'updateRelatedLink', 'shortHelp' => 'Updates relationship specific information ', 'longHelp' => 'include/api/help/module_record_link_link_name_remote_id_put_help.html', 'file' => 'clients/mobile/api/RelateRecordMobileApi.php', 'className' => 'RelateRecordMobileApi', 'score' => 10.25, ), ), ), ), ), ), ), 'DELETE' => array ( '<module>' => array ( '?' => array ( 'link' => array ( '?' => array ( '?' => array ( 0 => array ( 'reqType' => 'DELETE', 'path' => array ( 0 => '<module>', 1 => '?', 2 => 'link', 3 => '?', 4 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', 3 => 'link_name', 4 => 'remote_id', ), 'method' => 'deleteRelatedLink', 'shortHelp' => 'Deletes a relationship between two records', 'longHelp' => 'include/api/help/module_record_link_link_name_remote_id_delete_help.html', 'file' => 'clients/mobile/api/RelateRecordMobileApi.php', 'className' => 'RelateRecordMobileApi', 'score' => 10.25, ), ), ), ), ), ), ), ), ), 6 => array ( 'base' => array ( 'GET' => array ( '<module>' => array ( '?' => array ( 'link' => array ( '?' => array ( 'filter' => array ( 'count' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', 1 => '?', 2 => 'link', 3 => '?', 4 => 'filter', 5 => 'count', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', 3 => 'link_name', 4 => '', 5 => '', ), 'jsonParams' => array ( 0 => 'filter', ), 'method' => 'filterRelatedCount', 'shortHelp' => 'Lists related filtered records.', 'longHelp' => 'include/api/help/module_record_link_link_name_filter_get_help.html', 'file' => 'clients/base/api/RelateApi.php', 'className' => 'RelateApi', 'score' => 13.0, ), ), 'leancount' => array ( 0 => array ( 'reqType' => 'GET', 'minVersion' => '11.4', 'path' => array ( 0 => '<module>', 1 => '?', 2 => 'link', 3 => '?', 4 => 'filter', 5 => 'leancount', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', 3 => 'link_name', 4 => '', 5 => '', ), 'jsonParams' => array ( 0 => 'filter', ), 'method' => 'filterRelatedLeanCount', 'shortHelp' => 'Gets the "lean" count of filtered related items. The count should always be in the range: 0..max_num. The response has a boolean flag "has_more" that defines if there are more rows, than max_num parameter value.', 'longHelp' => 'include/api/help/module_record_link_link_name_filter_get_help.html', 'file' => 'clients/base/api/RelateApi.php', 'className' => 'RelateApi', 'score' => 13.0, ), ), ), ), ), ), ), ), 'POST' => array ( '<module>' => array ( '?' => array ( 'link' => array ( '?' => array ( 'add_record_list' => array ( '?' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => '<module>', 1 => '?', 2 => 'link', 3 => '?', 4 => 'add_record_list', 5 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', 3 => 'link_name', 4 => '', 5 => 'remote_id', ), 'method' => 'createRelatedLinksFromRecordList', 'shortHelp' => 'Relates existing records from a record list to this record.', 'longHelp' => 'include/api/help/module_record_links_from_recordlist_post_help.html', 'file' => 'clients/base/api/RelateRecordApi.php', 'className' => 'RelateRecordApi', 'score' => 12.0, ), ), ), ), ), ), ), 'Emails' => array ( '?' => array ( 'link' => array ( '?' => array ( 'add_record_list' => array ( '?' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'Emails', 1 => '?', 2 => 'link', 3 => '?', 4 => 'add_record_list', 5 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', 3 => 'link_name', 4 => '', 5 => 'remote_id', ), 'method' => 'createRelatedLinksFromRecordList', 'shortHelp' => 'Relates existing records from a record list to an email', 'longHelp' => 'modules/Emails/clients/base/api/help/emails_record_links_from_recordlist_post_help.html', 'exceptions' => array ( 0 => 'SugarApiExceptionMissingParameter', 1 => 'SugarApiExceptionNotAuthorized', 2 => 'SugarApiExceptionNotFound', ), 'file' => 'modules/Emails/clients/base/api/EmailsRelateRecordApi.php', 'className' => 'EmailsRelateRecordApi', 'score' => 12.75, ), ), ), ), ), ), ), ), ), 'mobile' => array ( 'GET' => array ( '<module>' => array ( '?' => array ( 'link' => array ( '?' => array ( 'filter' => array ( 'count' => array ( 0 => array ( 'reqType' => 'GET', 'path' => array ( 0 => '<module>', 1 => '?', 2 => 'link', 3 => '?', 4 => 'filter', 5 => 'count', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', 3 => 'link_name', 4 => '', 5 => '', ), 'jsonParams' => array ( 0 => 'filter', ), 'method' => 'filterRelatedCount', 'shortHelp' => 'Lists related filtered records.', 'longHelp' => 'include/api/help/module_record_link_link_name_filter_get_help.html', 'file' => 'clients/mobile/api/RelateMobileApi.php', 'className' => 'RelateMobileApi', 'score' => 13.0, ), ), 'leancount' => array ( 0 => array ( 'reqType' => 'GET', 'minVersion' => '11.4', 'path' => array ( 0 => '<module>', 1 => '?', 2 => 'link', 3 => '?', 4 => 'filter', 5 => 'leancount', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', 3 => 'link_name', 4 => '', 5 => '', ), 'jsonParams' => array ( 0 => 'filter', ), 'method' => 'filterRelatedLeanCount', 'shortHelp' => 'Gets the "lean" count of filtered related items. The count should always be in the range: 0..max_num. The response has a boolean flag "has_more" that defines if there are more rows, than max_num parameter value.', 'longHelp' => 'include/api/help/module_record_link_link_name_filter_get_help.html', 'file' => 'clients/mobile/api/RelateMobileApi.php', 'className' => 'RelateMobileApi', 'score' => 13.0, ), ), ), ), ), ), ), ), 'POST' => array ( '<module>' => array ( '?' => array ( 'link' => array ( '?' => array ( 'add_record_list' => array ( '?' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => '<module>', 1 => '?', 2 => 'link', 3 => '?', 4 => 'add_record_list', 5 => '?', ), 'pathVars' => array ( 0 => 'module', 1 => 'record', 2 => '', 3 => 'link_name', 4 => '', 5 => 'remote_id', ), 'method' => 'createRelatedLinksFromRecordList', 'shortHelp' => 'Relates existing records from a record list to this record.', 'longHelp' => 'include/api/help/module_record_links_from_recordlist_post_help.html', 'file' => 'clients/mobile/api/RelateRecordMobileApi.php', 'className' => 'RelateRecordMobileApi', 'score' => 12.0, ), ), ), ), ), ), ), ), ), ), 8 => array ( 'base' => array ( 'POST' => array ( 'integrate' => array ( '<module>' => array ( '?' => array ( '?' => array ( 'link' => array ( '?' => array ( '?' => array ( '?' => array ( 0 => array ( 'reqType' => 'POST', 'path' => array ( 0 => 'integrate', 1 => '<module>', 2 => '?', 3 => '?', 4 => 'link', 5 => '?', 6 => '?', 7 => '?', ), 'pathVars' => array ( 0 => '', 1 => 'module', 2 => 'lhs_sync_key_field_name', 3 => 'lhs_sync_key_field_value', 4 => '', 5 => 'link_name', 6 => 'rhs_sync_key_field_name', 7 => 'rhs_sync_key_field_value', ), 'method' => 'relateByFields', 'shortHelp' => 'Create a relationship based on fields. If both the LHS and RHS records can be found with the respective fields, then relate the RHS record to the LHS record.', 'file' => 'clients/base/api/IntegrateRelateApi.php', 'className' => 'IntegrateRelateApi', 'score' => 13.5, ), ), ), ), ), ), ), ), ), ), 'DELETE' => array ( 'integrate' => array ( '<module>' => array ( '?' => array ( '?' => array ( 'link' => array ( '?' => array ( '?' => array ( '?' => array ( 0 => array ( 'reqType' => 'DELETE', 'path' => array ( 0 => 'integrate', 1 => '<module>', 2 => '?', 3 => '?', 4 => 'link', 5 => '?', 6 => '?', 7 => '?', ), 'pathVars' => array ( 0 => '', 1 => 'module', 2 => 'lhs_sync_key_field_name', 3 => 'lhs_sync_key_field_value', 4 => '', 5 => 'link_name', 6 => 'rhs_sync_key_field_name', 7 => 'rhs_sync_key_field_value', ), 'method' => 'unrelateByFields', 'shortHelp' => 'Remove a relationship based on fields. If both the LHS and RHS records can be found with the respective fields, and those records are related, then remove the relationship of the RHS record to the LHS record.', 'file' => 'clients/base/api/IntegrateRelateApi.php', 'className' => 'IntegrateRelateApi', 'score' => 13.5, ), ), ), ), ), ), ), ), ), ), ), ), );