Remove Multiple Tags From View

Disassociates a list of tags from the specified view, or (when `dissociateAll = true`) removes all tags from the view. The tags are not deleted only the view associated are removed.

REQUEST URI

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

Delete

oauthscopeZohoAnalytics.modeling.delete

QUERY PARAMETERS

 

Parameter Name
Description
CONFIG*JSONObject

Config parameter specifications are available in the below section.

FIELDS FOR CONFIG JSON

KeyDescription
tagIds *JSONArray of long

List of tag ids to be removed from the view. Conditional – Required when dissociateAll is false/absent.

Array size 1 – 1000. Each element must be a tag id that belongs to and is currently associated with the view.the view.
dissociateAllBoolean

When true, all tags currently associated with the view are removed. In this mode tagIds is ignored.
true / false. Default false.

Sample Request:

Copiedcurl https://analyticsapi.zoho.com/restapi/v2/workspaces/<workspace-id>/views/<view-id>/tags --data-urlencode 'CONFIG={"tagIds":[30000000000000,30000000000001]}'
-X 'DELETE'
-H 'ZANALYTICS-ORGID: <org-id>'
-H 'Authorization: Zoho-oauthtoken <access_token>'
Copiedusing System;
using System.Collections.Generic;
using ZohoAnalytics;
using System.Text.Json;

namespace ZohoAnalyticsTest
{
    class Program
    {
        long orgId = 55522777;
        long workspaceId = 10000000000000;
        long viewId = 20000000000000;

        public void RemoveTagsFromView(IAnalyticsClient ac)
        {
            List<long> tagIds = new List<long> { 30000000000000L, 30000000000001L };
            IViewAPI view = ac.GetViewInstance(orgId, workspaceId, viewId);
            view.RemoveTagsFromView(tagIds, false, 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.RemoveTagsFromView(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 = "10000000000000"
    viewId      = "20000000000000"
)


func RemoveTagsFromView(ac ZAnalytics.Client) {
    tagIds := []string{"30000000000000", "30000000000001"}
    view := ZAnalytics.GetViewInstance(&ac, orgId, workspaceId, viewId)
    exception := view.RemoveTagsFromView(tagIds, false, nil)
    if exception != nil {
        fmt.Println("Error:", exception)
        return
    }
    fmt.Println("success")
}

func main() {
    ac := ZAnalytics.GetAnalyticsClient(clientId, clientSecret, refreshToken)
    RemoveTagsFromView(ac)
}
Copiedimport com.zoho.analytics.client.*;
import org.json.*;

public class Test {

    private long orgId = 55522777l;
    private long workspaceId = 10000000000000l;
    private long viewId = 20000000000000l;

    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.removeTagsFromView(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 removeTagsFromView(AnalyticsClient ac) throws Exception {
        JSONArray tagIds = new JSONArray();
        tagIds.put(30000000000000l);
        tagIds.put(30000000000001l);
        ViewAPI view = ac.getViewInstance(orgId, workspaceId, viewId);
        view.removeTagsFromView(tagIds, false, 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 = "10000000000000";
        public $view_id = "20000000000000";

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

        function removeTagsFromView() {
            $tag_ids = array("30000000000000", "30000000000001");
            $view = $this->ac->getViewInstance($this->org_id, $this->workspace_id, $this->view_id);
            $view->removeTagsFromView($tag_ids, false);
            echo "success\n";
        }

    }

    $test_obj = new Test();

    try {
        $test_obj->removeTagsFromView();
    }
    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 = "10000000000000"
    VIEWID = "20000000000000"

class sample:

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

    def remove_tags_from_view(self, ac):
        tag_ids = ["30000000000000", "30000000000001"]
        view = ac.get_view_instance(Config.ORGID, Config.WORKSPACEID, Config.VIEWID)
        view.remove_tags_from_view(tag_ids)
        print("success")

try:
    obj = sample()
    obj.remove_tags_from_view(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 = '10000000000000';
var viewId = '20000000000000';

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

var tagIds = ['30000000000000', '30000000000001'];
var view = ac.getViewInstance(orgId, workspaceId, viewId);
view.removeTagsFromView(tagIds, false).then(() => {
    console.log('success');
}).catch((error) => {
    console.log('errorCode : ' + error.errorCode);
    console.log('errorMessage : ' + error.errorMessage);
});
CopiedorgId = "55522777";
workspaceId = "10000000000000";
viewId = "20000000000000";

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

tagIds = List();
tagIds.add(30000000000000);
tagIds.add(30000000000001);

config = Map();
config.put("tagIds", tagIds);

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

response = invokeurl
[
  url :"https://analyticsapi.zoho.com/restapi/v2/workspaces/" + workspaceId + "/views/" + viewId + "/tags"
  type :DELETE
  parameters:paramsMap
  headers:headersMap
  connection:"analytics_oauth_connection"
];
info response;
Copiedrequire 'zoho_analytics_client'

class Config
  ORGID = "55522777"
  WORKSPACEID = "10000000000000"
  VIEWID = "20000000000000"
end

class Sample
  def initialize
    @ac = AnalyticsClient.new
           .with_data_center("US")
           .with_oauth({
             "clientId" => "1000.xxxxxxx",
             "clientSecret" => "xxxxxxx",
             "refreshToken" => "1000.xxxxxxx.xxxxxxx"
           })
           #.with_token_store_path("/home/admin/analytics_ruby_sdk/tokens") # Optional – specify a directory path to securely store the encrypted access token
           .build
  end

  def remove_tags_from_view
    tag_ids = ["30000000000000", "30000000000001"]
    view = @ac.get_view_instance(Config::ORGID, Config::WORKSPACEID, Config::VIEWID)
    view.remove_tags_from_view(tag_ids, false)
    puts "success"
  end

end

begin
  obj = Sample.new
  obj.remove_tags_from_view
rescue ServerError => e
  puts "Server Error: #{e.response_content}"
rescue StandardError => e
  puts e.message
  puts e.backtrace.join("\n")
end

Download SDKs:  C# | GO | JAVA | PHP | PYTHON | NodeJS | Ruby

Sample value for CONFIG parameter:

CopiedRemoving a specific set of tags from the view:

{
  "tagIds": [
    466206000000061201,
    466206000000061202
  ]
}

//Removing all tags from the view:

{
  "dissociateAll": true
}

Sample Response:

CopiedHTTP/1.1 204 No Content