Get Module Metadata
This guide will help you with the following:
1. Syntax
2. Example
3. Response Format
You can get a particular module's metadata using the zoho.crm.invokeConnector() deluge task.
Syntax
- <Response> = zoho.crm.invokeConnector("crm.modulemetadata", <module Map>);
where,
- <Response> is the task response returned as a Map.
- <module Map> is 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
- {"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\":{}}]}"}
Zoho CRM Training Programs
Learn how to use the best tools for sales force automation and better customer engagement from Zoho's implementation specialists.
Zoho DataPrep Personalized Demo
If you'd like a personalized walk-through of our data preparation tool, please request a demo and we'll be happy to show you how to get the best out of Zoho DataPrep.
- Zoho Workerly Home
- Forums
- Connect With Us:
- Zoho Recruit Home
- Forums
- Connect With Us:
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho Marketing Plus?
Everything you need to run your marketing
New to Zoho Marketing Plus?
Everything you need to run your marketing
You are currently viewing the help pages of Qntrl’s earlier version. Click here to view our latest version—Qntrl 3.0's help articles.
New to Zoho Survey?
Zoho Sheet Resources
Zoho Forms Resources
New to Zoho Sign?
Zoho Sign Resources
Sign, Paperless!
New to Zoho TeamInbox?
Zoho TeamInbox Resources
New to Zoho ZeptoMail?
Zoho DataPrep Resources
Design. Discuss. Deliver.
New to Zoho Workerly?
New to Zoho Recruit?
New to Zoho CRM?
New to Zoho Projects?
New to Zoho Sprints?
New to Zoho Assist?
New to Bigin?
Related Articles
Get All Module Metadata
This guide will help you with the following: 1. Syntax 2. Example 3. Response Format You can get the metadata of all the modules using the zoho.crm.invokeConnector() deluge task. Syntax <Response> = ...Get User Data
This guide will help you with the following: Syntax Example Response Format Additional Example Round Robin Assignment The details about the users of an extension or vertical solution can be fetched using the zoho.crm.getRecords() deluge task. ...Get URL
The get URL Deluge task corresponds to a HTTP GET request. It is normally supported by services to perform read-only operations like fetching data from external websites. By default, it supports websites running in port 80 and 443. Syntax a. To get a ...Get File Name
Description The getFileName task is used to get the name of the specified file. Syntax <response> = <file_object>.getFileName(); where, Example The following script returns the name of the file that the variable - fileVariable holds. // to fetch ...Get File Type
Description The getFileType task is used to get the type of the specified file. Syntax <response> = <file_object>.getFileType(); where, Example The following script returns the type of the file that the variable - fileVariable holds. // to fetch ...
New to Zoho LandingPage?
Zoho LandingPage Resources