Hide Column

The Hide Column API is used to hide the column in Zoho Analytics Table. The account Administrator and the Workspace Admin alone can use this API to hide a column in the Zoho Analytics table.

REQUEST URI

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

Post

oauthscope: ZohoAnalytics.modeling.update

Note: In case of Workspace Admin hiding a column, they need to specify the login E-mail ID of the account Administrator only.

COMMON PARAMETERS

Parameter	Possible Values	Description
ZOHO_ACTION	HIDECOLUMN	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 (DATA FOR THE ROW)

Parameter	Possible Values	Description
ZOHO_COLUMNNAME (mandatory)	`<columnname>`	The name of the column to be hidden in Zoho Analytics Table. Example: ZOHO_COLUMNNAME=Region. Note:More than one param is allowed.

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=HIDECOLUMN&ZOHO_OUTPUT_FORMAT=XML&ZOHO_ERROR_FORMAT=XML&ZOHO_API_VERSION=1.0&ZOHO_COLUMNNAME=Column1&ZOHO_COLUMNNAME=Column2" 
-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 hidecolumn(IReportClient rc)
        {
            try
            {
                string uri = rc.GetURI(EMAIL, DBNAME, TBNAME);
                string[] columnNames = new string[3];
                columnNames[0] = "COlumn1";
                columnNames[1] = "COlumn2";
                columnNames[2] = "Column3";
                var result = rc.HideColumn(uri, columnNames, null);
            }
            catch (Exception e)
            {
                Console.WriteLine(e);
            }
        }

        static void Main(string[] args)
        {
            Program obj = new Program();
            IReportClient rc = obj.getClient();
            obj.hidecolumn(rc);
        }
    }
}

Copiedpackage main

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

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

func hidecolumn() {
	url := reportclient.GetUri(email, dbname, tbname)
	columnnames := []string{"Column1", "Column2", "Column3"}
	params := map[string]string{}
	result, err := reportclient.HideColumn(url, columnnames, 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)
	hidecolumn()
}

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 = "************";

    private ReportClient rc = new ReportClient(clientId, clientSecret, refreshToken);

    public void hidecolumn() throws Exception {
        String uri = rc.getURI(email, dbname, tbname);
        List columnNames = new ArrayList();
        columnNames.add("Column1");
        columnNames.add("Column2");
        Map result = rc.hideColumn(uri, columnNames, null);
    }

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

Copied<?php
require 'ReportClient.php';

$EMAIL_ID = "Email Address";
$DB_NAME = "Workspace Name";
$TABLE_NAME = "Table Name";
$CLIENT_ID = "************";
$CLIENT_SECRET = "************";
$REFRESH_TOKEN = "************";

$request = new ReportClient($CLIENT_ID, $CLIENT_SECRET, $REFRESH_TOKEN);
$uri = $request->getURI($EMAIL_ID, $DB_NAME, $TABLE_NAME);
$columnNames = array("Column1", "Column2");
$response = $request->hideColumn($uri, $columnNames);
?>

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 hidecolumn(self, rc):
        uri = rc.getURI(self.LOGIN_EMAIL_ID, self.DATABASE_NAME, self.TABLE_NAME)
        params = []
        params.append("Column1")
        params.append("Column2")
        params.append("Column3")
        result = rc.hideColumn(uri, params)
        print result

    obj = Sample()
    obj.hidecolumn(obj.rc)

Copiedvar nodelib = require('./ZAnalyticsClient');
var clientId = '************';
var clientSecret = '************';
var refreshtoken = '************';
var emailId = 'EmailAddress';
var workspaceName = 'WorkspaceName';
var viewName = 'ViewName';

nodelib.initialize(clientId, clientSecret, refreshtoken).then(() => {
    var params = {};
    var uripath = nodelib.getUri(emailId, workspaceName, viewName);
    var columnNames = ["", ""];
    nodelib.hideColumn(columnNames, 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", "RENAMECOLUMN");
paramsMap.put("ZOHO_OUTPUT_FORMAT", "JSON");
paramsMap.put("ZOHO_ERROR_FORMAT", "JSON");
paramsMap.put("ZOHO_API_VERSION", "1.0");

// ACTION SPECIFIC PARAMS
paramsMap.put("OLDCOLUMNNAME", "");
paramsMap.put("NEWCOLUMNNAME", "");
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="HIDECOLUMN">
    <result>
        <columncolumnName="Column1"status="Success"message="column hidden successfully"> </column>
    </result>
</response>

Copied{"response": {"uri": "/api/EmailAddress/WorkspaceName/TableName",
    "action": "HIDECOLUMN",
    "result": [{"columnName": "Column1",
        "status": "Success",
        "message": "column hidden successfully"}]}}