Is Workspace Exist
The Is Workspace Exist API is used to check whether the Workspace is exists or not in Zoho Analytics Account. The account Administrator and the Workspace Admin alone can use this API to get check Workspace in the Zoho Analytics account.
REQUEST URI
https://<ZohoAnalytics_Server_URI>/api/<OwnerEmail>
Get
oauthscope: ZohoAnalytics.metadata.read
COMMON PARAMETERS
| Parameter | Possible Values | Description |
|---|---|---|
| ZOHO_ACTION | ISDBEXIST | This parameter specifies the action to be performed by the API request. |
| ZOHO_OUTPUT_FORMAT | XML/JSON | This parameter specifies the output format for the response. |
| ZOHO_ERROR_FORMAT | XML/JSON | Specifies the output format for the response in case an error occurs when trying to process the request. |
| ZOHO_API_VERSION | 1.0 | The API version of Zoho Analytics based on which the application(/service) has been written. This parameter allows the Zoho Analytics to handle applications based on the older versions.The current API version is 1.0 |
AUTHORIZATION
To make authenticated API request, append the access token in Authorization request header.
| Header Name | Value | Description |
|---|---|---|
| Authorization | Zoho-oauthtoken<space><access_token> | The Access token provides a secure and temporary access to Zoho Analytics API's. Each access token will be valid only for an hour, and can be used only for the set of operations that is described in the scope. |
ACTION SPECIFIC PARAMETERS
| Parameter | Possible Values | Description |
|---|---|---|
| ZOHO_DB_NAME (mandatory) | <Workspacename> | This parameter holds the name of the Workspace |
POSSIBLE ERROR CODES
Sample Request:
Copiedcurl
-d "ZOHO_ACTION=ISDBEXIST&ZOHO_OUTPUT_FORMAT=XML&ZOHO_ERROR_FORMAT=XML&ZOHO_API_VERSION=1.0&ZOHO_DB_NAME=Workspace Name"
-H "Authorization:Zoho-oauthtoken <access_token>"
https://analyticsapi.zoho.com/api/EmailAddressCopiedusing ZReports;
namespace Test
{
CLIENT_ID = "************";
CLIENT_SECRET = "************";
REFRESH_TOKEN = "************";
EMAIL = "Email Address";
class Program
{
public IReportClient getClient()
{
IReportClient RepClient = new ReportClient(CLIENT_ID, CLIENT_SECRET, REFRESH_TOKEN);
return RepClient;
}
public void isdbexist(IReportClient rc)
{
try
{
string uri = rc.GetURI(EMAIL);
bool result = rc.IsDbExist(uri, "Workspace Name", null);
Console.WriteLine(result);
}
catch (Exception e)
{
Console.WriteLine(e);
}
}
static void Main(string[] args)
{
Program obj = new Program();
IReportClient rc = obj.getClient();
obj.isdbexist(rc);
}
}
}
Copiedpackage main
import (
"fmt"
"zoho/pkg/reportclient"
)
var (
email = "Email Address"
clientid = "************"
clientsecret = "************"
refreshtoken = "************"
)
func isdbexist() {
url := reportclient.GetUserUri(email)
databasename := "Workspace Name"
params := map[string]string{}
result, err := reportclient.IsDbExist(url, databasename, params)
if err != nil {
fmt.Println(err.ErrorMessage)
fmt.Println(err.ErrorCode)
fmt.Println(err.Action)
fmt.Println(err.HttpStatusCode)
} else {
fmt.Println(result)
}
}
func main() {
reportclient.SetOAuthToken(clientid, clientsecret, refreshtoken)
isdbexist()
}
Copiedimport com.adventnet.zoho.client.report.*;
public class Sample {
String email = "Email Address";
String clientId = "************";
String clientSecret = "************";
String refreshToken = "************";
private ReportClient rc = new ReportClient(clientId, clientSecret, refreshToken);
public void isdbexist() throws Exception {
String uri = rc.getURI(email);
boolean result = rc.isDbExist(uri, "Workspace Name", null);
}
public static void main(String[] args) throws Exception {
Sample obj = new Sample();
obj.isdbexist();
}
}
Copied<?php
require 'ReportClient.php';
$EMAIL_ID = "Email Address";
$CLIENT_ID = "************";
$CLIENT_SECRET = "************";
$REFRESH_TOKEN = "************";
$report_client_request = new ReportClient($CLIENT_ID, $CLIENT_SECRET, $REFRESH_TOKEN);
$uri = $report_client_request->getUserURI($EMAIL_ID);
$dbname = "Workspace Name";
$result = $report_client_request->isDbExist($uri, $dbname);
?>
Copiedfrom __future__ import with_statement
from ReportClient import ReportClient
import sys
class Sample:
LOGIN_EMAIL_ID = "Email Address"
CLIENT_ID = "************"
CLIENT_SECRET = "************"
REFRESH_TOKEN = "************"
rc = None
rc = ReportClient(REFRESH_TOKEN, CLIENT_ID, CLIENT_SECRET)
def isdbexist(self, rc):
uri = rc.getUserURI(self.LOGIN_EMAIL_ID)
dbname = "Workspace Name"
result = rc.isDbExist(uri, dbname)
print(result)
obj = Sample()
obj.isdbexist(obj.rc)
Copiedvar nodelib = require('./ZAnalyticsClient');
var clientId = '************';
var clientSecret = '************';
var refreshtoken = '************';
var emailId = 'EmailAddress';
var workspaceName = 'WorkspaceName';
nodelib.initialize(clientId, clientSecret, refreshtoken).then(() => {
var params = {};
var uripath = nodelib.getUri(emailId);
nodelib.isWorkspaceExist(workspaceName, uripath, params).then((response) => {
console.log(response);
}).catch((error) => {
console.log('Error : ' + error.message);
});
}).catch((error) => {
console.log('Authentication Error : ' + error);
});
Copiedemail = zoho.encryption.urlEncode("");
paramsMap = Map();
oauthParams = Map();
headers = Map();
// AUTHENTICATION PARAMS
oauthParams.put("client_id", "********");
oauthParams.put("client_secret", "********");
oauthParams.put("refresh_token", "********");
oauthParams.put("grant_type", "refresh_token");
tokenInfo = invokeurl[url: "https://accounts.zoho.com/oauth/v2/token" type: POST parameters: oauthParams];
if (tokenInfo.containKey("access_token")) {
accessToken = tokenInfo.get("access_token");
headers.put("Authorization", "Zoho-oauthtoken ".concat(accessToken));
} else {
info tokenInfo;
return;
}
// COMMON PARAMS
paramsMap.put("ZOHO_ACTION", "ISDBEXIST");
paramsMap.put("ZOHO_OUTPUT_FORMAT", "JSON");
paramsMap.put("ZOHO_ERROR_FORMAT", "JSON");
paramsMap.put("ZOHO_API_VERSION", "1.0");
// ACTION SPECIFIC PARAMS
paramsMap.put("ZOHO_DB_NAME", "");
response = invokeurl[url: "https://analyticsapi.zoho.com/api/" + email type: POST parameters: paramsMap headers: headers];
info response;