Add Lookup
The Add Lookup API is used to Adds the lookup in the specified child table.
REQUEST URI
https://<ZohoAnalytics_Server_URI>/api/<OwnerEmail>/<WorkspaceName>/<TableName>
Post
oauthscope: ZohoAnalytics.modeling.update
COMMON PARAMETERS
| Parameter | Possible Values | Description |
|---|---|---|
| ZOHO_ACTION | ADDLOOKUP | 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 Name | Possible Values | Description |
|---|---|---|
| ZOHO_COLUMNNAME (mandatory) | <columnname> | The name of the column to be added into Zoho Analytics Table. Example:ZOHO_COLUMNNAME=Region . Note: The column name should be url encoded if the column name contain space or any special characters. |
| ZOHO_REFERREDTABLE (mandatory) | Table name | The name of the referred table. |
| ZOHO_REFERREDCOLUMN (mandatory) | Column name | The name of the column in the referred table. |
| ZOHO_IFERRORONCONVERSION (mandatory) | ABORT/EMPTY | If error on conversion. |
POSSIBLE ERROR CODES
Sample Request:
Copiedcurl -d "ZOHO_ACTION=ADDLOOKUP&ZOHO_OUTPUT_FORMAT=XML&ZOHO_ERROR_FORMAT=XML&
ZOHO_API_VERSION=1.0&
ZOHO_COLUMNNAME=Column Name&ZOHO_REFERREDTABLE=Ref Table Name&
ZOHO_REFERREDCOLUMN="Ref Column Name&ZOHO_IFERRORONCONVERSION=ABORT"
-H "Authorization:Zoho-oauthtoken <access_token>"
https://analyticsapi.zoho.com/api/EmailAddress/WorkspaceName/TableNameCopiedusing ZReports;
namespace Test
{
class Program
{
public IReportClient GetClient()
{
IReportClient RepClient = new ReportClient(CLIENT_ID, CLIENT_SECRET, REFRESH_TOKEN);
return RepClient;
}
public void AddLookup(IReportClient rc)
{
string uri = rc.GetURI(EMAIL, DBNAME, TBNAME);
string columnname = "Column Name";
string reftable = "Ref Table Name";
string refcolumn = "Ref Column Name";
string onerror = "ABORT";
rc.AddLookup(uri, columnname, reftable, refcolumn, onerror, null);
}
static void Main(string[] args)
{
Program obj = new Program();
IReportClient rc = obj.GetClient();
obj.AddLookup(rc);
}
}
}
Copiedpackage main
import (
"fmt"
"zoho/pkg/reportclient"
)
var (
email = "Email Address"
dbname = "Workspace Name"
tbname = "Table Name"
clientid = "************"
clientsecret = "************"
refreshtoken = "************"
)
func AddLookup() {
url := reportclient.GetUri(email, dbname, tbname)
columnname := "Column Name"
reftable := "Ref Table Name"
refcolumn := "Ref Column Name"
onerror := "ABORT"
err := reportclient.AddLookup(url, columnname, reftable, refcolumn, onerror)
if err != nil {
fmt.Println(err.ErrorMessage)
fmt.Println(err.ErrorCode)
fmt.Println(err.Action)
fmt.Println(err.HttpStatusCode)
} else {
fmt.Println("Success")
}
}
func main() {
reportclient.SetOAuthToken(clientid, clientsecret, refreshtoken)
AddLookup()
}
Copiedimport com.adventnet.zoho.client.report.*;
public class Sample {
String email = "Email Address";
String dbname = "Workspace Name";
String tbname = "Table Name";
String clientId = "************";
String clientSecret = "************";
String refreshToken = "************";
Map config = new HashMap();
private ReportClient rc = new ReportClient(clientId, clientSecret, refreshToken);
public void addLookup() throws Exception {
String uri = rc.getURI(email, dbname, tbname);
rc.addLookup(uri, "Column Name", "Ref Table Name", "Ref Column Name", "ABORT", config);
}
public static void main(String[] args) throws Exception {
Sample obj = new Sample();
obj.addLookup();
}
}
Copied<?php
require 'ReportClient.php';
$EMAIL_ID = "Email Address";
$DB_NAME = "Workspace Name";
$TABLE_NAME = "Table 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);
$column_name = "Column Name";
$referred_table = "Ref Table Name";
$referred_column = "Ref Column Name";
$on_error = "ABORT";
$report_client_request->addLookup($uri, $column_name, $referred_table, $referred_column, $on_error);
?>
Copiedfrom __future__ import with_statement
from ReportClient import ReportClient
import sys
class Sample:
LOGINEMAILID = "Email Address"
CLIENTID = "************"
CLIENTSECRET = "************"
REFRESHTOKEN = "************"
DATABASENAME = "Workspace Name"
TABLENAME = "Table Name"
rc = None
rc = ReportClient(REFRESHTOKEN, CLIENTID, CLIENTSECRET)
def addLookup(self, rc):
uri = rc.getURI(self.LOGINEMAILID, self.DATABASENAME, self.TABLENAME)
result = rc.addLookup(uri, "Column Name", "Ref Table Name", "Ref Column Name", "ABORT")
obj = Sample()
obj.addLookup(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);
var referedTable = '';
var referedColumn = '';
var onError = '';
nodelib.addLookup(columnName, referedTable, referedColumn, onError, 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("");
workspaceName = zoho.encryption.urlEncode("");
viewName = 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", "ADDLOOKUP");
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_COLUMNNAME", "");
paramsMap.put("ZOHO_REFERREDTABLE", "");
paramsMap.put("ZOHO_REFERREDCOLUMN", "");
paramsMap.put("ZOHO_IFERRORONCONVERSION", "");
response = invokeurl[url: "https://analyticsapi.zoho.com/api/" + email + "/" + workspaceName + "/" + viewName type: POST parameters: paramsMap headers: headers];
info response;