Update Slide Show

This API updates the slideshow details present in the workspace identified by the URI.

REQUEST URI

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

Post

oauthscope: ZohoAnalytics.embed.update

COMMON PARAMETERS

Parameter	Possible Values	Description
ZOHO_ACTION	UPDATESLIDESHOW	This parameter specifies the action to be performed by the API request. Note: Value of ZOHO_ACTION parameter should be in the same case(UPPER CASE) as given in this document.
ZOHO_OUTPUT_FORMAT	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	Type	Description
slideName^*	String	Name of the slideshow to be updated.
newSlideName	String	New name for the slideshow.
viewNames	JSONArray	List of view names to be included in the slideshow. Note: Existing views mapped for the slideshows will be replaced by the given views.
accessWithoutLogin	Boolean	If set as `true`, anyone with the slideshow url can access the slideshow. If set as `false`, only the users having read access for the views present in the slideshow can access.
regenerateSlideKey	Boolean	If set as `true` existing slideshow url will be expired.

Note: Fields with * are mandatory.

POSSIBLE ERROR CODES

7103 , 7138 , 8504 , 8506 , 8516 , 8533

Sample Request:

Curl Csharp Go Java PHP Python Node JS Deluge

Copiedcurl 
-d 'ZOHO_ACTION=UPDATESLIDESHOW&ZOHO_OUTPUT_FORMAT=JSON&ZOHO_ERROR_FORMAT=JSON&ZOHO_API_VERSION=1.0' 

--data-urlencode 'CONFIG={"slideName":"","newSlideName":["","","viewNames":"","accessWithoutLogin":"","regenerateSlideKey":""}' 

-X POST 
-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 updateSlideShow(IReportClient rc)
        {
            string uri = rc.GetURI(EMAIL, DBNAME);
            Dictionary<string, object> config = new Dictionary<string, object>();
            config.Add("slideName", "");
            List<string> viewNames = new List<string>();
            viewNames.Add("");
            viewNames.Add("");
            config.Add("viewNames", viewNames);
            config.Add("newSlideName", "");
            config.Add("accessWithoutLogin", "");
            config.Add("regenerateSlideKey", "");
            rc.UpdateSlideShow(uri, config);
        }

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

Copiedpackage main

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

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

func updateslideshow() {
	type slideconfig struct {
		SLIDENAME          string `json:"slideName"`
		NEWSLIDENAME       string `json:"newSlideName,omitempty"`
		VIEWNAMES          []string `json:"viewNames,omitempty"`
		ACCESSWITHOUTLOGIN bool `json:"accessWithoutLogin,omitempty"`
		REGENSLIDEKEY      bool `json:"regenerateSlideKey,omitempty"`
	}

	config := slideconfig{
		SLIDENAME:          "",
		NEWSLIDENAME:       "",
		VIEWNAMES:          []string{"", ""},
		ACCESSWITHOUTLOGIN: false,
		REGENSLIDEKEY:      false,
	}

	url := reportclient.GetDbUri(email, dbname)
	conf, _ := json.Marshal(config)
	err := reportclient.UpdateSlideShow(url, string(conf))

	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)
	updateslideshow()
}

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 updateSlideShow() throws Exception {
        String uri = rc.getURI(email, dbname);
        JSONArray viewNames = new JSONArray();
        viewNames.put("");
        viewNames.put("");
        JSONObject slideInfo = new JSONObject();
        slideInfo.put("slideName", "");
        slideInfo.put("newSlideName", "");
        slideInfo.put("viewNames", viewNames);
        slideInfo.put("accessWithoutLogin", "");
        slideInfo.put("regenerateSlideKey", "");
        rc.updateSlideShow(uri, slideInfo);
    }

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

Copied<?php
require 'ReportClient.php';
$EMAIL_ID = "Email Address";
$WORKSPACE_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, $WORKSPACE_NAME);
$slideInfo = new stdClass();
$slideInfo->slideName = "";
$slideInfo->newSlideName = "";
$slideInfo->viewNames = array();
$slideInfo->accessWithoutLogin = "";
$slideInfo->regenerateSlideKey = "";
$report_client_request->updateSlideShow($uri, $slideInfo);
echo "success\n";
?>

Copiedfrom __future__ import with_statement
from ReportClient import ReportClient
import sys

class Sample:
    LOGINEMAILID = "Email Address"
    WORKSPACENAME = "Workspace Name"
    CLIENTID = "************"
    CLIENTSECRET = "************"
    REFRESHTOKEN = "************"
    rc = None

    def updateslideshow(self, rc):
        uri = rc.getDBURI(self.LOGINEMAILID, self.WORKSPACENAME)
        try:
            slideInfo = {}
            slideInfo['slideName'] = ''
            slideInfo['newSlideName'] = ''
            slideInfo['viewNames'] = ['', '']
            slideInfo['accessWithoutLogin'] = ''
            slideInfo['regenerateSlideKey'] = ''
            rc.updateSlideShow(uri, slideInfo)
        except Exception, e:
            print str(e)

    obj = Sample()
    obj.updateslideshow(obj.rc)

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

nodelib.initialize(clientId, clientSecret, refreshtoken).then(() => {
    var uripath = nodelib.getUri(emailId, workspaceName);
    var config = {};
    config.slideName = "";
    config.newSlideName = "";
    config.viewNames = ["", ""];
    config.accessWithoutLogin = "";
    config.regenerateSlideKey = "";

    nodelib.updateSlideShow(uripath, config).then((response) => {
        console.log(response);
    }).catch((error) => {
        console.log("Error : " + error.message);
    });
}).catch((error) => {
    console.log("Authentication Issue : " + 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: 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", "UPDATESLIDESHOW");
paramsMap.put("ZOHO_OUTPUT_FORMAT", "JSON");
paramsMap.put("ZOHO_ERROR_FORMAT", "JSON");
paramsMap.put("ZOHO_API_VERSION", "1.0");

// ACTION SPECIFIC PARAMS
config = Map();
viewNames = List();
viewNames.add("");
viewNames.add("");
config.put("slideName", "");
config.put("newSlideName", "");
config.put("viewNames", viewNames);
config.put("accessWithoutLogin", "");
config.put("regenerateSlideKey", "");
paramsMap.put("CONFIG", config.toString());

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

Sample Response:

Copied{"response": {"uri": "/api/EmailAddress/WorkspaceName",
    "action": "UPDATESLIDESHOW",
    "result": {"message": "Slideshow updated successfully."}}}