Save As
The Save As API is used to copy a view within the workspace which is present in the Zoho Analytics Account.
REQUEST URI
https://<ZohoAnalytics_Server_URI>/api/<OwnerEmail>/<WorkspaceName>
Post
oauthscope: ZohoAnalytics.modeling.create
COMMON PARAMETERS
| Parameter | Possible Values | Description |
|---|---|---|
| ZOHO_ACTION | SAVEAS | 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_VIEWTOCOPY (mandatory) | <existing_view_name> | This parameter holds the name of the view which has to be copied. |
| ZOHO_NEW_VIEWNAME (mandatory) | <new_view_name> | This parameter holds the name of the view which has to be created. |
| ZOHO_FOLDERNAME (optional) | <folder_name> | The name of folder where the created view to be placed. |
| ZOHO_DESCRIPTION (optional) | <description> | Description to the new view. |
| ZOHO_COPYDATA (optional) | true/false | true - The data present in view will be copied. false - Only the structure of view will be copied. |
| ZOHO_COPYLOOKUP (optional) | true/false | true - The lookup details present in view will be copied. false - The lookup details won't get copied. |
| ZOHO_HUGEDATACOPY (optional) | true/false | true - Use when a table have more than two hundred thousand rows. false - Use when a table have less than two hundred thousand rows. |
POSSIBLE ERROR CODES
7103 , 7105 , 7111 , 7144 , 8504 , 8506 , 8516 , 8533 , 15018
Sample Request:
Copiedcurl
-d "ZOHO_ACTION=SAVEAS&ZOHO_OUTPUT_FORMAT=XML&ZOHO_ERROR_FORMAT=XML&ZOHO_API_VERSION=1.0&ZOHO_VIEWTOCOPY=Existing_View_Name&ZOHO_NEW_VIEWNAME=New_View_Name"
-H "Authorization:Zoho-oauthtoken <access_token>"
https://analyticsapi.zoho.com/api/EmailAddress/WorkspaceNameCopiedusing ZReports;
namespace Test
{
CLIENT_ID = "************";
CLIENT_SECRET = "************";
REFRESH_TOKEN = "************";
EMAIL = "Email Address";
DBNAME = "Workspace Name";
VIEW_TOCOPY = "Existing View Name";
NEW_VIEWNAME = "New View Name";
class Program
{
public IReportClient getClient()
{
IReportClient RepClient = new ReportClient(CLIENT_ID, CLIENT_SECRET, REFRESH_TOKEN);
return RepClient;
}
public void saveas(IReportClient rc)
{
string uri = rc.GetURI(EMAIL, DBNAME);
Dictionary<string, string> param = new Dictionary<string, string>();
rc.SaveAs(uri, VIEW_TOCOPY, NEW_VIEWNAME, param);
}
static void Main(string[] args)
{
Program obj = new Program();
IReportClient rc = obj.getClient();
obj.saveas(rc);
}
}
}
Copiedpackage main
import (
"fmt"
"zoho/pkg/reportclient"
)
var (
email = "Email Address"
dbname = "Workspace Name"
clientid = "************"
clientsecret = "************"
refreshtoken = "************"
)
func saveas() {
url := reportclient.GetDbUri(email, dbname)
viewtocopy := "Existing View Name"
newviewname := "New View Name"
params := map[string]string{}
result, err := reportclient.SaveAsViews(url, viewtocopy, newviewname, params)
if err != nil {
fmt.Println(err.ErrorMessage)
fmt.Println(err.ErrorCode)
fmt.Println(err.Action)
fmt.Println(err.HttpStatusCode)
} else {
fmt.Println(result)
}
}
func main() {
reportclient.SetOAuthToken(clientid, clientsecret, refreshtoken)
saveas()
}
Copiedimport com.adventnet.zoho.client.report.*;
public class Sample {
String email = "Email Address";
String dbname = "Workspace Name";
String view_tocopy = "Existing View Name";
String new_viewname = "New View Name";
String clientId = "************";
String clientSecret = "************";
String refreshToken = "************";
Map config = new HashMap();
private ReportClient rc = new ReportClient(clientId, clientSecret, refreshToken);
public void saveas() throws Exception {
String uri = rc.getURI(email, dbname);
HashMap map = new HashMap();
rc.saveAsViews(uri, view_tocopy, new_viewname, map);
}
public static void main(String[] args) throws Exception {
Sample obj = new Sample();
obj.saveas();
}
}
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);
$viewto_copy = "Existing View Name";
$new_viewname = "New View Name";
$config = array();
$report_client_request->saveAs($uri, $viewto_copy, $new_viewname, $config);
?>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"
rc = None
rc = ReportClient(REFRESH_TOKEN, CLIENT_ID, CLIENT_SECRET)
def saveAs(self, rc):
uri = rc.getDBURI(self.LOGIN_EMAIL_ID, self.DATABASE_NAME)
viewToCopy = "Existing View Name"
newViewName = "New View Name"
config = {}
result = rc.saveAs(uri, viewToCopy, newViewName, config)
print(result)
obj = Sample()
obj.saveAs(obj.rc)
Copiedvar nodelib = require('./ZAnalyticsClient');
var clientId = '************';
var clientSecret = '************';
var refreshtoken = '************';
var emailId = 'EmailAddress';
var workspaceName = 'WorkspaceName';
var viewToCopy = '';
var newViewName = '';
nodelib.initialize(clientId, clientSecret, refreshtoken).then(() => {
var params = {};
var uripath = nodelib.getUri(emailId, workspaceName);
nodelib.saveAs(viewToCopy, 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", "SAVEAS");
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_VIEWTOCOPY", "");
paramsMap.put("ZOHO_NEW_VIEWNAME", "");
response = invokeurl[url: "https://analyticsapi.zoho.com/api/" + email + "/" + workspaceName
type: POST parameters: paramsMap headers: headers];
info response;