Create Slideshow

Create a slideshow in the specified workspace.

REQUEST URI

https://<ZohoAnalytics_Server_URI>/restapi/v2/workspaces/<workspace-id>/slides

Post

oauthscope: ZohoAnalytics.embed.create

QUERY PARAMETERS

 

Parameter Name		Description
CONFIG*JSONObject

Config parameter specifications are available in the below section.

FIELDS FOR CONFIG JSON

KeyDescription
slideName*String

Name of the slideshow.
viewIds*JSONArray

View ids to be included in the slideshow.

Sample: ["viewId1","viewId2"]
accessType

Integer

To mention the access type of the slideshow. Default value - 0.

Allowed values for accessType attribute

0 - Access With Login
1 - Access without login
2 - Sort 

validateSystemTags

Boolean

Applicable only when System Tags are enabled for your organization. Default value - true.

When true, the request is validated against the System Tags applied to the views listed in viewIds.

If any of those views carries a Outdated tag - applied directly, or inherited through lineage from a parent Data Source or Table, the request is rejected and no views are shared. Set to false to skip this validation and proceed with the request.

POSSIBLE ERROR CODES

7103, 7104, 7301, 7387, 7395, 8083, 8518, 8535

Sample Request:

CurlCsharpGoJavaPHPPythonNode JSDelugeRuby
Copiedcurl https://analyticsapi.zoho.com/restapi/v2/workspaces/<workspace-id>/slides?CONFIG=<encoded_json_value> 
-X 'POST' 
-H 'ZANALYTICS-ORGID: <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;

        public void CreateSlideshow(IAnalyticsClient ac)
        {
            string slideName = "Slideshows 1";
            List<long> viewIds = new List<long>();
            viewIds.Add(35730000007354002);
            IWorkspaceAPI workspace = ac.GetWorkspaceInstance(orgId, workspaceId);
            long slideId = workspace.CreateSlideshow(slideName, viewIds, null);
            Console.WriteLine(slideId);
        }

        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.CreateSlideshow(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"
)

func CreateSlideshow(ac ZAnalytics.Client) {
    config := map[string]interface{}{}
    slidename := ""
    viewids := [1]string{}
    viewids[0] = ""
    workspace := ZAnalytics.GetWorkspaceInstance(&ac, orgId, workspaceId)
    result, exception := workspace.CreateSlideshow(slidename, viewids, config)
    if(exception != nil){
        fmt.Println(exception.ErrorMessage)
    }else{
        fmt.Println(result)
    }
}

func main() {

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

}

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

public class Test {

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

    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.createSlideshows(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 createSlideshows(AnalyticsClient ac) throws Exception {
        String slideName = "";
        JSONArray viewIds = new JSONArray();
        viewIds.put("");
        WorkspaceAPI workspace = ac.getWorkspaceInstance(orgId, workspaceId);
        long result = workspace.createSlideshow(slideName, viewIds, null);
        System.out.println(result);
    }
}

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";

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

        function createSlideshow() {
            $slide_name = "Sample 1";
            $view_ids = array("");
            $workspace = $this->ac->getWorkspaceInstance($this->org_id, $this->workspace_id);
            $response =  $workspace->createSlideshow($slide_name, $view_ids);
            print_r($response);
        }
    }

    $test_obj = new Test();

    try {
        $test_obj->createSlideshow();
    }
    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";

class sample:

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

    def create_slideshow(self, ac):
        slide_name = "Slideshow 1"
        view_ids = []
        view_ids.append("35130000001080100")
        view_ids.append("35130000001102015")
        workspace = ac.get_workspace_instance(Config.ORGID, Config.WORKSPACEID)
        result = workspace.create_slideshow(slide_name, view_ids)
        print(result)

try:
    obj = sample()
    obj.create_slideshow(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 ac = new analyticsClient(clientId, clientSecret, refreshtoken);

var slideName = '';
var viewIds = [];
viewIds.push('');
viewIds.push('');

var config = {};
var workspace = ac.getWorkspaceInstance(orgId, workspaceId);
workspace.createSlideshow(slideName, viewIds, config).then((response) => {
    console.log(response);

}).catch((error) => {
    console.log('errorCode : '+error.errorCode);
    console.log('errorMessage : '+error.errorMessage);
});

CopiedorgId = "55522777";
workspaceId = "35130000001055707";

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

slideName = "Slideshow 1";
viewIds = {};
viewIds.add("35130000001354002");
viewIds.add("35130000001355005");
config = Map();
config.put("slideName",slideName);
config.put("viewIds",viewIds);
paramsMap = Map();
paramsMap.put("CONFIG",config.toString());
response = invokeurl
[
  url :"https://analyticsapi.zoho.com/restapi/v2/workspaces/" + workspaceId + "/slides"
  type :POST
  parameters:paramsMap
  headers:headersMap
  connection:"analytics_oauth_connection"
];
info response;

Copiedrequire 'zoho_analytics_client'

class Config
  ORGID = "55522777"
  WORKSPACEID = "35130000001055707"
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 create_slideshow
    slide_name = "Slideshow 1"
    view_ids = []
    view_ids << "35130000001080100"
    view_ids << "35130000001102015"
    workspace = @ac.get_workspace_instance(Config::ORGID, Config::WORKSPACEID)
    result = workspace.create_slideshow(slide_name, view_ids)
    puts result
  end
end

begin
  obj = Sample.new
  obj.create_slideshow
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:

Copied{
  "slideName": "<slide-name>",
  "viewIds": ["<view-id1>", "<view-id2>"]
}

Sample Response:

CopiedHTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8

{
    "status": "success",
    "summary": "Create slideshow",
    "data": {
        "slideId": "1767024000003151001",
        "slideUrl": "https://analyticsapi.zoho.com/ZDBSlideshow.cc?SLIDEID=1767024000003151001&SLIDEKEY=69ba2ec9bfbe548f494bdf798087db41&AUTOPLAY=true&INTERVAL=25&INCLUDETITLE=true&INCLUDEDESC=true&SOCIALWIDGETS=false"
    }
}