Is Column Exist
The Is Column Exist API is used to check whether the Column exists or not in the paticular table of workspace on Zoho Analytics Account.
REQUEST URI
https://<ZohoAnalytics_Server_URI>/api/<OwnerEmail>/<WorkspaceName>/<TableName>
Get
oauthscope: ZohoAnalytics.metadata.read
COMMON PARAMETERS
| Parameter | Possible Values | Description |
|---|---|---|
| ZOHO_ACTION | ISCOLUMNEXIST | 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_COLUMN_NAME (mandatory) | <columnname> | This parameter holds the name of the Column. |
POSSIBLE ERROR CODES
Sample Request:
Copiedcurl
-d "ZOHO_ACTION=ISCOLUMNEXIST&ZOHO_OUTPUT_FORMAT=XML&ZOHO_ERROR_FORMAT=XML&ZOHO_API_VERSION=1.0&ZOHO_COLUMN_NAME=Column_Name"
-H "Authorization:Zoho-oauthtoken <access_token>"
https://analyticsapi.zoho.com/api/EmailAddress/WorkspaceName/TableNameCopiedusing ZReports;
namespace Test
{
CLIENT_ID = "************";
CLIENT_SECRET = "************";
REFRESH_TOKEN = "************";
EMAIL = "Email Address";
DBNAME = "Workspace Name";
TABLENAME = "Table Name";
COLUMNNAME = "Column Name";
class Program
{
public IReportClient getClient()
{
IReportClient RepClient = new ReportClient(CLIENT_ID, CLIENT_SECRET, REFRESH_TOKEN);
return RepClient;
}
public void iscolumnexist(IReportClient RepClient)
{
string uri = RepClient.GetURI(EMAIL, DBNAME, TABLENAME);
bool result = RepClient.IsColumnExist(uri, COLUMNNAME, null);
Console.WriteLine(result);
}
static void Main(string[] args)
{
Program obj = new Program();
IReportClient rc = obj.getClient();
obj.iscolumnexist(rc);
}
}
}
Copiedpackage main
import (
"fmt"
"zoho/pkg/reportclient"
)
var (
email = "Email Address"
dbname = "Workspace Name"
tbname = "Table Name"
clientid = "************"
clientsecret = "************"
refreshtoken = "************"
)
func iscolumnexist() {
url := reportclient.GetUri(email, dbname, tbname)
columnname := "Column Name"
params := map[string]string{}
result, err := reportclient.IsColumnExist(url, columnname, 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)
iscolumnexist()
}
Copiedimport com.adventnet.zoho.client.report.*;
public class Sample {
String email = "Email Address";
String clientId = "************";
String clientSecret = "************";
String refreshToken = "************";
String dbname = "Workspace Name";
String tbname = "Table Name";
String columnname = "Column Name";
Map config = new HashMap();
private ReportClient rc = new ReportClient(clientId, clientSecret, refreshToken);
public void iscolumnexist() throws Exception {
String uri = rc.getURI(email, dbname, tbname);
boolean result = rc.isColumnExist(uri, columnname, new HashMap());
System.out.println(result);
}
public static void main(String[] args) throws Exception {
Sample obj = new Sample();
obj.iscolumnexist();
}
}
Copied<?php
require 'ReportClient.php';
$EMAIL_ID = "Email Address";
$DB_NAME = "Workspace Name";
$TABLE_NAME = "Table Name";
$COLUMN_NAME = "Column Name";
$CLIENT_ID = "************";
$CLIENT_SECRET = "************";
$REFRESH_TOKEN = "************";
$report_client_request = new ReportClient($CLIENT_ID, $CLIENT_SECRET, $REFRESH_TOKEN);
$uri = $report_client_request->getURI($EMAIL_ID, $DB_NAME, $TABLE_NAME);
$response = $report_client_request->isColumnExist($uri, $COLUMN_NAME);
?>
Copiedfrom __future__ import with_statement
from ReportClient import ReportClient
import sys
class Sample:
LOGIN_EMAIL_ID = "Email Address"
CLIENT_ID = "************"
CLIENT_SECRET = "************"
REFRESH_TOKEN = "************"
DATABASE_NAME = "Workspace Name"
TABLE_NAME = "Table Name"
rc = None
rc = ReportClient(REFRESH_TOKEN, CLIENT_ID, CLIENT_SECRET)
def isColumnExist(self, rc):
uri = rc.getURI(self.LOGIN_EMAIL_ID, self.DATABASE_NAME, self.TABLE_NAME)
columnName = "Column Name"
result = rc.isColumnExist(uri, columnName)
print(result)
obj = Sample()
obj.isColumnExist(obj.rc)
Copiedvar nodelib = require('./ZAnalyticsClient');
var clientId = '************';
var clientSecret = '************';
var refreshtoken = '************';
var emailId = 'EmailAddress';
var workspaceName = 'WorkspaceName';
var viewName = 'ViewName';
var columnName = 'ColumnName';
nodelib.initialize(clientId, clientSecret, refreshtoken).then(() => {
var params = {};
var uripath = nodelib.getUri(emailId, workspaceName, viewName);
nodelib.isColumnExist(columnName, 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", "ISCOLUMNEXIST");
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_COLUMN_NAME", "");
response = invokeurl[url: "https://analyticsapi.zoho.com/api/" + email type: POST parameters: paramsMap headers: headers];
info response;