Modules
To get the modules metadata for the specified account.
View-Specific Information
Select
The add-in uses the Zoho CRM API to process WHERE clause conditions built with the following column and operator.
For example, the following queries are processed server-side:
SELECT * FROM Modules
Columns
| Name | Type | Description |
| Id | String | The unique identifier of the modules |
| Name | String | The name of the module which the user wants. |
| SequenceNumber | Integer | The sequence number of the field. |
| ApiName | String | The api name of the field. |
| GlobalSearchSupported | Boolean | Represents if the current module has global search support. |
| Deletable | Boolean | Describes if the user can delete a record in the current module. |
| Description | String | Represents the description of the module, if any. |
| Creatable | Boolean | Represents if the user can create records in the current module. |
| InventoryTemplateSupported | Boolean | Represents the module supports inventory template. The value will be true only for Quotes, Invoices, Purchase Orders, and Sales Orders modules. |
| ModifiedDateTime | Datetime | Represents the date and time of when the module properties were last modified. |
| PluralLabel | String | Represents the plural of the module name. Example: Leads. |
| SingularLabel | String | Represents the singular of the module name. Example: Lead. |
| PresenceSubMenu | Boolean | Represents if the module has a submenu. For instance, Tasks in Activities is a submenu. |
| TriggersSupported | Boolean | Represents if the module supports triggers from custom buttons, workflows, approval etc. |
| Visibility | Integer | Represents the visibility of the module in the org. 1- The module is visible, default value; 2- The module is hidden; XXXX - The sum of the feature numbers that are hidden. |
| Convertable | Boolean | Describes if the user can convert the record into another type of record. For example: Convert Leads into Deals. |
| Editable | Boolean | Describes if the user can edit a record in the current module. |
| EmailTemplateSupport | Boolean | Represents if the module supports the usage of the email templates. |
| FilterSupported | Boolean | Represents if the module supports custom filters besides the system-defined ones in a custom view. |
| ShowAsTab | Boolean | Represents if the module is displayed as a tab in the CRM UI. |
| Viewable | Boolean | Represents if the user can view the records in the current module. |
| ApiSupported | Boolean | Describes if the current module is accessible via API. |
| QuickCreate | Boolean | Represents if the module supports quick create. |
| ModifiedByName | String | Represents the name of the user who last modified the module properties. |
| ModifiedById | String | Represents the ID of the user who last modified the module properties. |
| GeneratedType | String | Represents how the module was created. |
| FeedsRequired | Boolean | Represents if feeds is enabled for the module. |
| ScoringSupported | Boolean | Represents if the records of the module qualify for the scoring process, if there is one. |
| WebformSupported | Boolean | Represents if the records in the module can be created via web forms. |
| BusinessCardFieldLimit | Integer | Represents the number of fields you can have in the business card details. |
| ParentModuleApiName | String | Represents the api name of the parent module, if any. For instance, Activities is the parent module for Tasks, Calls, and Events. |
| ParentModuleId | String | Represents the id of the parent module, if any. |
| WebLink | String | Represents the web link of the module, if any. For instance, https://extensions.zoho.com/plugin/facebook |
| IsBlueprintSupported | Boolean | Is blueprint Supported. |
| HasMoreProfiles | Boolean | Represents whether more profiles have access to the module. By default, the Module Metadata API lists up to 50 profiles in the 'profiles' key. If there are more than 50 profiles, this value will be true; if there are 50 or fewer, it will be false. |
| AccessType | String | Specifies the module's access type. |
| PrivateProfile | String | Represents the profiles available in the Teams module you have created. |
| RecycleBinOnDelete | Boolean | Represents whether records in the module can be moved to the recycle bin upon deletion. |
| Visible | Boolean | Represents if the module is visible to the current user's profile. |
| Profiles | String | Each object in the array represents the details of the profile that has access to the module. |
| Arguments | String | Represents the parameters for the link used in Web-tab. Each object represents display name and the value of the argument. |
| CustomView | String | Represents the details of the custom views created for this module. |
| Status | String | Represents if the module is user_hidden,system_hidden,scheduled_for_deletion or visible.
The allowed values are user_hidden, system_hidden, scheduled_for_deletion, visible. |
| SubMenuAvailable | Boolean | Represents if sub menu option is available for the module or not. |
| ActualPluralLabel | String | Represents the actual plural form of the module name. |
| ActualSingularLabel | String | Represents the actual singular form of the module name. |
| Lookupable | Boolean | Represents if the module can be used as a lookup field in other modules. |
| ProfileCount | Integer | Represents the number of profiles that have access to the module. |
| PublicFieldsConfigured | Boolean | Represents if public fields are configured for the module. |