Get All Module Metadata
Table of Contents
You can get the metadata of all the modules using the zoho.crm.invokeConnector() deluge task.
Note:
- This task can be performed only in Zoho CRM Vertical Solutions.
- Each time the zoho.crm.invokeConnector integration task is executed, it triggers an API request in the back-end. This call is deducted from the external calls limit available for the service from which the task is executed, based on your pricing plan.
- Only actual executions that receive a response (whether success or failure) are counted, not the number of times the task appears in the script. For example, if zoho.crm.invokeConnector integration task is placed inside a for each task that iterates five times, the number of external calls consumed will be five, even though the task appears only once in the script.
Syntax
<Response> = zoho.crm.invokeConnector("crm.modulemetadata", <parameterMap>);
where:
| Params | Data type | Description |
|---|---|---|
| <Response> | KEY-VALUE | The task response returned as a Map |
| <parameterMap> | KEY-VALUE | A mandatory argument for the zoho.crm.invokeConnector() deluge task. In this case, an empty map can be passed as the argument. |
Example
map = Map(); modulemeta = zoho.crm.invokeConnector("crm.modulemetadata", map); info modulemeta;
Response Format
The response below shows a snippet of the entire response. Details of modules can be fetched using the key modules. The value for the key modules is an array with the metadata details of all modules.
{ "status_code": 200, "response": "{\"modules\": [{\"global_search_supported\":false, \"deletable\":false,\"creatable\":false,\"modified_time\":null,\"plural_label\":\"Home\", \"presence_sub_menu\":false,\"id\":\"2853142000000002173\",\"visibility\":1,\"convertable\":false, \"editable\":false,\"profiles\":[{\"name\":\"Administrator\",\"id\":\"2853142000000026011\"}, {\"name\":\"Standard\",\"id\":\"2853142000000026014\"}],\"filter_supported\":false, \"web_link\":null,\"sequence_number\":1,\"singular_label\":\"Home\",\"viewable\":true, \"api_supported\":false,\"api_name\":\"Home\",\"quick_create\":false,\"modified_by\":null, \"generated_type\":\"default\",\"feeds_required\":false,\"scoring_supported\":false, \"arguments\":[],\"module_name\":\"Home\",\"business_card_field_limit\":0,\"parent_module\":{}}, {\"global_search_supported\":true,\"deletable\":true,\"creatable\":true, \"modified_time\":\"2018-11-19T10:47:34+05:30\",\"plural_label\":\"Leads\", \"presence_sub_menu\":true,\"id\":\"2853142000000002175\",\"visibility\":1,\"convertable\":true, \"editable\":true,\"profiles\":[{\"name\":\"Administrator\",\"id\":\"2853142000000026011\"}, {\"name\":\"Standard\",\"id\":\"2853142000000026014\"}],\"filter_supported\":true,\"web_link\":null, \"sequence_number\":2,\"singular_label\":\"Lead\",\"viewable\":true,\"api_supported\":true, \"api_name\":\"Leads\",\"quick_create\":true,\"modified_by\":{\"name\":\"ZohoDemo\", \"id\":\"2853142000000131009\"},\"generated_type\":\"default\",\"feeds_required\":false, \"scoring_supported\":true,\"arguments\":[],\"module_name\":\"Leads\", \"business_card_field_limit\":5,\"parent_module\":{}},... ]}" }
Details of the Leads module have been extracted from the response and shown below:
{ \"global_search_supported\":true,\"deletable\":true,\"creatable\":true, \"modified_time\":\"2018-11-19T10:47:34+05:30\",\"plural_label\":\"Leads\",\ "presence_sub_menu\":true,\"id\":\"2853142000000002175\",\"visibility\":1,\"convertable\":true, \"editable\":true,\"profiles\":[{\"name\":\"Administrator\",\"id\":\"2853142000000026011\"}, {\"name\":\"Standard\",\"id\":\"2853142000000026014\"}],\"filter_supported\":true,\"web_link\":null, \"sequence_number\":2,\"singular_label\":\"Lead\",\"viewable\":true,\"api_supported\":true, \"api_name\":\"Leads\",\"quick_create\":true,\"modified_by\":{\"name\":\"ZohoDemo\", \"id\":\"2853142000000131009\"},\"generated_type\":\"default\",\"feeds_required\":false, \"scoring_supported\":true,\"arguments\":[],\"module_name\":\"Leads\", \"business_card_field_limit\":5,\"parent_module\":{} }