Add Column

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

REQUEST URI

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

Post

oauthscope: ZohoAnalytics.modeling.create

COMMON PARAMETERS

ParameterPossible ValuesDescription
ZOHO_ACTIONADDCOLUMNThis 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

Parameter NamePossible ValuesDescription
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_DATATYPE
(mandatory)

Supported data types are:

  • PLAIN
  • MULTI_LINE
  • EMAIL
  • NUMBER
  • POSITIVE_NUMBER
  • DECIMAL_NUMBER
  • CURRENCY
  • PERCENT
  • DATE
  • BOOLEAN
  • URL
  • AUTO_NUMBER
The datatype of the column to be added into Zoho Analytics Table.

POSSIBLE ERROR CODES

7103 , 7128 , 7138 , 7161 , 8504 , 8506 , 8516 , 8533

Sample Request:

Copiedcurl -d "ZOHO_ACTION=ADDCOLUMN&ZOHO_OUTPUT_FORMAT=XML&ZOHO_ERROR_FORMAT=XML
         &ZOHO_API_VERSION=1.0
         &ZOHO_COLUMNNAME=Column Name&ZOHO_DATATYPE=Column Data Type"
     -H "Authorization:Zoho-oauthtoken <access_token>"
     https://analyticsapi.zoho.com/api/EmailAddress/WorkspaceName/TableName
Copiedusing ZReports;

namespace Test
{
    class Program
    {
        public IReportClient GetClient()
        {
            IReportClient RepClient = new ReportClient(CLIENT_ID, CLIENT_SECRET, REFRESH_TOKEN);
            return RepClient;
        }

        public void AddColumn(IReportClient RepClient)
        {
            string tableURI = RepClient.GetURI(EMAIL, DBNAME, TBNAME);
            string ColumnName = "Column Name";
            string DataType = "PLAIN";
            bool HideColumn = false;
            bool SkipSystemTableCheck = true;
            RepClient.AddColumn(tableURI, ColumnName, DataType, HideColumn, SkipSystemTableCheck, null);
        }

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

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

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

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

    public static void main(String[] args) throws Exception {
        Sample obj = new Sample();
        obj.addColumn();
    }
}
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";
$data_type = "PLAIN";
$report_client_request->addColumn($uri, $column_name, $data_type);
?>
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 AddColumn(self, rc):
        uri = rc.getURI(self.LOGINEMAILID, self.DATABASENAME, self.TABLENAME)
        columnName = "Column Name"
        dataType = "PLAIN"
        rc.addColumn(uri, columnName, dataType)

    obj = Sample()
    obj.AddColumn(obj.rc)
Copiedvar nodelib = require('./ZAnalyticsClient');
var clientId = '************';
var clientSecret = '************';
var refreshtoken = '************';
var emailId = 'EmailAddress';
var workspaceName = 'WorkspaceName';
var viewName = 'ViewName';
var columnName = 'ColumnName';
var columnType = 'PLAIN';
nodelib.initialize(clientId, clientSecret, refreshtoken).then(() => {
    var params = {};
    var uripath = nodelib.getUri(emailId, workspaceName, viewName);
    nodelib.addColumn(columnName, columnType, 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", "ADDCOLUMN");
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_DATATYPE", "");
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="ADDCOLUMN">
    <result>
        Column created successfully
    </result>
</response>
Copied{"response":
    {"uri":"\/api\/email\/WorkspaceName\/TableName",
        "action":"ADDCOLUMN",
        "result": {"message":"Column created successfully"}}}