Get Applications by Workspace

Table of Contents

Overview

This JS API task fetches the meta information of all the applications in a specific workspace that the requesting user has access to. This information includes an application's name, creation date, workspace, link name, and so on.

This V2 task is based on the Get Applications by Workspace REST API V2.1. Learn more about the application's category value in the response

Request Details

Syntax

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

Syntax Details

The syntax holds:

  • <config> (object) - The configuration required to fetch the meta information of the applications under a specific workspace. This configuration includes the following parameters.
NameTypeDescription
workspace_namestringLink name of the workspace whose meta data needs to be fetched. Retrieve the workspace name using the specific Creator application's URL: https://creatorapp.zoho.com/<workspace_name>/<app_name>

Possible Errors

Refer to this page for the complete list of error codes and messages.

Sample Input

Copiedvar config = {
  workspace_name: "zylker"
};
ZOHO.CREATOR.META.getApplicationsByWorkspace(config).then(function (response) {
  console.log(response.applications);
});

Sample Response

Copiedresponse = {
   "code": 3000,
   "applications": [
       {
         "application_name": "Library Management",
         "date_format": "dd-MMM-yyyy",
         "creation_date": "31-Jan-2024 20:30:20",
         "link_name": "librarymanagement",
         "category": 1,
         "time_zone": "Asia/Kolkata",
         "created_by": "zylker"
         "workspace_name": "zylker"
       }
    ]
 }