Get All Module Metadata

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

  1. <Response> = zoho.crm.invokeConnector("crm.modulemetadata", <parameterMap>);
where,
  1. <Response> is the task response returned as a Map.
  2. <parameterMap> is a mandatory argument for the zoho.crm.invokeConnector() deluge task. In this case, an empty map can be passed as the argument.

Example

  1. map = Map();
  2. modulemeta = zoho.crm.invokeConnector("crm.modulemetadata", map);
  3. 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.
  1. {"status_code":200,"response":"{\"modules\": [{\"global_search_supported\":false,
  2. \"deletable\":false,\"creatable\":false,\"modified_time\":null,\"plural_label\":\"Home\",
  3. \"presence_sub_menu\":false,\"id\":\"2853142000000002173\",\"visibility\":1,\"convertable\":false,
  4. \"editable\":false,\"profiles\":[{\"name\":\"Administrator\",\"id\":\"2853142000000026011\"},
  5. {\"name\":\"Standard\",\"id\":\"2853142000000026014\"}],\"filter_supported\":false,
  6. \"web_link\":null,\"sequence_number\":1,\"singular_label\":\"Home\",\"viewable\":true,
  7. \"api_supported\":false,\"api_name\":\"Home\",\"quick_create\":false,\"modified_by\":null,
  8. \"generated_type\":\"default\",\"feeds_required\":false,\"scoring_supported\":false,
  9. \"arguments\":[],\"module_name\":\"Home\",\"business_card_field_limit\":0,\"parent_module\":{}},
  10. {\"global_search_supported\":true,\"deletable\":true,\"creatable\":true,
  11. \"modified_time\":\"2018-11-19T10:47:34+05:30\",\"plural_label\":\"Leads\",
  12. \"presence_sub_menu\":true,\"id\":\"2853142000000002175\",\"visibility\":1,\"convertable\":true,
  13. \"editable\":true,\"profiles\":[{\"name\":\"Administrator\",\"id\":\"2853142000000026011\"},
  14. {\"name\":\"Standard\",\"id\":\"2853142000000026014\"}],\"filter_supported\":true,\"web_link\":null,
  15. \"sequence_number\":2,\"singular_label\":\"Lead\",\"viewable\":true,\"api_supported\":true,
  16. \"api_name\":\"Leads\",\"quick_create\":true,\"modified_by\":{\"name\":\"ZohoDemo\",
  17. \"id\":\"2853142000000131009\"},\"generated_type\":\"default\",\"feeds_required\":false,
  18. \"scoring_supported\":true,\"arguments\":[],\"module_name\":\"Leads\",
  19. \"business_card_field_limit\":5,\"parent_module\":{}},...
  20. ]}"}

Details of the Leads module have been extracted from the response and shown below:
  1. {\"global_search_supported\":true,\"deletable\":true,\"creatable\":true,
  2. \"modified_time\":\"2018-11-19T10:47:34+05:30\",\"plural_label\":\"Leads\",\
  3. "presence_sub_menu\":true,\"id\":\"2853142000000002175\",\"visibility\":1,\"convertable\":true,
  4. \"editable\":true,\"profiles\":[{\"name\":\"Administrator\",\"id\":\"2853142000000026011\"},
  5. {\"name\":\"Standard\",\"id\":\"2853142000000026014\"}],\"filter_supported\":true,\"web_link\":null,
  6. \"sequence_number\":2,\"singular_label\":\"Lead\",\"viewable\":true,\"api_supported\":true,
  7. \"api_name\":\"Leads\",\"quick_create\":true,\"modified_by\":{\"name\":\"ZohoDemo\",
  8. \"id\":\"2853142000000131009\"},\"generated_type\":\"default\",\"feeds_required\":false,
  9. \"scoring_supported\":true,\"arguments\":[],\"module_name\":\"Leads\",
  10. \"business_card_field_limit\":5,\"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 CRM Training
      Redefine the way you work
      with Zoho Workplace

        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 CRM Training

          Create, share, and deliver

          beautiful slides from anywhere.

          Get Started Now


            Zoho Sign now offers specialized one-on-one training for both administrators and developers.

            BOOK A SESSION








                                    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.




                                        Manage your brands on social media

                                          Zoho Desk Resources

                                          • Desk Community Learning Series


                                          • Digest


                                          • Functions


                                          • Meetups


                                          • Kbase


                                          • Resources


                                          • Glossary


                                          • Desk Marketplace


                                          • MVP Corner


                                          • Word of the Day


                                            Zoho Marketing Automation

                                              Zoho Sheet Resources

                                               

                                                  Zoho Forms Resources


                                                    Secure your business
                                                    communication with Zoho Mail


                                                    Mail on the move with
                                                    Zoho Mail mobile application

                                                      Stay on top of your schedule
                                                      at all times


                                                      Carry your calendar with you
                                                      Anytime, anywhere




                                                            Zoho Sign Resources

                                                              Sign, Paperless!

                                                              Sign and send business documents on the go!

                                                              Get Started Now




                                                                      Zoho TeamInbox Resources



                                                                              Zoho DataPrep Resources



                                                                                Zoho DataPrep Demo

                                                                                Get a personalized demo or POC

                                                                                REGISTER NOW


                                                                                  Design. Discuss. Deliver.

                                                                                  Create visually engaging stories with Zoho Show.

                                                                                  Get Started Now









                                                                                                      • Related Articles

                                                                                                      • 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> = ...
                                                                                                      • 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 ...
                                                                                                        Wherever you are is as good as
                                                                                                        your workplace

                                                                                                          Resources

                                                                                                          Videos

                                                                                                          Watch comprehensive videos on features and other important topics that will help you master Zoho CRM.



                                                                                                          eBooks

                                                                                                          Download free eBooks and access a range of topics to get deeper insight on successfully using Zoho CRM.



                                                                                                          Webinars

                                                                                                          Sign up for our webinars and learn the Zoho CRM basics, from customization to sales force automation and more.



                                                                                                          CRM Tips

                                                                                                          Make the most of Zoho CRM with these useful tips.



                                                                                                            Zoho Show Resources