Get Forms

Table of Contents

Overview

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

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

Request Details

Syntax

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

Syntax Details

The syntax holds:

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

Sample Response

Copiedresponse = {
   "code": 3000,
   "forms": [
       {
         "display_name": "timesheet",
         "link_name": "timesheet",
         "type": 1
       },
       {
         "display_name": "products",
         "link_name": "products",
         "type": 1
       }
   ]
}