Choose where you’d like to start

Get Module Metadata

Table of Contents

You can get a particular module's metadata using the zoho.crm.invokeConnector() deluge task.

Note: This task can be performed only in Zoho CRM Vertical Solutions.

​Syntax

<Response> = zoho.crm.invokeConnector("crm.modulemetadata", <module Map>);

where:                                                                                                                                               

ParamsData typeDescription

<Response>

 KEY-VALUE

 The task response returned as a Map

<module Map>

 KEY-VALUE

 The map variable to hold the API name of the module whose metadata you want to fetch. For example, Price_Books is the API Name of Price Books module. Use the Refer Fields in the Deluge Script Editor to learn these names.

Example

Fetch the metadata of the Leads module.

moduleMap = Map();
moduleMap.put("module","Leads");
modulemeta = zoho.crm.invokeConnector("crm.modulemetadata", moduleMap);
info modulemeta;

Response Format

Success Response

{   {"status_code": 200,   "response": "{\"modules\":[\"global_search_supported\":true, \"deletable\":true,\"creatable\":true,\"filter_status\":true, \"modified_time\":\"2018-11-19T10:47:34+05:30\",\"plural_label\":\"Leads\", \"presence_sub_menu\":true,\"id\":\"2853142000000002175\", \"related_list_properties\":{\"sort_by\":null,\"fields\":[\"First_Name\", \"Last_Name\",\"Full_Name\",\"Company\",\"Email\",\"Lead_Source\", \"Lead_Status\",\"Phone\"],\"sort_order\":null},\"$properties\":[\"$converted\", \"$approved\",\"$converted_detail\",\"$currency_symbol\",\"$approval\", \"$process_flow\"],\"per_page\":10,\"visibility\":1,\"convertable\":true, \"editable\":true,\"profiles\":[{\"name\":\"Administrator\", \"id\":\"2853142000000026011\"},{\"name\":\"Standard\", \"id\":\"2853142000000026014\"}],\"filter_supported\":true, \"display_field\":\"Full_Name\",\"search_layout_fields\":[\"Company\", \"Owner\",\"Full_Name\",\"Email\",\"Phone\",\"Lead_Source\"], \"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, \"custom_view\":{\"display_value\":\"All Leads\",\"shared_type\":null, \"criteria\":{\"comparator\":\"equal\",\"field\":\"$converted\", \"value\":false},\"system_name\":\"ALLVIEWS\",\"shared_details\":null, \"sort_by\":null,\"offline\":true,\"default\":true,\"system_defined\":true, \"name\":\"All Open Leads\",\"id\":\"2853142000000087501\", \"category\": \"shared_with_me\",\"fields\":[\"Full_Name\",\"Company\", \"Email\",\"Phone\",\"Lead_Source\",\"Owner\", \"Mobile\", \"Last_Activity_Time\",\"Prediction_Score\"],\"favorite\":null, \"sort_order\":null}, \"parent_module\":{}}]}" }  
 

Get Started Now

Execute