Get Sections
Table of Contents
Overview
This JS API task fetches the information about the sections defined for a web device in a Creator application. It also includes the meta information of the underlying visible components: forms, reports, and pages, such as their link names, display names, and so on.
This V2 task is based on the Get Sections REST API V2.1. Learn more about the component's type value in the response
Request Details
Syntax
ZOHO.CREATOR.META.getSections(<config>).then(function(response){
//callback block
});
Syntax Details
The syntax holds:
- <config> (object) - The configuration required to fetch the meta information of the sections and the components under them, in a Creator application. This configuration includes the following parameters.
Name | Type | Description |
app_name | string | Link name of the application whose meta data needs to be fetched. Retrieve the link name using the specific Creator application's URL: https://creatorapp.zoho.com/<account_name>/<app_name> |
Possible Errors
Refer to this page for the complete list of error codes and messages.
Sample Input
Copiedvar config = {
app_name: "zylker"
};
ZOHO.CREATOR.META.getSections(config).then(function (response) {
console.log(response.sections);
});
Sample Response
Copied{
"code": 3000,
"s": [
{
"components": [
{
"type": 1,
"link_name": "reports_check",
"display_name": "reports check"
},
{
"report_type": 1,
"type": 2,
"link_name": "reports_check_Report",
"display_name": "reports check Report"
},
{
"report_type": 8,
"type": 2,
"link_name": "pivot_chart",
"display_name": "pivot chart"
},
{
"report_type": 7,
"type": 2,
"link_name": "pivot_",
"display_name": "pivot "
},
{
"report_type": 6,
"type": 2,
"link_name": "spreadsheet",
"display_name": "spreadsheet"
},
{
"report_type": 2,
"type": 2,
"link_name": "calendar",
"display_name": "calendar"
},
{
"report_type": 10,
"type": 2,
"link_name": "Timeline",
"display_name": "Timeline"
},
{
"report_type": 5,
"type": 2,
"link_name": "Map_view",
"display_name": "Map"
},
{
"report_type": 4,
"type": 2,
"link_name": "Kanban",
"display_name": "Kanban"
},
],
"display_name": "reports check",
"link_name": "reports_check"
},
{
"components": [
{
"page_type": 2,
"type": 3,
"link_name": "Dashboard",
"display_name": "Dashboard"
}
],
"display_name": "Dashboard",
"link_name": "Dashboard"
},
{
"components": [
{
"display_name": "Pending Tasks",
"link_name": "Pending"
},
{
"display_name": "Completed Tasks",
"link_name": "Completed"
}
],
"display_name": "Approval Tasks",
"is_approval": "true"
}
]
}
Show full
Show less