Get Reports

Table of Contents

Overview

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

This V2 task is based on the Get Reports REST API V2.1. Learn more about the report's type value in the response

Request Details

Syntax

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

Syntax Details

The syntax holds:

  • <config> (object) - The configuration required to fetch the meta information of the reports 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.getReports(config).then(function (response) {
  console.log(response.reports);
});

Sample Response

Copiedresponse = {
   "code": 3000,
   "reports": [
       {
         "display_name": "All Timesheet",
         "link_name": "All-Timesheet",
         "type": 1
       },
       {
         "display_name": "All Products",
         "link_name": "All-Products",
         "type": 1
       }
   ]
}