Rename View

The Rename view API is used to Rename the specified view with the new name and description.

REQUEST URI

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

Post

oauthscope: ZohoAnalytics.modeling.update

COMMON PARAMETERS

Parameter	Possible Values	Description
ZOHO_ACTION	RENAMEVIEW	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_VIEWNAME (mandatory)	View name	Current name of the view
ZOHO_NEW_VIEWNAME (mandatory)	New view name	New name for the view
ZOHO_NEW_VIEWDESC (optional)	View description	New description for the view

POSSIBLE ERROR CODES

7103 , 7105 , 7111 , 7138 , 8504 , 8506 , 8516 , 8533

Sample Request:

Curl Csharp Go Java PHP Python Node JS Deluge

Copiedcurl 
-d "ZOHO_ACTION=RENAMEVIEW&ZOHO_OUTPUT_FORMAT=XML&ZOHO_ERROR_FORMAT=XML&ZOHO_API_VERSION=1.0&ZOHO_VIEWNAME=Old Name&ZOHO_NEW_VIEWNAME=New Name&ZOHO_NEW_VIEWDESC=Description" 
-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";

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

        public void renameview(IReportClient rc)
        {
            string uri = rc.GetURI(EMAIL, DBNAME);
            string viewname = "Old Name";
            string newviewname = "New Name";
            string viewdesc = "Description";
            rc.RenameView(uri, viewname, newviewname, viewdesc, null);
        }

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

Copiedpackage main

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

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

func renameview() {
	url := reportclient.GetDbUri(email, dbname)
	viewname := "Old Name"
	newname := "New Name"
	newdesc := "Description"
	err := reportclient.RenameView(url, viewname, newname, newdesc)
	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)
	renameview()
}

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

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

    public void renameview() throws Exception {
        String uri = rc.getURI(email, dbname);
        rc.renameView(uri, "Old Name", "New Name", "Description", config);
    }

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

Copied<?php
require 'ReportClient.php';

$EMAIL_ID = "Email Address";
$DB_NAME = "Workspace 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);
$view_name = "Old Name";
$new_view_name = "New Name";
$new_view_desc = "Description";
$report_client_request->renameView($uri, $view_name, $new_view_name, $new_view_desc);
?>

Copiedfrom __future__ import with_statement
from ReportClient import ReportClient
import sys

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

    def renameview(self, rc):
        uri = rc.getDBURI(self.LOGIN_EMAIL_ID, self.DATABASE_NAME)
        rc.renameView(uri, "Old Name", "New Name", "Description")

    obj = Sample()
    obj.renameview(obj.rc)

Copiedvar nodelib = require('./ZAnalyticsClient');
var clientId = '************';
var clientSecret = '************';
var refreshtoken = '************';
var emailId = 'EmailAddress';
var workspaceName = 'WorkspaceName';
var oldViewName = "OldViewName";
var newViewName = "NewViewName";
nodelib.initialize(clientId, clientSecret, refreshtoken).then(() => {
    var params = {};
    var uripath = nodelib.getUri(emailId, workspaceName);
    nodelib.renameView(oldViewName, newViewName, 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", "RENAMEVIEW");
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_VIEWNAME", "");
paramsMap.put("ZOHO_NEW_VIEWNAME", "");

response = invokeurl[url: "https://analyticsapi.zoho.com/api/" + email + "/" + workspaceName
    type: POST parameters: paramsMap headers: headers];
info response;

Sample Response:

XML Json

Copied<?xml version="1.0"encoding="UTF-8" ?>
<responseuri="/api/EmailAddress/WorkspaceName"action="RENAMEVIEW">
    <result>
        <message>View renamed successfully!</message>
    </result>
</response>

Copied{"response":
    {"uri":"\/api\/email\/WorkspaceName",
        "action":"RENAMEVIEW",
        "result":
        {"message":"View renamed successfully!"}}}