Delete Workspace

The delete workspace API is used to delete the workspace from your Zoho Analytics Account. This API will delete the workspace present in the user account who is invoking this API, and not the workspace from other accounts. Please note that if a workspace is deleted using this API, the same workspace cannot be restored back.

REQUEST URI

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

Post

oauthscope: ZohoAnalytics.modeling.delete

COMMON PARAMETERS

ParameterPossible ValuesDescription
ZOHO_ACTIONDELETEDATABASEThis 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_DATABASE_NAME
(mandatory)        
Workspace nameThis parameter holds the name of the workspace to be deleted.

POSSIBLE ERROR CODES

7103 , 7138 , 7165 ,  8504 , 8506 , 8516 , 8533

Sample Request:

Copiedcurl -d "ZOHO_ACTION=DELETEDATABASE&ZOHO_OUTPUT_FORMAT=XML&ZOHO_ERROR_FORMAT=XML
         &ZOHO_API_VERSION=1.0
         &ZOHO_DATABASE_NAME=Workspace Name"
     -H "Authorization:Zoho-oauthtoken <access_token>"
     https://analyticsapi.zoho.com/api/EmailAddress
Copiedusing ZReports;

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

        public void DeleteDatabase(IReportClient RepClient)
        {
            string userURI = RepClient.GetURI(EMAIL);
            string databaseName = "Workspace Name";
            RepClient.DeleteDatabase(userURI, databaseName, null);
        }

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

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

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

func deletedatabase() {
	url := reportclient.GetUserUri(email)
	dbname := "Workspace Name"
	err := reportclient.DeleteDatabase(url, dbname)
	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)
	deletedatabase()
}
Copiedimport com.adventnet.zoho.client.report.*;

public class Sample {
    String email = "Email Address";
    String clientId = "************";
    String clientSecret = "************";
    String refreshToken = "************";
    Map config = new HashMap();
    private ReportClient rc = new ReportClient(clientId, clientSecret, refreshToken);

    public void deletedatabase() throws Exception {
        String uri = rc.getURI(email);
        rc.deleteDatabase(uri, "database", config);
    }

    public static void main(String[] args) throws Exception {
        Sample obj = new Sample();
        obj.deletedatabase();
    }
}
Copied<?php
require 'ReportClient.php';
$EMAIL_ID = "Email Address";
$CLIENT_ID = "************";
$CLIENT_SECRET = "************";
$REFRESH_TOKEN = "************";
$report_client_request = new ReportClient($CLIENT_ID, $CLIENT_SECRET, $REFRESH_TOKEN);
$uri = $report_client_request->getUserURI($EMAIL_ID);
$db_name = "Workspace Name";
$report_client_request->deleteDatabase($uri, $db_name);
?>
Copiedfrom __future__ import with_statement
from ReportClient import ReportClient
import sys

class Sample:
    LOGINEMAILID = "Email Address"
    CLIENTID = "************"
    CLIENTSECRET = "************"
    REFRESHTOKEN = "************"
    rc = None
    rc = ReportClient(REFRESHTOKEN, CLIENTID, CLIENTSECRET)

    def DeleteDatabase(self, rc):
        uri = rc.getUserURI(self.LOGINEMAILID)
        databaseName = "WorkspaceName"
        rc.deleteDatabase(uri, databaseName)

    obj = Sample()
    obj.DeleteDatabase(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);
    nodelib.deleteWorkspace(workspaceName, 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("");
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", "DELETEDATABASE");
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_DATABASE_NAME", "");
response = invokeurl[url: "https://analyticsapi.zoho.com/api/" + email type: POST parameters: paramsMap headers: headers];
info response;

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

Sample Response:

Copied<responseuri="/api/EmailAddress"action="DELETEDATABASE">
    <result>
        <message>
        Workspace deleted successfully
        </message>
    </result>
</response>
Copied{"response":
    {"uri": "\/api\/email",
        "action": "DELETEDATABASE",
        "result":
        {"message": "Workspace deleted successfully"}}}