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

REQUEST URI

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

Post

oauthscope: ZohoAnalytics.modeling.delete

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

COMMON PARAMETERS

ParameterPossible ValuesDescription
ZOHO_ACTIONDELETECOLUMNThis parameter specifies the action to be performed by the API request.
ZOHO_OUTPUT_FORMATXML/JSONThis parameter specifies the output format for the response.
ZOHO_ERROR_FORMATXML/JSONSpecifies the output format for the response in case an error occurs when trying to process the request.
ZOHO_API_VERSION1.0The 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 NameValueDescription
AuthorizationZoho-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

ParameterPossible ValuesDescription
ZOHO_COLUMNNAME
(mandatory)
<columnname>The name of the column to be deleted in Zoho Analytics Table.
Example:ZOHO_COLUMNNAME=Region

POSSIBLE ERROR CODES

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

Sample Request:

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 deleteColumn(IReportClient RepClient)
        {
            string tableURI = RepClient.GetURI(EMAIL, DBNAME, TBNAME);
            string ColumnName = "Column Name";
            bool DeleteDependentView = false;
            bool SkipSystemTableCheck = true;
            RepClient.DeleteColumn(tableURI, ColumnName, DeleteDependentView, SkipSystemTableCheck, null);
        }

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

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

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

func deletecolumn() {
    url := reportclient.GetUri(email, dbname, tbname)
    columnname := "Column Name"
    err := reportclient.DeleteColumn(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)
    deletecolumn()
}
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 deletecolumn() throws Exception {
        String uri = rc.getURI(email, dbname, tbname);
        rc.deleteColumn(uri, "Column Name", config);
    }

    public static void main(String[] args) throws Exception {
        Sample obj = new Sample();
        obj.deletecolumn();
    }
}
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->deleteColumn($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

    def DeleteColumn(self, rc):
        uri = rc.getURI(self.LOGIN_EMAIL_ID, self.DATABASE_NAME, self.TABLE_NAME)
        column_name = "Column Name"
        rc.deleteColumn(uri, column_name)

    obj = Sample()
    obj.DeleteColumn(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.deleteColumn(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", "DELETECOLUMN");
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;

Download SDK : C# | GO | JAVA | PHP | PYTHON | NodeJS

Sample Response:

Copied<responseuri="/api/EmailAddress/WorkspaceName/TableName"action="DELETECOLUMN">
    <result>
        Column deleted successfully
    </result>
</response>
Copied{"response":
    {"uri":"\/api\/email\/WorkspaceName\/TableName",
        "action":"DELETECOLUMN",
        "result": {"message":"Column deleted successfully"}}}