Delete View

The Delete View API is used to Remove the view which is present in the particular workspace on Zoho Analytics Account.

REQUEST URI

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

Post

oauthscope: ZohoAnalytics.modeling.delete

COMMON PARAMETERS

ParameterPossible ValuesDescription
ZOHO_ACTIONDELETEVIEW    This 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 (DATA FOR THE ROW)

ParameterPossible ValuesDescription
ZOHO_VIEW
(optional)		ViewNameName of the view to be deleted.
ZOHO_DELETE_DEPEND_VIEWS
(optional)		true/false

(In case of deleting a table which has dependent views, this parameter is mandatory and set to be 'true')

true - The views(except dashboards) which created based on the particular view as parent will also get deleted.

false - The dependent views don't get deleted.

POSSIBLE ERROR CODES

7103 , 7138 , 7277 , 8504 , 8506 , 8516 , 8533

Sample Request:

CurlCsharpGoJavaPHPPythonNode JSDeluge
Copiedcurl 
-d "ZOHO_ACTION=DELETEVIEW&ZOHO_OUTPUT_FORMAT=XML&ZOHO_ERROR_FORMAT=XML&ZOHO_API_VERSION=1.0&ZOHO_VIEW=View_Name"  
-H "Authorization:Zoho-oauthtoken <access_token>" 
https://analyticsapi.zoho.com/api/EmailAddress/WorkspaceName
Copiedusing ZReports;

namespace Test
{
    CLIENT_ID = "************";
    CLIENT_SECRET = "************";
    REFRESH_TOKEN = "************";
    EMAIL = "Email Address";
    DBNAME = "Workspace Name";
    VIEWNAME = "View Name";

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

        public void deleteview(IReportClient rc)
        {
            string uri = rc.GetURI(EMAIL, DBNAME);
            Dictionary<string, string> param = new Dictionary<string, string>();
            param.Add("ZOHO_DELETE_DEPEND_VIEWS", "true");
            rc.DeleteView(uri, VIEWNAME, param);
        }

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

Copiedpackage main

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

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

func deleteview() {
	url := reportclient.GetDbUri(email, dbname)
	params := map[string]string{}
	viewname := "View Name"
	err := reportclient.DeleteView(url, viewname, params)
	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)
	deleteview()
}

Copiedimport com.adventnet.zoho.client.report.*;

public class Sample {
    String email = "Email Address";
    String dbname = "Workspace Name";
    String viewname = "View Name";
    String clientId = "************";
    String clientSecret = "************";
    String refreshToken = "************";
    boolean deleteDependentViews = true;
    Map config = new HashMap();
    private ReportClient rc = new ReportClient(clientId, clientSecret, refreshToken);

    public void deleteview() throws Exception {
        String uri = rc.getURI(email, dbname);
        rc.deleteView(uri, viewname, deleteDependentViews, new HashMap());
    }

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

Copied<?php
require 'ReportClient.php';

$EMAIL_ID = "Email Address";
$DB_NAME = "Workspace Name";
$VIEW_NAME = "View Name";
$CLIENT_ID = "************";
$CLIENT_SECRET = "************";
$REFRESH_TOKEN = "************";
$report_client_request = new ReportClient($CLIENT_ID, $CLIENT_SECRET, $REFRESH_TOKEN);
$uri = $report_client_request->getDbURI($EMAIL_ID, $DB_NAME);
$report_client_request->deleteView($uri, $VIEW_NAME);
?>

Copiedfrom __future__ import with_statement
from ReportClient import ReportClient
import sys

class Sample:
    LOGIN_EMAIL_ID = "Email Address"
    DATABASE_NAME = "Workspace Name"
    VIEW_NAME = "View Name"
    CLIENT_ID = "************"
    CLIENT_SECRET = "************"
    REFRESH_TOKEN = "************"
    rc = None
    rc = ReportClient(REFRESH_TOKEN, CLIENT_ID, CLIENT_SECRET)

    def deleteView(self, rc):
        uri = rc.getDBURI(self.LOGIN_EMAIL_ID, self.DATABASE_NAME)
        viewName = "View Name"
        rc.deleteView(uri, viewName)

    obj = Sample()
    obj.deleteView(obj.rc)

Copiedvar nodelib = require('./ZAnalyticsClient');
var clientId = '************';
var clientSecret = '************';
var refreshtoken = '************';
var emailId = 'EmailAddress';
var workspaceName = 'WorkspaceName';
nodelib.initialize(clientId, clientSecret, refreshtoken).then(() => {
    var params = {};
    var uripath = nodelib.getUri(emailId, workspaceName);
    var viewName = '';
    nodelib.deleteView(viewName, 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("");
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:POSTparameters: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", "DELETEVIEW");
paramsMap.put("ZOHO_OUTPUT_FORMAT", "JSON");
paramsMap.put("ZOHO_ERROR_FORMAT", "JSON");
paramsMap.put("ZOHO_API_VERSION", "1.0");
response = invokeurl[url: "https://analyticsapi.zoho.com/api/" + email + "/" + workspaceName
    type: POST parameters: paramsMap headers: headers];
info response;

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

Sample Response:

XMLDeluge
Copied<responseuri="/api/EmailAddress/WorkspaceName"action="DELETEVIEW">
<result>
    <message>View Deleted successfully!</message>
</result>
</response>
Copied{"response":
    {"uri":"\/api\/email\/WorkspaceName",
        "action":"DELETEVIEW",
        "result":
        {"message":"View Deleted successfully!"}}}