Get Pages

Table of Contents

Overview

This JS API task fetches the meta information of all the pages that are accessible for the requesting user in a Creator application, including the page's link name and display name.

This V2 task is based on the Get Pages REST API V2.1.

Request Details

Syntax

ZOHO.CREATOR.META.getPages(<config>).then(function(response){
//callback block
});

Syntax Details

The syntax holds:

  • <config> (object) - The configuration required to fetch the meta information of the pages in a Creator application. This configuration includes the following parameters.
NameTypeDescription
app_namestringLink 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.getPages(config).then(function (response) {
  console.log(response.pages);
});

Sample Response

Copiedresponse = {
   "code": 3000,
   "pages": [
       {
         "display_name": "Customer Dashboard",
         "link_name": "Customer_Dashboard"
       },
       {
         "display_name": "Vendor Dashboard",
         "link_name": "Vendor_Dashboard"
       }
   ]
}