Create Workspace

Create Workspace API allows the user to create a blank workspace on the Zoho Analytics account.

REQUEST URI

https://<ZohoAnalytics_Server_URI>/api/EmailAddress

Post

oauthscope: ZohoAnalytics.modeling.create

COMMON PARAMETERS

Parameter	Possible Values	Description
ZOHO_ACTION	CREATEBLANKDB	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

Parameter Name	Possible Values	Description
ZOHO_DATABASE_NAME (mandatory)	`<workspace_name>`	The Name of the Zoho Analytics Online Reporting workspace which can be taken from workspace URL.
ZOHO_DATABASE_DESC (optional)	`<workspace_description>`	The Description of the workspace(can be null).

POSSIBLE ERROR CODES

7101 , 8504 , 8506 , 8516 , 8533

Sample Request:

Curl Csharp Go Java PHP Python Node JS Deluge

Copiedcurl -d "ZOHO_ACTION=CREATEBLANKDB&ZOHO_OUTPUT_FORMAT=XML&ZOHO_ERROR_FORMAT=XML
    &ZOHO_API_VERSION=1.0&ZOHO_DATABASE_NAME=Workspace_Name
    &ZOHO_DATABASE_DESC=Workspace_Description" 
    -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 CreateDatabase(IReportClient RepClient)
        {
            string uri = RepClient.GetURI(EMAIL);
            RepClient.CreateBlankDB(uri, DBNAME, DBDESC, null);
        }

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

Copiedpackage main

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

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

func createblankdb() {
	url := reportclient.GetUserUri(email)
	new_dbname := "New_Workspace_Name"
	new_dbdesc := "New_Workspace_Description"
	params := map[string]string{}
	params["ZOHO_DATABASE_DESC"] = new_dbdesc
	err := reportclient.CreateBlankDb(url, new_dbname, 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)
	createblankdb()
}

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

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

    public void createDatabase() throws Exception {
        config.put("ZOHO_DATABASE_DESC", dbdesc);
        String uri = rc.getURI(email);
        long result = rc.createDatabase(uri, dbname, config);
        System.out.println(result);
    }

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

Copied<?php
require 'ReportClient.php';
$EMAIL_ID = "Email Address";
$CLIENT_ID = "************";
$CLIENT_SECRET = "************";
$REFRESH_TOKEN = "************";
$NEW_DBNAME = "Workspace Name";
$NEW_DBDESC = "Workspace Description";
$report_client_request = new ReportClient($CLIENT_ID, $CLIENT_SECRET, $REFRESH_TOKEN);
$uri = $report_client_request->getUserURI($EMAIL_ID);
$report_client_request->createBlankDb($uri, $NEW_DBNAME, $NEW_DBDESC);
?>

Copiedfrom __future__ import with_statement
from ReportClient import ReportClient
import sys

class Sample:
    LOGINEMAILID = "Email Address"
    CLIENTID = "************"
    CLIENTSECRET = "************"
    REFRESHTOKEN = "************"
    DATABASENAME = "Workspace Name"
    DATABASEDESC = "Workspace Description"
    rc = None
    rc = ReportClient(REFRESHTOKEN, CLIENTID, CLIENTSECRET)

    def createDatabase(self, rc):
        uri = rc.getUserURI(self.LOGINEMAILID)
        rc.createBlankDb(uri, self.DATABASENAME, self.DATABASEDESC)

    obj = Sample()
    obj.createDatabase(obj.rc)

Copiedvar nodelib = require('./ZAnalyticsClient');
var clientId = '************';
var clientSecret = '************';
var refreshtoken = '************';
var emailId = 'EmailAddress';
var newWorkspaceName = '';

nodelib.initialize(clientId, clientSecret, refreshtoken).then(() => {
    var params = {};
    var uripath = nodelib.getUri(emailId);
    nodelib.createWorkspace(newWorkspaceName, 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", "CREATEBLANKDB");
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;

Sample Response:

XML Json

Copied<responseuri="/api/EmailAddress/WorkspaceName"action="CREATEBLANKDB">
    <result>
        <message>
        Successfully Workspace'Workspace_Name' Created
        </message>
        <dbid>
        99999999999999
        </dbid>
    </result>
</response>

Copied{"response":
    {"uri": "\/api\/email/WorkspaceName",
        "action": "CREATEBLANKDB",
        "result":
        {"message": "Successfully Workspace'Workspace_Name' Created",
            "dbid": "99999999999999"}}}