Get Modules

Purpose

To get metadata for fields, layouts, and related lists of the specified module using Widget APIs.

Request Format

ZOHO.RECRUIT.META.getModules
({
    "Entity": "{module_api_name}"
})

Sample Request (All Modules)

CopiedZOHO.RECRUIT.META.getModules().then(function(successResponse) {
   
}, function(errorResponse) {
   
});

Sample Request (Specific Module)

CopiedZOHO.RECRUIT.META.getModules({
    "Entity": "Candidates"
}).then(function(successResponse) {
   
}, function(errorResponse) {
    
});

Sample Request (Specific Module)

CopiedZOHO.RECRUIT.META.getModules({
    "Entity": "Candidates"
}).then(function(successResponse) {
    
}, function(errorResponse) {
    
});

Sample Response

Copied{
    "modules": [
        {
            "Import_My": true,
            "global_search_supported": true,
            "deletable": true,
            "creatable": true,
            "modified_time": "2019-07-29T14:16:54+05:30",
            "plural_label": "Candidates",
            "presence_sub_menu": true,
            "Export": true,
            "id": "486812000000063052",
            "related_list_properties": {
                "sort_by": null,
                "fields": [
                    "First_Name",
                    "Last_Name",
                    "City",
                    "Candidate_Status",
                    "Updated_On",
                    "Source",
                    "Candidate_Owner"
                ],
                "sort_order": null
            },
            "$properties": [
                "$converted",
                "$approved",
                "$converted_detail",
                "$currency_symbol",
                "$approval",
                "$followed",
                "$process_flow"
            ],
            "per_page": 100,
            "convertable": true,
            "editable": true,
            "emailTemplate_support": true,
            "profiles": [
                {
                    "name": "Administrator",
                    "id": "486812000000071961"
                },
                {
                    "name": "Standard",
                    "id": "486812000000071963"
                },
                {
                    "name": "Guest",
                    "id": "486812000000071965"
                },
                {
                    "name": "Interviewer",
                    "id": "486812000000071967"
                }
            ],
            "filter_supported": true,
            "display_field": {
                "api_name": "Full_Name",
                "id": "486812000000063052"
            },
            "web_link": null,
            "sequence_number": 3,
            "singular_label": "Candidate",
            "viewable": true,
            "api_supported": true,
            "api_name": "Candidates",
            "quick_create": true,
            "modified_by": {
                "name": "Thomas Shelby",
                "id": "486812000000216003"
            },
            "generated_type": "default",
            "scoring_supported": true,
            "module_name": "Candidates",
            "attachmenttypes": [
                {
                    "ismandatory": false,
                    "sequence_number": 1,
                    "isbulk": false,
                    "ispublish": false,
                    "isauto": false,
                    "name": "RESUME",
                    "view_type": {
                        "view": true,
                        "download": true,
                        "edit": true,
                        "create": true,
                        "delete": true
                    },
                    "se_presence": true,
                    "id": "486812000000072325",
                    "label": "Resume",
                    "isdefault": false,
                    "issystem": true
                },
                {
                    "ismandatory": false,
                    "sequence_number": 2,
                    "isbulk": false,
                    "ispublish": false,
                    "isauto": false,
                    "name": "FORMATTEDRESUME",
                    "view_type": {
                        "view": true,
                        "download": true,
                        "edit": true,
                        "create": true,
                        "delete": true
                    },
                    "se_presence": true,
                    "id": "486812000000072327",
                    "label": "Formatted Resume",
                    "isdefault": false,
                    "issystem": true
                },
                {
                    "ismandatory": false,
                    "sequence_number": 3,
                    "isbulk": false,
                    "ispublish": false,
                    "isauto": false,
                    "name": "COVERLETTER",
                    "view_type": {
                        "view": true,
                        "download": true,
                        "edit": true,
                        "create": true,
                        "delete": true
                    },
                    "se_presence": true,
                    "id": "486812000000072329",
                    "label": "Cover Letter",
                    "isdefault": false,
                    "issystem": false
                },
                {
                    "ismandatory": false,
                    "sequence_number": 4,
                    "isbulk": true,
                    "ispublish": false,
                    "isauto": false,
                    "name": "OTHERS",
                    "view_type": {
                        "view": true,
                        "download": true,
                        "edit": true,
                        "create": true,
                        "delete": true
                    },
                    "se_presence": true,
                    "id": "486812000000072331",
                    "label": "Others",
                    "isdefault": true,
                    "issystem": true
                },
                {
                    "ismandatory": false,
                    "sequence_number": 5,
                    "isbulk": false,
                    "ispublish": false,
                    "isauto": false,
                    "name": "ACCEPTEDOFFER",
                    "view_type": {
                        "view": true,
                        "download": true,
                        "edit": false,
                        "create": true,
                        "delete": true
                    },
                    "se_presence": true,
                    "id": "486812000000633049",
                    "label": "Offer",
                    "isdefault": false,
                    "issystem": true
                },
                {
                    "ismandatory": false,
                    "sequence_number": 6,
                    "isbulk": true,
                    "ispublish": false,
                    "isauto": false,
                    "name": "CONTRACTS",
                    "view_type": {
                        "view": true,
                        "download": true,
                        "edit": false,
                        "create": true,
                        "delete": true
                    },
                    "se_presence": true,
                    "id": "486812000000633050",
                    "label": "Contracts",
                    "isdefault": false,
                    "issystem": true
                }
            ],
            "Import_MyOrg": true,
            "custom_view": {
                "display_value": "Dataprocessing",
                "shared_type": null,
                "criteria": {
                    "group_operator": "or",
                    "group": [
                        {
                            "comparator": "equal",
                            "field": "Data_Processing_Basis",
                            "value": "486812000000275107"
                        },
                        {
                            "comparator": "equal",
                            "field": "Data_Processing_Basis",
                            "value": "486812000000275117"
                        }
                    ]
                },
                "system_name": null,
                "shared_details": null,
                "sort_by": null,
                "offline": true,
                "default": true,
                "system_defined": false,
                "name": "Dataprocessing",
                "id": "486812000001576009",
                "category": "created_by_me",
                "fields": [
                    "First_Name",
                    "Last_Name",
                    "City",
                    "Candidate_Status",
                    "Updated_On",
                    "Source",
                    "Email",
                    "Current_Salary"
                ],
                "favorite": null,
                "sort_order": null,
                "is_search": false
            },
            "parent_module": {}
        }
    ]
}