Copy Formulas

Copy the specified formulas from one table to another across workspaces.

Note:

  • For ZANALYTICS-ORGID header, provide the source organization id as the value.
  • As of now copying formulas within the same workspace is not possible.

REQUEST URI

https://<ZohoAnalytics_Server_URI>/restapi/v2/workspaces/<workspace-id>/views/<view-id>/formulas/copy

Post

oauthscope: ZohoAnalytics.modeling.create

QUERY PARAMETERS

 

Parameter Name		Description
CONFIG*JSONObject

Config parameter specifications are available in the below section.

FIELDS FOR CONFIG JSON

KeyDescription
formulaColumnNames*JSONArray

The name of the formula columns to be copied.

Sample: ["column1","column2"]
destWorkspaceId*

Long

The destination workspace id.

workspaceKeyString

The secret key used for allowing the user to copy the formulas from one organization to another organization.

REQUEST HEADERS (ACTION SPECIFIC)

NameValueDescription
ZANALYTICS-DEST-ORGID<destination-org-id>Id of the organization where the destination workspace is present.

POSSIBLE ERROR CODES

7103 , 7138 , 8504 , 8506 , 8516 , 15002 , 15007 , 15009 , 15010

Sample Request:

CurlCsharpGoJavaPHPPythonNode JSDeluge
Copiedcurl https://analyticsapi.zoho.com/restapi/v2/workspaces/<source-workspace-id>/views/<source-view-id>/formulas/copy?CONFIG=<encoded_json_value> 
-X 'POST' 
-H 'ZANALYTICS-ORGID: <source-org-id>' 
-H 'Authorization: Zoho-oauthtoken <access_token>'
Copiedusing System;
using System.Collections.Generic;
using ZohoAnalytics;

namespace ZohoAnalyticsTest
{
    class Program
    {
        long orgId = 55522777;
        long workspaceId = 35130000001055707;
        long viewId = 35730000007354002;

        public void CopyFormulas(IAnalyticsClient ac)
        {
            List<string> formulaNames = new List<string>();
            formulaNames.Add("F1");
            long destWorkspaceId = 1148746000002556007;
            IViewAPI view = ac.GetViewInstance(orgId, workspaceId, viewId);
            view.CopyFormulas(formulaNames, destWorkspaceId, null, null);
            Console.WriteLine("success");
        }

        static void Main(string[] args)
        {
            string clientId = "1000.xxxxxxx";
            string clientSecret = "xxxxxxx";
            string refreshToken = "1000.xxxxxxx.xxxxxxx";

            try
            {
                IAnalyticsClient ac = new AnalyticsClient(clientId, clientSecret, refreshToken);
                Program obj = new Program();
                obj.CopyFormulas(ac);
            }
            catch (ServerException ex)
            {
                Console.WriteLine("Server exception - " + ex.GetErrorMessage());
            }
            catch (Exception ex)
            {
                Console.WriteLine("Other exception - " + ex.Message);
            }
        }
    }
}

Copiedpackage main

import (
    "fmt"
    ZAnalytics "zoho/pkg/analyticsclient"
)

var(
    clientId = "1000.xxxxxxx"
    clientSecret = "xxxxxxx"
    refreshToken = "1000.xxxxxxx.xxxxxxx"

    orgId = "55522777"
    workspaceId = "35130000001055707"
    viewId = "35730000007354002"
)

func CopyFormulas(ac ZAnalytics.Client) {
    config := map[string]interface{}{}
    destworkspaceid := ""
    destorgid := ""
    formulanames := [2]string{}
    formulanames[0] = "F1"
    formulanames[1] = "F2"
    view := ZAnalytics.GetViewInstance(&ac, orgId, workspaceId, viewId)
    exception := view.CopyFormulas(formulanames, destworkspaceid, config, destorgid)
    if(exception != nil){
        fmt.Println(exception.ErrorMessage)
    }else{
        fmt.Println("success")
    }
}

func main() {

    ac := ZAnalytics.GetAnalyticsClient(clientId, clientSecret, refreshToken)
    CopyFormulas(ac)

}

Copiedimport com.zoho.analytics.client.*;
import org.json.*;

public class Test {

    private long orgId = 55522777l;
    private long workspaceId = 35130000001055707l;
    private long viewId = 35730000007354002l;

    public static void main(String args[]){

        String clientId = "1000.xxxxxxx";
        String clientSecret = "xxxxxxx";
        String refreshToken = "1000.xxxxxxx.xxxxxxx";

        Test tObj = new Test();
        AnalyticsClient ac = new AnalyticsClient(clientId, clientSecret, refreshToken);

        try {
            tObj.copyFormulas(ac);
        }
        catch (ServerException ex) {
            System.out.println("Server exception - ErrorCode : " + ex.getErrorCode() + ", ErrorMessage : "  + ex.getErrorMessage());
        }
        catch (ParseException ex) {
            System.out.println("Parser exception - ErrorMessage : "  + ex.getResponseMessage());
        }
        catch (Exception ex) {
            System.out.println("Other exception - ");
            ex.printStackTrace();
        }
    }

    public void copyFormulas(AnalyticsClient ac) throws Exception {
        JSONArray formulaNames = new JSONArray();
        long destWorkspaceId = 35130000001055707l;
        ViewAPI view = ac.getViewInstance(orgId, workspaceId, viewId);
        view.copyFormulas(formulaNames, destWorkspaceId, null, null);
        System.out.println("success");
    }
}

Copied<?php

    require 'AnalyticsClient.php';

    class Test
    {
        public $ac = NULL;
        public $client_id = "1000.xxxxxxx";
        public $client_secret = "xxxxxxx";
        public $refresh_token = "1000.xxxxxxx.xxxxxxx";

        public $org_id = "55522777";
        public $workspace_id = "35130000001055707";
        public $view_id = "35730000007354002";

        function __construct() {
            $this->ac =  new AnalyticsClient($this->client_id, $this->client_secret, $this->refresh_token);
        }

        function copyFormulas() {
            $dest_workspace_id = "1148746000002449089";
            $formula_names = array("F1", "F2");
            $view = $this->ac->getViewInstance($this->org_id, $this->workspace_id, $this->view_id);
            $view->copyFormulas($formula_names, $dest_workspace_id);
            echo "success\n";
        }
    }

    $test_obj = new Test();

    try {
        $test_obj->copyFormulas();
    }
    catch(ServerException $se) {
        echo "Server exception : " . $se->getErrorMessage() . "\n";
    }
    catch(IOException $ioe) {
        echo "IO exception : " . $ioe->getErrorMessage() . "\n";
    }
    catch(ParseException $pe) {
        echo "Parser exception : " . $pe->getErrorMessage() . "\n";
    }
    catch(Exception $e) {
        echo "Exception : " . $e->getErrorMessage() . "\n";
    }
?>

Copiedfrom __future__ import with_statement
from AnalyticsClient import AnalyticsClient
import sys
import json

class Config:

    CLIENTID = "1000.xxxxxxx";
    CLIENTSECRET = "xxxxxxx";
    REFRESHTOKEN = "1000.xxxxxxx.xxxxxxx";

    ORGID = "55522777";
    WORKSPACEID = "35130000001055707";
    VIEWID = "35730000007354002";

class sample:

    ac = AnalyticsClient(Config.CLIENTID, Config.CLIENTSECRET, Config.REFRESHTOKEN)

    def copy_formulas(self, ac):
        formula_names = []
        formula_names.append("F1")
        dest_workspace_id = "1148746000002575005"
        view = ac.get_view_instance(Config.ORGID, Config.WORKSPACEID, Config.VIEWID)
        view.copy_formulas(formula_names, dest_workspace_id)
        print("success")

try:
    obj = sample()
    obj.copy_formulas(obj.ac);

except Exception as e:
    print(str(e))

Copiedvar analyticsClient = require('./AnalyticsClient');

var clientId = '1000.xxxxxxx';
var clientSecret = 'xxxxxxx';
var refreshtoken = '1000.xxxxxxx.xxxxxxx';
var orgId = '55522777';
var workspaceId = '35130000001055707';
var viewId = '35730000007354002';
var destWorkspaceId = '';

var ac = new analyticsClient(clientId, clientSecret, refreshtoken);

var formulaNames = [];
formulaNames.push('');
formulaNames.push('');

var config = {};
var view = ac.getViewInstance(orgId, workspaceId, viewId);
view.copyFormulas(formulaNames, destWorkspaceId, config).catch((error) => {
    console.log('errorCode : '+error.errorCode);
    console.log('errorMessage : '+error.errorMessage);
});

CopiedorgId = "55522777";
workspaceId = "35130000001055707";
viewId="35730000007354002";

headersMap = Map();
headersMap.put("ZANALYTICS-ORGID",orgId);

formulaNames = {};
formulaNames.add("Add_Cost");
destWorkspaceId = "35130000001677807";

config = Map();
config.put("formulaColumnNames",formulaNames);
config.put("destWorkspaceId",destWorkspaceId);

paramsMap = Map();
paramsMap.put("CONFIG",config.toString());

response = invokeurl
[
  url :"https://analyticsapi.zoho.com/restapi/v2/workspaces/" + workspaceId + "/views/" + viewId +"/formulas/copy"
  type :POST
  parameters: paramsMap
  headers:headersMap
  connection:"analytics_oauth_connection"
];

Download client libraries:  C# | GO | JAVA | PHP | PYTHON | NodeJS

Sample value for CONFIG parameter:

Copied{
  "formulaColumnNames": ["<column-name1>", "<column-name2>"],
  "destWorkspaceId": "<workspace-id>"
}

Sample Response:

CopiedHTTP/1.1 204 No Content