Remove Lookup

The Remove Lookup API is used to Removes the lookup for the specified column in the given table.

REQUEST URI

https://<ZohoAnalytics_Server_URI>/api/<OwnerEmail>/<WorkspaceName>/<TableName>

Post

oauthscope: ZohoAnalytics.modeling.update

COMMON PARAMETERS

Parameter	Possible Values	Description
ZOHO_ACTION	REMOVELOOKUP	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.

POSSIBLE ERROR CODES

7103 , 7107 , 7138 , 8504 , 8506 , 8516 , 8533

Sample Request:

Curl Csharp Go Java PHP Python Node JS Deluge

Copiedcurl -d "ZOHO_ACTION=REMOVELOOKUP&ZOHO_OUTPUT_FORMAT=XML&ZOHO_ERROR_FORMAT=JSON&
         ZOHO_API_VERSION=1.0&
         ZOHO_COLUMNNAME=Column Name"
     -H "Authorization:Zoho-oauthtoken <access_token>"
     https://analyticsapi.zoho.com/api/EmailAddress/WorkspaceName/TableName

Copiedusing ZReports;
namespace Test
{
    CLIENT_ID = "************";
    CLIENT_SECRET = "************";
    REFRESH_TOKEN = "************";
    EMAIL = "Email Address";
    DBNAME = "Workspace Name";
    TBNAME = "Table Name";
    class Program
    {
        public IReportClient getClient()
        {
            IReportClient RepClient = new ReportClient(CLIENT_ID, CLIENT_SECRET, REFRESH_TOKEN);
            return RepClient;
        }
        public void removelookup(IReportClient rc)
        {
            string uri = rc.GetURI(EMAIL, DBNAME, TBNAME);
            string columnname = "Column Name";
            rc.RemoveLookup(uri, columnname, null);
        }
        static void Main(string[] args)
        {
            Program obj = new Program();
            IReportClient rc = obj.getClient();
            obj.removelookup(rc);
        }
    }
}

Copiedpackage main

import (
    "fmt"
    "zoho/pkg/reportclient"
)

var (
    email        = "Email Address"
    dbname       = "Workspace Name"
    tbname       = "Table Name"
    clientid     = "************"
    clientsecret = "************"
    refreshtoken = "************"
)

func removelookup() {
    url := reportclient.GetUri(email, dbname, tbname)
    columnname := "Column Name"
    err := reportclient.RemoveLookup(url, columnname)
    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)
    removelookup()
}

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 removelookup() throws Exception {
        String uri = rc.getURI(email, dbname, tbname);
        rc.removeLookup(uri, "Column Name", config);
    }

    public static void main(String[] args) throws Exception {
        Sample obj = new Sample();
        obj.removelookup();
    }
}

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";
$report_client_request->removeLookup($uri, $column_name);

?>

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 removelookup(self, rc):
        uri = rc.getURI(self.LOGINEMAILID, self.DATABASENAME, self.TABLENAME)
        result = rc.removeLookup(uri, "Column Name")
    
    obj = Sample()
    obj.removelookup(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.removeLookup(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("");
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", "REMOVELOOKUP");
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", "");

response = invokeurl[url: "https://analyticsapi.zoho.com/api/" + email + "/" + workspaceName + "/" + viewName type: POST parameters: paramsMap headers: headers];
info response;

Sample Response:

XML Json

Copied<?xml version="1.0"encoding="UTF-8" ?>
<responseuri="/api/EmailAddress/WorkspaceName/TableName"action="REMOVELOOKUP">
    <result>SUCCESS</result>
</response>

Copied{"response":
    {"uri":"\/api\/email\/WorkspaceName\/TableName",
        "action":"REMOVELOOKUP",
        "result":"SUCCESS"}}