Interface IWorkspaceAPI

Namespace: ZohoAnalytics

Assembly: ZohoAnalytics.dll

Syntax

public interface IWorkspaceAPI

Methods

AddAdmins(List<String>, Dictionary<String, Object>)

Declaration

void AddAdmins(List<string> emailIds, Dictionary<string, object> config)

Parameters

Type	Name	Description
List<System.String>	emailIds
Dictionary<System.String, System.Object>	config

AddDefault()

Declaration

void AddDefault()

AddFavorite()

Declaration

void AddFavorite()

AddGroupMembers(Int64, List<String>, Dictionary<String, Object>)

Declaration

void AddGroupMembers(long groupId, List<string> emailIds, Dictionary<string, object> config)

Parameters

Type	Name	Description
System.Int64	groupId
List<System.String>	emailIds
Dictionary<System.String, System.Object>	config

AddWorkspaceUsers(List<String>, String, Dictionary<String, Object>)

Declaration

void AddWorkspaceUsers(List<string> emailIds, string role, Dictionary<string, object> config)

Parameters

Type	Name	Description
List<System.String>	emailIds
System.String	role
Dictionary<System.String, System.Object>	config

ChangeEmailScheduleStatus(Int64, String)

Declaration

void ChangeEmailScheduleStatus(long scheduleId, string operation)

Parameters

Type	Name	Description
System.Int64	scheduleId
System.String	operation

ChangeFolderHierarchy(Int64, Int32, Dictionary<String, Object>)

Declaration

void ChangeFolderHierarchy(long folderId, int hierarchy, Dictionary<string, object> config)

Parameters

Type	Name	Description
System.Int64	folderId
System.Int32	hierarchy
Dictionary<System.String, System.Object>	config

ChangeFolderPosition(Int64, Int64, Dictionary<String, Object>)

Declaration

void ChangeFolderPosition(long folderId, long referenceFolderId, Dictionary<string, object> config)

Parameters

Type	Name	Description
System.Int64	folderId
System.Int64	referenceFolderId
Dictionary<System.String, System.Object>	config

ChangeWorkspaceUserRole(List<String>, String, Dictionary<String, Object>)

Declaration

void ChangeWorkspaceUserRole(List<string> emailIds, string role, Dictionary<string, object> config)

Parameters

Type	Name	Description
List<System.String>	emailIds
System.String	role
Dictionary<System.String, System.Object>	config

ChangeWorkspaceUserStatus(List<String>, String, Dictionary<String, Object>)

Declaration

void ChangeWorkspaceUserStatus(List<string> emailIds, string operation, Dictionary<string, object> config)

Parameters

Type	Name	Description
List<System.String>	emailIds
System.String	operation
Dictionary<System.String, System.Object>	config

Copy(String, Dictionary<String, Object>, Nullable<Int64>)

Declaration

long Copy(string newWorkspaceName, Dictionary<string, object> config, long? destOrgId)

Parameters

Type	Name	Description
System.String	newWorkspaceName
Dictionary<System.String, System.Object>	config
System.Nullable<System.Int64>	destOrgId

Returns

Type	Description
System.Int64

CopyViews(List<Int64>, Int64, Dictionary<String, Object>, Nullable<Int64>)

Declaration

JsonElement CopyViews(List<long> viewIds, long destWorkspaceId, Dictionary<string, object> config, long? destOrgId)

Parameters

Type	Name	Description
List<System.Int64>	viewIds
System.Int64	destWorkspaceId
Dictionary<System.String, System.Object>	config
System.Nullable<System.Int64>	destOrgId

Returns

Type	Description
System.Text.Json.JsonElement

CreateEmailSchedule(String, List<Int64>, String, List<String>, Dictionary<String, Object>, Dictionary<String, Object>)

Declaration

long CreateEmailSchedule(string scheduleName, List<long> viewIds, string format, List<string> emailIds, Dictionary<string, object> scheduleDetails, Dictionary<string, object> config)

Parameters

Type	Name	Description
System.String	scheduleName
List<System.Int64>	viewIds
System.String	format
List<System.String>	emailIds
Dictionary<System.String, System.Object>	scheduleDetails
Dictionary<System.String, System.Object>	config

Returns

Type	Description
System.Int64

CreateFolder(String, Dictionary<String, Object>)

Declaration

long CreateFolder(string folderName, Dictionary<string, object> config)

Parameters

Type	Name	Description
System.String	folderName
Dictionary<System.String, System.Object>	config

Returns

Type	Description
System.Int64

CreateGroup(String, List<String>, Dictionary<String, Object>)

Declaration

long CreateGroup(string groupName, List<string> emailIds, Dictionary<string, object> config)

Parameters

Type	Name	Description
System.String	groupName
List<System.String>	emailIds
Dictionary<System.String, System.Object>	config

Returns

Type	Description
System.Int64

CreateQueryTable(String, String, Dictionary<String, Object>)

Declaration

long CreateQueryTable(string sqlQuery, string queryTableName, Dictionary<string, object> config)

Parameters

Type	Name	Description
System.String	sqlQuery
System.String	queryTableName
Dictionary<System.String, System.Object>	config

Returns

Type	Description
System.Int64

CreateSlideshow(String, List<Int64>, Dictionary<String, Object>)

Declaration

long CreateSlideshow(string slideName, List<long> viewIds, Dictionary<string, object> config)

Parameters

Type	Name	Description
System.String	slideName
List<System.Int64>	viewIds
Dictionary<System.String, System.Object>	config

Returns

Type	Description
System.Int64

CreateTable(Dictionary<String, Object>)

Declaration

long CreateTable(Dictionary<string, object> tableDesign)

Parameters

Type	Name	Description
Dictionary<System.String, System.Object>	tableDesign

Returns

Type	Description
System.Int64

CreateVariable(String, Int32, Int32, Dictionary<String, Object>)

Declaration

long CreateVariable(string variableName, int variableDataType, int variableType, Dictionary<string, object> config)

Parameters

Type	Name	Description
System.String	variableName
System.Int32	variableDataType
System.Int32	variableType
Dictionary<System.String, System.Object>	config

Returns

Type	Description
System.Int64

Delete()

Declaration

void Delete()

DeleteEmailSchedule(Int64)

Declaration

void DeleteEmailSchedule(long scheduleId)

Parameters

Type	Name	Description
System.Int64	scheduleId

DeleteFolder(Int64)

Declaration

void DeleteFolder(long folderId)

Parameters

Type	Name	Description
System.Int64	folderId

DeleteGroup(Int64)

Declaration

void DeleteGroup(long groupId)

Parameters

Type	Name	Description
System.Int64	groupId

DeleteSlideshow(Int64)

Declaration

void DeleteSlideshow(long slideId)

Parameters

Type	Name	Description
System.Int64	slideId

DeleteTrashView(Int64, Dictionary<String, Object>)

Declaration

void DeleteTrashView(long viewId, Dictionary<string, object> config)

Parameters

Type	Name	Description
System.Int64	viewId
Dictionary<System.String, System.Object>	config

DeleteVariable(Int64)

Declaration

void DeleteVariable(long variableId)

Parameters

Type	Name	Description
System.Int64	variableId

DisableDomainAccess()

Declaration

void DisableDomainAccess()

EditQueryTable(Int64, String, Dictionary<String, Object>)

Declaration

void EditQueryTable(long viewId, string sqlQuery, Dictionary<string, object> config)

Parameters

Type	Name	Description
System.Int64	viewId
System.String	sqlQuery
Dictionary<System.String, System.Object>	config

EnableDomainAccess()

Declaration

void EnableDomainAccess()

ExportAsTemplate(List<Int64>, String, Dictionary<String, Object>)

Declaration

void ExportAsTemplate(List<long> viewIds, string filePath, Dictionary<string, object> config)

Parameters

Type	Name	Description
List<System.Int64>	viewIds
System.String	filePath
Dictionary<System.String, System.Object>	config

GetAdmins()

Declaration

JsonElement GetAdmins()

Returns

Type	Description
System.Text.Json.JsonElement

GetDatasources()

Declaration

JsonElement GetDatasources()

Returns

Type	Description
System.Text.Json.JsonElement

GetEmailSchedules()

Declaration

JsonElement GetEmailSchedules()

Returns

Type	Description
System.Text.Json.JsonElement

GetFolders()

Declaration

JsonElement GetFolders()

Returns

Type	Description
System.Text.Json.JsonElement

GetGroupDetails(Int64)

Declaration

JsonElement GetGroupDetails(long groupId)

Parameters

Type	Name	Description
System.Int64	groupId

Returns

Type	Description
System.Text.Json.JsonElement

GetGroups()

Declaration

JsonElement GetGroups()

Returns

Type	Description
System.Text.Json.JsonElement

GetSecretKey(Dictionary<String, Object>)

Declaration

string GetSecretKey(Dictionary<string, object> config)

Parameters

Type	Name	Description
Dictionary<System.String, System.Object>	config

Returns

Type	Description
System.String

GetSharedDetailsForViews(List<Int64>)

Declaration

JsonElement GetSharedDetailsForViews(List<long> viewIds)

Parameters

Type	Name	Description
List<System.Int64>	viewIds

Returns

Type	Description
System.Text.Json.JsonElement

GetShareInfo()

Declaration

JsonElement GetShareInfo()

Returns

Type	Description
System.Text.Json.JsonElement

GetSlideshowDetails(Int64)

Declaration

JsonElement GetSlideshowDetails(long slideId)

Parameters

Type	Name	Description
System.Int64	slideId

Returns

Type	Description
System.Text.Json.JsonElement

GetSlideshows()

Declaration

JsonElement GetSlideshows()

Returns

Type	Description
System.Text.Json.JsonElement

GetSlideshowURL(Int64, Dictionary<String, Object>)

Declaration

string GetSlideshowURL(long slideId, Dictionary<string, object> config)

Parameters

Type	Name	Description
System.Int64	slideId
Dictionary<System.String, System.Object>	config

Returns

Type	Description
System.String

GetTrashViews()

Declaration

JsonElement GetTrashViews()

Returns

Type	Description
System.Text.Json.JsonElement

GetVariableDetails(Int64)

Declaration

JsonElement GetVariableDetails(long variableId)

Parameters

Type	Name	Description
System.Int64	variableId

Returns

Type	Description
System.Text.Json.JsonElement

GetVariables()

Declaration

JsonElement GetVariables()

Returns

Type	Description
System.Text.Json.JsonElement

GetViews(Dictionary<String, Object>)

Declaration

JsonElement GetViews(Dictionary<string, object> config)

Parameters

Type	Name	Description
Dictionary<System.String, System.Object>	config

Returns

Type	Description
System.Text.Json.JsonElement

GetWorkspaceUsers()

Declaration

JsonElement GetWorkspaceUsers()

Returns

Type	Description
System.Text.Json.JsonElement

MakeDefaultFolder(Int64)

Declaration

void MakeDefaultFolder(long folderId)

Parameters

Type	Name	Description
System.Int64	folderId

MoveViewsToFolder(Int64, List<Int64>, Dictionary<String, Object>)

Declaration

void MoveViewsToFolder(long folderId, List<long> viewIds, Dictionary<string, object> config)

Parameters

Type	Name	Description
System.Int64	folderId
List<System.Int64>	viewIds
Dictionary<System.String, System.Object>	config

RemoveAdmins(List<String>, Dictionary<String, Object>)

Declaration

void RemoveAdmins(List<string> emailIds, Dictionary<string, object> config)

Parameters

Type	Name	Description
List<System.String>	emailIds
Dictionary<System.String, System.Object>	config

RemoveDefault()

Declaration

void RemoveDefault()

RemoveFavorite()

Declaration

void RemoveFavorite()

RemoveGroupMembers(Int64, List<String>, Dictionary<String, Object>)

Declaration

void RemoveGroupMembers(long groupId, List<string> emailIds, Dictionary<string, object> config)

Parameters

Type	Name	Description
System.Int64	groupId
List<System.String>	emailIds
Dictionary<System.String, System.Object>	config

RemoveShare(List<Int64>, List<String>, Dictionary<String, Object>)

Declaration

void RemoveShare(List<long> viewIds, List<string> emailIds, Dictionary<string, object> config)

Parameters

Type	Name	Description
List<System.Int64>	viewIds
List<System.String>	emailIds
Dictionary<System.String, System.Object>	config

RemoveWorkspaceUsers(List<String>, Dictionary<String, Object>)

Declaration

void RemoveWorkspaceUsers(List<string> emailIds, Dictionary<string, object> config)

Parameters

Type	Name	Description
List<System.String>	emailIds
Dictionary<System.String, System.Object>	config

Rename(String, Dictionary<String, Object>)

Declaration

void Rename(string workspaceName, Dictionary<string, object> config)

Parameters

Type	Name	Description
System.String	workspaceName
Dictionary<System.String, System.Object>	config

RenameFolder(Int64, String, Dictionary<String, Object>)

Declaration

void RenameFolder(long folderId, string folderName, Dictionary<string, object> config)

Parameters

Type	Name	Description
System.Int64	folderId
System.String	folderName
Dictionary<System.String, System.Object>	config

RenameGroup(Int64, String, Dictionary<String, Object>)

Declaration

void RenameGroup(long groupId, string groupName, Dictionary<string, object> config)

Parameters

Type	Name	Description
System.Int64	groupId
System.String	groupName
Dictionary<System.String, System.Object>	config

RestoreTrashView(Int64, Dictionary<String, Object>)

Declaration

void RestoreTrashView(long viewId, Dictionary<string, object> config)

Parameters

Type	Name	Description
System.Int64	viewId
Dictionary<System.String, System.Object>	config

ShareViews(List<Int64>, List<String>, Dictionary<String, Boolean>, Dictionary<String, Object>)

Declaration

void ShareViews(List<long> viewIds, List<string> emailIds, Dictionary<string, bool> permissions, Dictionary<string, object> config)

Parameters

Type	Name	Description
List<System.Int64>	viewIds
List<System.String>	emailIds
Dictionary<System.String, System.Boolean>	permissions
Dictionary<System.String, System.Object>	config

SyncData(Int64, Dictionary<String, Object>)

Declaration

void SyncData(long datasourceId, Dictionary<string, object> config)

Parameters

Type	Name	Description
System.Int64	datasourceId
Dictionary<System.String, System.Object>	config

TriggerEmailSchedule(Int64)

Declaration

void TriggerEmailSchedule(long scheduleId)

Parameters

Type	Name	Description
System.Int64	scheduleId

UpdateDatasourceConnection(Int64, Dictionary<String, Object>)

Declaration

void UpdateDatasourceConnection(long datasourceId, Dictionary<string, object> config)

Parameters

Type	Name	Description
System.Int64	datasourceId
Dictionary<System.String, System.Object>	config

UpdateEmailSchedule(Int64, Dictionary<String, Object>)

Declaration

long UpdateEmailSchedule(long scheduleId, Dictionary<string, object> config)

Parameters

Type	Name	Description
System.Int64	scheduleId
Dictionary<System.String, System.Object>	config

Returns

Type	Description
System.Int64

UpdateSlideshow(Int64, Dictionary<String, Object>)

Declaration

void UpdateSlideshow(long slideId, Dictionary<string, object> config)

Parameters

Type	Name	Description
System.Int64	slideId
Dictionary<System.String, System.Object>	config

UpdateVariable(Int64, String, Int32, Int32, Dictionary<String, Object>)

Declaration

void UpdateVariable(long variableId, string variableName, int variableDataType, int variableType, Dictionary<string, object> config)

Parameters

Type	Name	Description
System.Int64	variableId
System.String	variableName
System.Int32	variableDataType
System.Int32	variableType
Dictionary<System.String, System.Object>	config