Get Share Info
The Get Share Info API is used to fetch all the Sharing information of a Workspace. Only the Administrator of the Workspace (one who created the Workspace) can use this API.
REQUEST URI
https://<ZohoAnalytics_Server_URI>/api/<OwnerEmail>/<WorkspaceName>
Get
oauthscope: ZohoAnalytics.share.read
COMMON PARAMETERS
| Parameter | Possible Values | Description |
|---|---|---|
| ZOHO_ACTION | GETSHAREINFO | 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 | 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. |
POSSIBLE ERROR CODES
Sample Request:
Copiedcurl
-d "ZOHO_ACTION=GETSHAREINFO&ZOHO_OUTPUT_FORMAT=XML&ZOHO_ERROR_FORMAT=XML&ZOHO_API_VERSION=1.0"
-H "Authorization:Zoho-oauthtoken <access_token>"
https://analyticsapi.zoho.com/api/EmailAddress/WorkspaceNameCopiedusing 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 getshareinfo(IReportClient rc)
{
string uri = rc.GetURI(EMAIL, DBNAME);
var result = rc.GetShareInfo(uri, null);
var list = result.GetGroupMembers();
}
static void Main(string[] args)
{
Program obj = new Program();
IReportClient rc = obj.getClient();
obj.getshareinfo(rc);
}
}
}
Copiedpackage main
import (
"fmt"
"zoho/pkg/reportclient"
)
var (
email = "Email Address"
dbname = "Workspace Name"
clientid = "************"
clientsecret = "************"
refreshtoken = "************"
)
func getshareinfo() {
url := reportclient.GetDbUri(email, dbname)
shareinfo, err := reportclient.GetShareInfo(url)
if err != nil {
fmt.Println(err.ErrorMessage)
fmt.Println(err.ErrorCode)
fmt.Println(err.Action)
fmt.Println(err.HttpStatusCode)
} else {
fmt.Println(shareinfo.GroupMembers)
fmt.Println(shareinfo.UserInfo)
}
}
func main() {
reportclient.SetOAuthToken(clientid, clientsecret, refreshtoken)
getshareinfo()
}
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 shareinfo() throws Exception {
String uri = rc.getURI(email, dbname);
Object shareinfoobj = rc.getShareInfo(uri, config);
}
public static void main(String[] args) throws Exception {
Sample obj = new Sample();
obj.shareinfo();
}
}
Copied<?php
require 'ReportClient.php';
$EMAIL_ID = "Email Address";
$DB_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, $DB_NAME);
$report_client_response = $report_client_request->getShareInfo($uri);
?>
Copiedfrom __future__ import with_statement
from ReportClient import ReportClient
import sys
class Sample:
LOGIN_EMAIL_ID = "Email Address"
CLIENT_ID = "************"
CLIENT_SECRET = "************"
REFRESH_TOKEN = "************"
DATABASE_NAME = "Workspace Name"
rc = None
def getshareinfo(self, rc):
uri = rc.getDBURI(self.LOGIN_EMAIL_ID, self.DATABASE_NAME)
result = rc.getShareInfo(uri)
print(result.sharedUsers)
obj = Sample()
obj.getshareinfo(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 params = {};
var uripath = nodelib.getUri(emailId, workspaceName);
nodelib.getShareInfo(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("");
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", "GETSHAREINFO");
paramsMap.put("ZOHO_OUTPUT_FORMAT", "JSON");
paramsMap.put("ZOHO_ERROR_FORMAT", "JSON");
paramsMap.put("ZOHO_API_VERSION", "1.0");
response = invokeurl[url: "https://analyticsapi.zoho.com/api/" + email + "/" + workspaceName type: POST parameters: paramsMap headers: headers];
info response;
Copied<?xml version="1.0"encoding="UTF-8" ?>
<responseuri="/api/EmailAddress/WorkspaceName"action="GETSHAREINFO">
<result>
<usershareinfo>
<shareinfo>
<email>user1@mydomain.com</email>
<permissions>
<perminfoviewname="Table1"sharedby="user@mydomain.com">
<permission>
<read>true</read>
<export>true</export>
<vud>false</vud>
<addrow>false</addrow>
<updaterow>false</updaterow>
<deleterow>false</deleterow>
<deleteallrows>false</deleteallrows>
<appendimport>false</appendimport>
<updateimport>false</updateimport>
<truncateimport>false</truncateimport>
<deleteupdateaddimport>false</deleteupdateaddimport>
<share>false</share>
</permission>
</perminfo>
</permissions>
</shareinfo>
<shareinfo>
<email>user4@mydomain.com</email>
<permissions>
<perminfoviewname="Table1"sharedby="user@mydomain.com">
<permission>
<read>true</read>
<export>true</export>
<vud>false</vud>
<addrow>false</addrow>
<updaterow>false</updaterow>
<deleterow>false</deleterow>
<deleteallrows>false</deleteallrows>
<appendimport>false</appendimport>
<updateimport>false</updateimport>
<truncateimport>false</truncateimport>
<deleteupdateaddimport>false</deleteupdateaddimport>
<share>false</share>
</permission>
</perminfo>
</permissions>
</shareinfo>
<shareinfo>
<email>user215@mydomain.com</email>
<permissions>
<perminfoviewname="finepick1"sharedby="user@mydomain.com">
<permission>
<read>true</read>
<export>false</export>
<vud>false</vud>
<addrow>false</addrow>
<updaterow>false</updaterow>
<deleterow>false</deleterow>
<deleteallrows>false</deleteallrows>
<appendimport>false</appendimport>
<updateimport>false</updateimport>
<truncateimport>false</truncateimport>
<deleteupdateaddimport>false</deleteupdateaddimport>
<share>false</share>
</permission>
</perminfo>
</permissions>
</shareinfo>
<shareinfo>
<email>userlf12@mydomain.com</email>
<permissions>
<perminfoviewname="Parent"sharedby="user@mydomain.com">
<permission>
<read>true</read>
<export>false</export>
<vud>false</vud>
<addrow>false</addrow>
<updaterow>false</updaterow>
<deleterow>false</deleterow>
<deleteallrows>false</deleteallrows>
<appendimport>false</appendimport>
<updateimport>false</updateimport>
<truncateimport>false</truncateimport>
<deleteupdateaddimport>false</deleteupdateaddimport>
<share>false</share>
</permission>
</perminfo>
</permissions>
</shareinfo>
<shareinfo>
<email>user33@mydomain.com</email>
<permissions>
<perminfoviewname="Parent"sharedby="user@mydomain.com">
<permission>
<read>true</read>
<export>false</export>
<vud>false</vud>
<addrow>false</addrow>
<updaterow>false</updaterow>
<deleterow>false</deleterow>
<deleteallrows>false</deleteallrows>
<appendimport>false</appendimport>
<updateimport>false</updateimport>
<truncateimport>false</truncateimport>
<deleteupdateaddimport>false</deleteupdateaddimport>
<share>false</share>
</permission>
</perminfo>
<perminfoviewname="sss"sharedby="user@mydomain.com">
<permission>
<read>true</read>
<export>false</export>
<vud>false</vud>
<addrow>false</addrow>
<updaterow>false</updaterow>
<deleterow>false</deleterow>
<deleteallrows>false</deleteallrows>
<appendimport>false</appendimport>
<updateimport>false</updateimport>
<truncateimport>false</truncateimport>
<deleteupdateaddimport>false</deleteupdateaddimport>
<share>false</share>
</permission>
</perminfo>
<perminfoviewname="Table1"sharedby="user@mydomain.com">
<permission>
<read>true</read>
<export>false</export>
<vud>false</vud>
<addrow>false</addrow>
<updaterow>false</updaterow>
<deleterow>false</deleterow>
<deleteallrows>false</deleteallrows>
<appendimport>false</appendimport>
<updateimport>false</updateimport>
<truncateimport>false</truncateimport>
<deleteupdateaddimport>false</deleteupdateaddimport>
<share>false</share>
</permission>
</perminfo>
</permissions>
</shareinfo>
<shareinfo>
<email>user1@mydomain.com</email>
<permissions>
<perminfoviewname="finepick1"sharedby="user@mydomain.com">
<permission>
<read>true</read>
<export>false</export>
<vud>false</vud>
<addrow>false</addrow>
<updaterow>false</updaterow>
<deleterow>false</deleterow>
<deleteallrows>false</deleteallrows>
<appendimport>false</appendimport>
<updateimport>false</updateimport>
<truncateimport>false</truncateimport>
<deleteupdateaddimport>false</deleteupdateaddimport>
<share>false</share>
</permission>
</perminfo>
</permissions>
</shareinfo>
<shareinfo>
<email>user115@mydomain.com</email>
<permissions>
<perminfoviewname="Table1"sharedby="user@mydomain.com">
<permission>
<read>true</read>
<export>true</export>
<vud>false</vud>
<addrow>false</addrow>
<updaterow>false</updaterow>
<deleterow>false</deleterow>
<deleteallrows>false</deleteallrows>
<appendimport>false</appendimport>
<updateimport>false</updateimport>
<truncateimport>false</truncateimport>
<deleteupdateaddimport>false</deleteupdateaddimport>
<share>false</share>
</permission>
</perminfo>
</permissions>
</shareinfo>
<shareinfo>
<email>user11@mydomain.com</email>
<permissions>
<perminfoviewname="grp_pv1"sharedby="user@mydomain.com">
<permission>
<read>true</read>
<export>true</export>
<vud>false</vud>
<addrow>false</addrow>
<updaterow>false</updaterow>
<deleterow>false</deleterow>
<deleteallrows>false</deleteallrows>
<appendimport>false</appendimport>
<updateimport>false</updateimport>
<truncateimport>false</truncateimport>
<deleteupdateaddimport>false</deleteupdateaddimport>
<share>false</share>
</permission>
</perminfo>
</permissions>
</shareinfo>
<shareinfo>
<email>user214@mydomain.com</email>
<permissions>
<perminfoviewname="finepick1"sharedby="user@mydomain.com">
<permission>
<read>true</read>
<export>false</export>
<vud>false</vud>
<addrow>false</addrow>
<updaterow>false</updaterow>
<deleterow>false</deleterow>
<deleteallrows>false</deleteallrows>
<appendimport>false</appendimport>
<updateimport>false</updateimport>
<truncateimport>false</truncateimport>
<deleteupdateaddimport>false</deleteupdateaddimport>
<share>false</share>
</permission>
</perminfo>
</permissions>
</shareinfo>
<shareinfo>
<email>user104@mydomain.com</email>
<permissions>
<perminfoviewname="Table1"sharedby="user@mydomain.com">
<permission>
<read>true</read>
<export>true</export>
<vud>false</vud>
<addrow>false</addrow>
<updaterow>false</updaterow>
<deleterow>false</deleterow>
<deleteallrows>false</deleteallrows>
<appendimport>false</appendimport>
<updateimport>false</updateimport>
<truncateimport>false</truncateimport>
<deleteupdateaddimport>false</deleteupdateaddimport>
<share>false</share>
</permission>
</perminfo>
</permissions>
</shareinfo>
<shareinfo>
<email>user10@mydomain.com</email>
<permissions>
<perminfoviewname="Table2"sharedby="user@mydomain.com">
<permission>
<read>true</read>
<export>false</export>
<vud>false</vud>
<addrow>false</addrow>
<updaterow>false</updaterow>
<deleterow>false</deleterow>
<deleteallrows>false</deleteallrows>
<appendimport>false</appendimport>
<updateimport>false</updateimport>
<truncateimport>false</truncateimport>
<deleteupdateaddimport>false</deleteupdateaddimport>
<share>false</share>
</permission>
</perminfo>
</permissions>
</shareinfo>
<shareinfo>
<email>user101@mydomain.com</email>
<permissions>
<perminfoviewname="Table1"sharedby="user@mydomain.com">
<permission>
<read>true</read>
<export>false</export>
<vud>false</vud>
<addrow>false</addrow>
<updaterow>false</updaterow>
<deleterow>false</deleterow>
<deleteallrows>false</deleteallrows>
<appendimport>false</appendimport>
<updateimport>false</updateimport>
<truncateimport>false</truncateimport>
<deleteupdateaddimport>false</deleteupdateaddimport>
<share>false</share>
</permission>
</perminfo>
</permissions>
</shareinfo>
</usershareinfo>
<publicshareinfo>
</publicshareinfo>
<privatelinkshareinfo>
</privatelinkshareinfo>
<groupshareinfo>
<groupmembers>
<member>user10@mydomain.com</member>
<member>user1@mydomain.com</member>
</groupmembers>
</groupshareinfo>
<dbownershareinfo>
<dbowners>
<member>user13@mydomain.com</member>
<member>user1@mydomain.com</member>
</dbowners>
</dbownershareinfo>
</result>
</response>
Copied{"response":{"uri":"\/api\/email\/WorkspaceName",
"action":"GETSHAREINFO",
"result":{"usershareinfo":[
{"shareinfo":{"email":"user1@mydomain.com",
"permissions":[
{"perminfo":{"viewname":"Table1",
"sharedby":"user@mydomain.com",
"permission":{"read":"true",
"export":"true",
"vud":"false",
"addrow":"true",
"updaterow":"false",
"deleterow":"false",
"deleteallrows":"false",
"appendimport":"false",
"updateimport":"false",
"truncateimport":"false",
"deleteupdateaddimport":"false",
"share":"false"}}}]}},
{"shareinfo":{"email":"user4@mydomain.com",
"permissions":[
{"perminfo":{"viewname":"Table1",
"sharedby":"user@mydomain.com",
"permission":{"read":"true",
"export":"true",
"vud":"false",
"addrow":"true",
"updaterow":"false",
"deleterow":"false",
"deleteallrows":"false",
"appendimport":"false",
"updateimport":"false",
"truncateimport":"false",
"deleteupdateaddimport":"false",
"share":"false"}}}]}},
{"shareinfo":{"email":"user215@mydomain.com",
"permissions":[
{"perminfo":{"viewname":"finepick1",
"sharedby":"user@mydomain.com",
"permission":{"read":"true",
"export":"false",
"vud":"false",
"addrow":"true",
"updaterow":"false",
"deleterow":"false",
"deleteallrows":"false",
"appendimport":"false",
"updateimport":"false",
"truncateimport":"false",
"deleteupdateaddimport":"false",
"share":"false"}}}]}},
{"shareinfo":{"email":"userlf12@mydomain.com",
"permissions":[
{"perminfo":{"viewname":"Parent",
"sharedby":"user@mydomain.com",
"permission":{"read":"true",
"export":"false",
"vud":"false",
"addrow":"true",
"updaterow":"false",
"deleterow":"false",
"deleteallrows":"false",
"appendimport":"false",
"updateimport":"false",
"truncateimport":"false",
"deleteupdateaddimport":"false",
"share":"false"}}}]}},
{"shareinfo":{"email":"user33@mydomain.com",
"permissions":[
{"perminfo":{"viewname":"Parent",
"sharedby":"user@mydomain.com",
"permission":{"read":"true",
"export":"false",
"vud":"false",
"addrow":"true",
"updaterow":"false",
"deleterow":"false",
"deleteallrows":"false",
"appendimport":"false",
"updateimport":"false",
"truncateimport":"false",
"deleteupdateaddimport":"false",
"share":"false"}}},
{"perminfo":{"viewname":"sss",
"sharedby":"user@mydomain.com",
"permission":{"read":"true",
"export":"false",
"vud":"false",
"addrow":"true",
"updaterow":"false",
"deleterow":"false",
"deleteallrows":"false",
"appendimport":"false",
"updateimport":"false",
"truncateimport":"false",
"deleteupdateaddimport":"false",
"share":"false"}}},
{"perminfo":{"viewname":"Table1",
"sharedby":"user@mydomain.com",
"permission":{"read":"true",
"export":"false",
"vud":"false",
"addrow":"true",
"updaterow":"false",
"deleterow":"false",
"deleteallrows":"false",
"appendimport":"false",
"updateimport":"false",
"truncateimport":"false",
"deleteupdateaddimport":"false",
"share":"false"}}}]}},
{"shareinfo":{"email":"user1@mydomain.com",
"permissions":[
{"perminfo":{"viewname":"finepick1",
"sharedby":"user@mydomain.com",
"permission":{"read":"true",
"export":"false",
"vud":"false",
"addrow":"true",
"updaterow":"false",
"deleterow":"false",
"deleteallrows":"false",
"appendimport":"false",
"updateimport":"false",
"truncateimport":"false",
"deleteupdateaddimport":"false",
"share":"false"}}}]}},
{"shareinfo":{"email":"user115@mydomain.com",
"permissions":[
{"perminfo":{"viewname":"Table1",
"sharedby":"user@mydomain.com",
"permission":{"read":"true",
"export":"true",
"vud":"false",
"addrow":"true",
"updaterow":"false",
"deleterow":"false",
"deleteallrows":"false",
"appendimport":"false",
"updateimport":"false",
"truncateimport":"false",
"deleteupdateaddimport":"false",
"share":"false"}}}]}},
{"shareinfo":{"email":"user11@mydomain.com",
"permissions":[
{"perminfo":{"viewname":"grp_pv1",
"sharedby":"user@mydomain.com",
"permission":{"read":"true",
"export":"true",
"vud":"false",
"addrow":"true",
"updaterow":"false",
"deleterow":"false",
"deleteallrows":"false",
"appendimport":"false",
"updateimport":"false",
"truncateimport":"false",
"deleteupdateaddimport":"false",
"share":"false"}}}]}},
{"shareinfo":{"email":"user214@mydomain.com",
"permissions":[
{"perminfo":{"viewname":"finepick1",
"sharedby":"user@mydomain.com",
"permission":{"read":"true",
"export":"false",
"vud":"false",
"addrow":"true",
"updaterow":"false",
"deleterow":"false",
"deleteallrows":"false",
"appendimport":"false",
"updateimport":"false",
"truncateimport":"false",
"deleteupdateaddimport":"false",
"share":"false"}}}]}},
{"shareinfo":{"email":"user104@mydomain.com",
"permissions":[
{"perminfo":{"viewname":"Table1",
"sharedby":"user@mydomain.com",
"permission":{"read":"true",
"export":"true",
"vud":"false",
"addrow":"true",
"updaterow":"false",
"deleterow":"false",
"deleteallrows":"false",
"appendimport":"false",
"updateimport":"false",
"truncateimport":"false",
"deleteupdateaddimport":"false",
"share":"false"}}}]}},
{"shareinfo":{"email":"user10@mydomain.com",
"permissions":[
{"perminfo":{"viewname":"Table2",
"sharedby":"user@mydomain.com",
"permission":{"read":"true",
"export":"false",
"vud":"false",
"addrow":"true",
"updaterow":"false",
"deleterow":"false",
"deleteallrows":"false",
"appendimport":"false",
"updateimport":"false",
"truncateimport":"false",
"deleteupdateaddimport":"false",
"share":"false"}}}]}},
{"shareinfo":{"email":"user101@mydomain.com",
"permissions":[
{"perminfo":{"viewname":"Table1",
"sharedby":"user@mydomain.com",
"permission":{"read":"true",
"export":"false",
"vud":"false",
"addrow":"true",
"updaterow":"false",
"deleterow":"false",
"deleteallrows":"false",
"appendimport":"false",
"updateimport":"false",
"truncateimport":"false",
"deleteupdateaddimport":"false",
"share":"false"}}}]}}],
"publicshareinfo":{},
"privatelinkshareinfo":{},
"groupshareinfo":{"groupmembers":[
"user10@mydomain.com",
"user1@mydomain.com"]},
"dbownershareinfo":{"dbowners":[
"user13@mydomain.com",
"user1@mydomain.com"]}}}}