Class WorkspaceAPI
WorkspaceAPI contains workspace level operations.
Inherited Members
Namespace: ZohoAnalytics
Assembly: ZohoAnalytics.dll
Syntax
public class WorkspaceAPIMethods
AddAdmins(List<string>, Dictionary<string, object>)
Add admins for the specified workspace.
Declaration
public void AddAdmins(List<string> emailIds, Dictionary<string, object> config)Parameters
| Type | Name | Description |
|---|---|---|
| List<string> | emailIds | The email address of the admin users to be added. |
| Dictionary<string, object> | config | Contains any additional control configurations. Can be null. |
AddDefault()
Adds a specified workspace as default.
Declaration
public void AddDefault()AddFavorite()
Adds a specified workspace as favorite.
Declaration
public void AddFavorite()AddGroupMembers(long, List<string>, Dictionary<string, object>)
Add users to the specified group.
Declaration
public void AddGroupMembers(long groupId, List<string> emailIds, Dictionary<string, object> config)Parameters
| Type | Name | Description |
|---|---|---|
| long | groupId | The id of the group. |
| List<string> | emailIds | The email address of the users to be added to the group. |
| Dictionary<string, object> | config | Contains any additional control configurations. Can be null. |
AddWorkspaceUsers(List<string>, string, Dictionary<string, object>)
Add users to the specified workspace.
Declaration
public void AddWorkspaceUsers(List<string> emailIds, string role, Dictionary<string, object> config)Parameters
| Type | Name | Description |
|---|---|---|
| List<string> | emailIds | The email address of the users to be added. |
| string | role | Role of the users to be added. |
| Dictionary<string, object> | config | Contains any additional control configurations. Can be null. |
AutomlAnalysisPrediction(long, long, Dictionary<string, object>, Dictionary<string, object>)
Get predictions by providing sample input values for a trained model.
Declaration
public JsonElement AutomlAnalysisPrediction(long analysisId, long modelId, Dictionary<string, object> features, Dictionary<string, object> config)Parameters
| Type | Name | Description |
|---|---|---|
| long | analysisId | |
| long | modelId | |
| Dictionary<string, object> | features | |
| Dictionary<string, object> | config |
Returns
| Type | Description |
|---|---|
| JsonElement | Prediction details. |
ChangeEmailScheduleStatus(long, string)
Update email schedule status.
Declaration
public void ChangeEmailScheduleStatus(long scheduleId, string operation)Parameters
| Type | Name | Description |
|---|---|---|
| long | scheduleId | Id for the email schedule. |
| string | operation | New status for the schedule ( Values - activate | deactivate ) |
ChangeFolderHierarchy(long, int, Dictionary<string, object>)
Swaps the hierarchy of a parent folder and a subfolder.
Declaration
public void ChangeFolderHierarchy(long folderId, int hierarchy, Dictionary<string, object> config)Parameters
| Type | Name | Description |
|---|---|---|
| long | folderId | Id of the folder. |
| int | hierarchy | New hierarchy for the folder. (0 - Parent; 1 - Child) |
| Dictionary<string, object> | config | Contains any additional control configurations. Can be null. |
ChangeFolderPosition(long, long, Dictionary<string, object>)
Place the folder above the reference folder.
Declaration
public void ChangeFolderPosition(long folderId, long referenceFolderId, Dictionary<string, object> config)Parameters
| Type | Name | Description |
|---|---|---|
| long | folderId | Id of the folder. |
| long | referenceFolderId | Id of the reference folder. |
| Dictionary<string, object> | config | Contains any additional control configurations. Can be null. |
ChangeWorkspaceUserRole(List<string>, string, Dictionary<string, object>)
Change role for the specified users.
Declaration
public void ChangeWorkspaceUserRole(List<string> emailIds, string role, Dictionary<string, object> config)Parameters
| Type | Name | Description |
|---|---|---|
| List<string> | emailIds | The email address of the users. |
| string | role | Name of the role. |
| Dictionary<string, object> | config | Contains any additional control configurations. Can be null. |
ChangeWorkspaceUserStatus(List<string>, string, Dictionary<string, object>)
Change users staus in the specified workspace.
Declaration
public void ChangeWorkspaceUserStatus(List<string> emailIds, string operation, Dictionary<string, object> config)Parameters
| Type | Name | Description |
|---|---|---|
| List<string> | emailIds | The email address of the users. |
| string | operation | New status for the users ( Values - activate | deactivate ) |
| Dictionary<string, object> | config | Contains any additional control configurations. Can be null. |
Copy(string, Dictionary<string, object>, long?)
Copy the specified workspace from one organization to another or within the organization.
Declaration
public long Copy(string newWorkspaceName, Dictionary<string, object> config, long? destOrgId)Parameters
| Type | Name | Description |
|---|---|---|
| string | newWorkspaceName | Name of the new workspace. |
| Dictionary<string, object> | config | Contains any additional control configurations. Can be null. |
| long? | destOrgId | Id of the organization where the destination workspace is present. Can be null. |
Returns
| Type | Description |
|---|---|
| long | New workspace id. |
CopyViews(List<long>, long, Dictionary<string, object>, long?)
Copy the specified views from one workspace to another workspace.
Declaration
public JsonElement CopyViews(List<long> viewIds, long destWorkspaceId, Dictionary<string, object> config, long? destOrgId)Parameters
| Type | Name | Description |
|---|---|---|
| List<long> | viewIds | The id of the views to be copied. |
| long | destWorkspaceId | The destination workspace id. |
| Dictionary<string, object> | config | Contains any additional control configurations. Can be null. |
| long? | destOrgId | Id of the organization where the destination workspace is present. Can be null. |
Returns
| Type | Description |
|---|---|
| JsonElement | Views list. |
CreateAutomlAnalysis(string, long, string, List<string>, int, Dictionary<string, object>, Dictionary<string, object>)
Create a new AutoML analysis within the provided workspace.
Declaration
public long CreateAutomlAnalysis(string name, long trainingTableId, string predictionType, List<string> features, int serverOption, Dictionary<string, object> algorithms, Dictionary<string, object> config)Parameters
| Type | Name | Description |
|---|---|---|
| string | name | |
| long | trainingTableId | |
| string | predictionType | |
| List<string> | features | |
| int | serverOption | |
| Dictionary<string, object> | algorithms | |
| Dictionary<string, object> | config |
Returns
| Type | Description |
|---|---|
| long | Created AutoML Analysis Id. |
CreateAutomlAnalysisDeployment(long, long, long, string, List<string>, string, int, string, Dictionary<string, object>, Dictionary<string, object>)
Deploy the AutoML analysis model.
Declaration
public JsonElement CreateAutomlAnalysisDeployment(long analysisId, long modelId, long inputTableId, string outputTable, List<string> outputColumns, string predictionColumn, int serverOption, string importType, Dictionary<string, object> scheduleDetails, Dictionary<string, object> config)Parameters
| Type | Name | Description |
|---|---|---|
| long | analysisId | |
| long | modelId | |
| long | inputTableId | |
| string | outputTable | |
| List<string> | outputColumns | |
| string | predictionColumn | |
| int | serverOption | |
| string | importType | |
| Dictionary<string, object> | scheduleDetails | |
| Dictionary<string, object> | config |
Returns
| Type | Description |
|---|---|
| JsonElement | Deployment details. |
CreateEmailSchedule(string, List<long>, string, List<string>, Dictionary<string, object>, Dictionary<string, object>)
Create an email schedule in the specified workspace.
Declaration
public long CreateEmailSchedule(string scheduleName, List<long> viewIds, string format, List<string> emailIds, Dictionary<string, object> scheduleDetails, Dictionary<string, object> config)Parameters
| Type | Name | Description |
|---|---|---|
| string | scheduleName | Name of the email schedule. |
| List<long> | viewIds | View ids to be mailed. |
| string | format | The format in which the data has to be mailed. |
| List<string> | emailIds | The recipients' email addresses for sending views. |
| Dictionary<string, object> | scheduleDetails | Contains schedule frequency, date, and time info. |
| Dictionary<string, object> | config | Contains any additional control configurations. Can be null. |
Returns
| Type | Description |
|---|---|
| long | Email schedule id. |
CreateFolder(string, Dictionary<string, object>)
Create a folder in the specified workspace.
Declaration
public long CreateFolder(string folderName, Dictionary<string, object> config)Parameters
| Type | Name | Description |
|---|---|---|
| string | folderName | The name of the folder. |
| Dictionary<string, object> | config | Contains any additional control configurations. Can be null. |
Returns
| Type | Description |
|---|---|
| long | Folder id. |
CreateGroup(string, List<string>, Dictionary<string, object>)
Create a group in the specified workspace.
Declaration
public long CreateGroup(string groupName, List<string> emailIds, Dictionary<string, object> config)Parameters
| Type | Name | Description |
|---|---|---|
| string | groupName | Name of the group. |
| List<string> | emailIds | The email address of the users to be added to the group. |
| Dictionary<string, object> | config | Contains any additional control configurations. Can be null. |
Returns
| Type | Description |
|---|---|
| long | Group id. |
CreateQueryTable(string, string, Dictionary<string, object>)
Create a new query table in the workspace.
Declaration
public long CreateQueryTable(string sqlQuery, string queryTableName, Dictionary<string, object> config)Parameters
| Type | Name | Description |
|---|---|---|
| string | sqlQuery | SQL query to construct the query table. |
| string | queryTableName | Name of the query table to be created. |
| Dictionary<string, object> | config | Contains the control configurations. |
Returns
| Type | Description |
|---|---|
| long | View id. |
CreateReport(Dictionary<string, object>)
Create a report in the specified workspace.
Declaration
public long CreateReport(Dictionary<string, object> config)Parameters
| Type | Name | Description |
|---|---|---|
| Dictionary<string, object> | config | Contains the control configurations. |
Returns
| Type | Description |
|---|---|
| long | Created view id. |
CreateSlideshow(string, List<long>, Dictionary<string, object>)
Create a slideshow in the specified workspace.
Declaration
public long CreateSlideshow(string slideName, List<long> viewIds, Dictionary<string, object> config)Parameters
| Type | Name | Description |
|---|---|---|
| string | slideName | Name of the slideshow to be created. |
| List<long> | viewIds | Ids of the view to be included in the slideshow. |
| Dictionary<string, object> | config | Contains any additional control configurations. Can be null. |
Returns
| Type | Description |
|---|---|
| long | Slideshow id. |
CreateTable(Dictionary<string, object>)
Create a table in the specified workspace.
Declaration
public long CreateTable(Dictionary<string, object> tableDesign)Parameters
| Type | Name | Description |
|---|---|---|
| Dictionary<string, object> | tableDesign | Table structure. |
Returns
| Type | Description |
|---|---|
| long | Table id. |
CreateVariable(string, int, int, Dictionary<string, object>)
Create a variable in the workspace.
Declaration
public long CreateVariable(string variableName, int variableDataType, int variableType, Dictionary<string, object> config)Parameters
| Type | Name | Description |
|---|---|---|
| string | variableName | Name of the variable to be created. |
| int | variableDataType | Datatype of the variable to be created. |
| int | variableType | Type of the variable to be created. |
| Dictionary<string, object> | config | Contains the control configurations. |
Returns
| Type | Description |
|---|---|
| long | Variable id. |
Delete()
Delete a specified workspace in the organization.
Declaration
public void Delete()DeleteAutomlAnalysis(long, Dictionary<string, object>)
Delete a specified AutoML analysis from the given workspace.
Declaration
public void DeleteAutomlAnalysis(long analysisId, Dictionary<string, object> config)Parameters
| Type | Name | Description |
|---|---|---|
| long | analysisId | Id of the AutoML Analysis to be deleted. |
| Dictionary<string, object> | config | Contains any additional control parameters. Can be null. |
DeleteAutomlAnalysisDeployment(long, long, Dictionary<string, object>)
Delete the AutoML analysis deployment.
Declaration
public void DeleteAutomlAnalysisDeployment(long analysisId, long deploymentId, Dictionary<string, object> config)Parameters
| Type | Name | Description |
|---|---|---|
| long | analysisId | Id of the AutoML Analysis. |
| long | deploymentId | Id of the deployment to be deleted. |
| Dictionary<string, object> | config | Contains any additional control parameters. Can be null. |
DeleteAutomlAnalysisModel(long, long, Dictionary<string, object>)
Delete a specified model available in the given AutoML analysis.
Declaration
public void DeleteAutomlAnalysisModel(long analysisId, long modelId, Dictionary<string, object> config)Parameters
| Type | Name | Description |
|---|---|---|
| long | analysisId | Id of the AutoML Analysis. |
| long | modelId | Id of the model to be deleted. |
| Dictionary<string, object> | config | Contains any additional control parameters. Can be null. |
DeleteEmailSchedule(long)
Delete the specified email schedule in the workspace.
Declaration
public void DeleteEmailSchedule(long scheduleId)Parameters
| Type | Name | Description |
|---|---|---|
| long | scheduleId | Id for the email schedule. |
DeleteFolder(long)
Delete a specified folder in the workspace.
Declaration
public void DeleteFolder(long folderId)Parameters
| Type | Name | Description |
|---|---|---|
| long | folderId | The id of the folder. |
DeleteGroup(long)
Delete a specified group.
Declaration
public void DeleteGroup(long groupId)Parameters
| Type | Name | Description |
|---|---|---|
| long | groupId | The id of the group. |
DeleteSlideshow(long)
Delete a specified slideshow in the workspace.
Declaration
public void DeleteSlideshow(long slideId)Parameters
| Type | Name | Description |
|---|---|---|
| long | slideId | The id of the slideshow. |
DeleteTrashView(long, Dictionary<string, object>)
Delete the specified view permanently from trash.
Declaration
public void DeleteTrashView(long viewId, Dictionary<string, object> config)Parameters
| Type | Name | Description |
|---|---|---|
| long | viewId | Id of the view. |
| Dictionary<string, object> | config | Contains any additional control configurations. Can be null. |
DeleteVariable(long)
Delete a specified variable in the workspace.
Declaration
public void DeleteVariable(long variableId)Parameters
| Type | Name | Description |
|---|---|---|
| long | variableId | The id of the variable. |
DeployAutomlAnalysis(long, long, Dictionary<string, object>)
Execute the AutoML analysis deployment.
Declaration
public void DeployAutomlAnalysis(long analysisId, long deploymentId, Dictionary<string, object> config)Parameters
| Type | Name | Description |
|---|---|---|
| long | analysisId | Id of the AutoML Analysis. |
| long | deploymentId | Id of the deployment to execute. |
| Dictionary<string, object> | config | Contains any additional control parameters. Can be null. |
DisableDomainAccess()
Disable workspace from the specified white label domain.
Declaration
public void DisableDomainAccess()EditQueryTable(long, string, Dictionary<string, object>)
Update the mentioned query table in the workspace.
Declaration
public void EditQueryTable(long viewId, string sqlQuery, Dictionary<string, object> config)Parameters
| Type | Name | Description |
|---|---|---|
| long | viewId | Id of the query table to be updated. |
| string | sqlQuery | New SQL query to be updated. |
| Dictionary<string, object> | config | Contains the control configurations. |
EnableDomainAccess()
Enable workspace to the specified white label domain.
Declaration
public void EnableDomainAccess()ExportAsTemplate(List<long>, string, Dictionary<string, object>)
Export the views as templates.
Declaration
public void ExportAsTemplate(List<long> viewIds, string filePath, Dictionary<string, object> config)Parameters
| Type | Name | Description |
|---|---|---|
| List<long> | viewIds | |
| string | filePath | Path of the file where the data exported to be stored. ( Should be in 'atpt' format ) |
| Dictionary<string, object> | config | Contains any additional control configurations. Can be null. |
GetAdmins()
Returns list of admins for the specified workspace.
Declaration
public JsonElement GetAdmins()Returns
| Type | Description |
|---|---|
| JsonElement | Workspace admins list. |
GetAggregateFormulaDependents(long)
Returns list of all dependent views and formulas for the specified aggregate formula.
Declaration
public JsonElement GetAggregateFormulaDependents(long formulaId)Parameters
| Type | Name | Description |
|---|---|---|
| long | formulaId | Id of the aggregate formula. |
Returns
| Type | Description |
|---|---|
| JsonElement | Dependent details |
GetAggregateFormulaValue(long)
Returns the value of the aggregate formula.
Declaration
public string GetAggregateFormulaValue(long formulaId)Parameters
| Type | Name | Description |
|---|---|---|
| long | formulaId | Id of the aggregate formula. |
Returns
| Type | Description |
|---|---|
| string | Aggregate formula value |
GetAggregateFormulas(Dictionary<string, object>)
Returns list of all aggregate formulas for the specified workspace.
Declaration
public JsonElement GetAggregateFormulas(Dictionary<string, object> config)Parameters
| Type | Name | Description |
|---|---|---|
| Dictionary<string, object> | config | Contains any additional control configurations. Can be null. |
Returns
| Type | Description |
|---|---|
| JsonElement | Aggregate formula list |
GetAutomlAnalysis()
Returns list of AutoML analysis for the specified workspace.
Declaration
public JsonElement GetAutomlAnalysis()Returns
| Type | Description |
|---|---|
| JsonElement | AutoML analysis list. |
GetAutomlAnalysisDetails(long)
Retrieve detailed information for a specific AutoML analysis.
Declaration
public JsonElement GetAutomlAnalysisDetails(long analysisId)Parameters
| Type | Name | Description |
|---|---|---|
| long | analysisId | Id of the AutoML Analysis. |
Returns
| Type | Description |
|---|---|
| JsonElement | AutoML analysis details. |
GetDatasources()
Returns list of datasources for the specified workspace.
Declaration
public JsonElement GetDatasources()Returns
| Type | Description |
|---|---|
| JsonElement | Datasource list. |
GetDeploymentDetails(long, long)
Returns deployment details available for an AutoML analysis model.
Declaration
public JsonElement GetDeploymentDetails(long analysisId, long modelId)Parameters
| Type | Name | Description |
|---|---|---|
| long | analysisId | Id of the AutoML analysis. |
| long | modelId | Id of the AutoML model. |
Returns
| Type | Description |
|---|---|
| JsonElement | Deployment details. |
GetEmailSchedules()
Returns list of email schedules available in the specified workspace.
Declaration
public JsonElement GetEmailSchedules()Returns
| Type | Description |
|---|---|
| JsonElement | List of email schedules. |
GetFolders()
Returns list of all accessible folders for the specified workspace.
Declaration
public JsonElement GetFolders()Returns
| Type | Description |
|---|---|
| JsonElement | Folders list. |
GetGroupDetails(long)
Returns details of the specified group.
Declaration
public JsonElement GetGroupDetails(long groupId)Parameters
| Type | Name | Description |
|---|---|---|
| long | groupId | The id of the group. |
Returns
| Type | Description |
|---|---|
| JsonElement | Group details. |
GetGroups()
Returns list of groups for the specified workspace.
Declaration
public JsonElement GetGroups()Returns
| Type | Description |
|---|---|
| JsonElement | Groups list. |
GetQueryTableDetails(long)
Returns details of the specified query table.
Declaration
public JsonElement GetQueryTableDetails(long queryTableId)Parameters
| Type | Name | Description |
|---|---|---|
| long | queryTableId | Id of the query table. |
Returns
| Type | Description |
|---|---|
| JsonElement | Query table details. |
GetSecretKey(Dictionary<string, object>)
Returns the secret key of the specified workspace.
Declaration
public string GetSecretKey(Dictionary<string, object> config)Parameters
| Type | Name | Description |
|---|---|---|
| Dictionary<string, object> | config | Contains any additional control configurations. Can be null. |
Returns
| Type | Description |
|---|---|
| string | Workspace secret key. |
GetShareInfo()
Returns shared details of the specified workspace.
Declaration
public JsonElement GetShareInfo()Returns
| Type | Description |
|---|---|
| JsonElement | Shared details. |
GetSharedDetailsForViews(List<long>)
Returns shared details of the specified views.
Declaration
public JsonElement GetSharedDetailsForViews(List<long> viewIds)Parameters
| Type | Name | Description |
|---|---|---|
| List<long> | viewIds | View ids for which sharing details are required. |
Returns
| Type | Description |
|---|---|
| JsonElement | Shared details. |
GetSlideshowDetails(long)
Returns details of the specified slideshow.
Declaration
public JsonElement GetSlideshowDetails(long slideId)Parameters
| Type | Name | Description |
|---|---|---|
| long | slideId | The id of the slideshow. |
Returns
| Type | Description |
|---|---|
| JsonElement | Slideshow details. |
GetSlideshowURL(long, Dictionary<string, object>)
Returns slide URL to access the specified slideshow.
Declaration
public string GetSlideshowURL(long slideId, Dictionary<string, object> config)Parameters
| Type | Name | Description |
|---|---|---|
| long | slideId | The id of the slideshow. |
| Dictionary<string, object> | config | Contains any additional control configurations. Can be null. |
Returns
| Type | Description |
|---|---|
| string | Slideshow URL. |
GetSlideshows()
Returns list of slideshows for the specified workspace.
Declaration
public JsonElement GetSlideshows()Returns
| Type | Description |
|---|---|
| JsonElement | Slideshow list. |
GetTrashViews()
Returns list of all views available in trash for the specified workspace.
Declaration
public JsonElement GetTrashViews()Returns
| Type | Description |
|---|---|
| JsonElement | Views list. |
GetVariableDetails(long)
Returns details of the specified variable.
Declaration
public JsonElement GetVariableDetails(long variableId)Parameters
| Type | Name | Description |
|---|---|---|
| long | variableId | The id of the variable. |
Returns
| Type | Description |
|---|---|
| JsonElement | Variable details. |
GetVariables()
Returns list of variables for the specified workspace.
Declaration
public JsonElement GetVariables()Returns
| Type | Description |
|---|---|
| JsonElement | Variables list. |
GetViews(Dictionary<string, object>)
Returns list of all accessible views for the specified workspace.
Declaration
public JsonElement GetViews(Dictionary<string, object> config)Parameters
| Type | Name | Description |
|---|---|---|
| Dictionary<string, object> | config | Contains any additional control configurations. Can be null. |
Returns
| Type | Description |
|---|---|
| JsonElement | Views list. |
GetWorkspaceUsers()
Returns list of users for the specified workspace.
Declaration
public JsonElement GetWorkspaceUsers()Returns
| Type | Description |
|---|---|
| JsonElement | List of users. |
MakeDefaultFolder(long)
Make the specified folder as default.
Declaration
public void MakeDefaultFolder(long folderId)Parameters
| Type | Name | Description |
|---|---|---|
| long | folderId | The id of the folder. |
MoveViewsToFolder(long, List<long>, Dictionary<string, object>)
Move views to the mentioned folder.
Declaration
public void MoveViewsToFolder(long folderId, List<long> viewIds, Dictionary<string, object> config)Parameters
| Type | Name | Description |
|---|---|---|
| long | folderId | Id of the folder. |
| List<long> | viewIds | View ids to be moved. |
| Dictionary<string, object> | config | Contains any additional control configurations. Can be null. |
RemoveAdmins(List<string>, Dictionary<string, object>)
Remove admins from the specified workspace.
Declaration
public void RemoveAdmins(List<string> emailIds, Dictionary<string, object> config)Parameters
| Type | Name | Description |
|---|---|---|
| List<string> | emailIds | The email address of the admin users to be removed. |
| Dictionary<string, object> | config | Contains any additional control configurations. Can be null. |
RemoveDefault()
Remove a specified workspace from default.
Declaration
public void RemoveDefault()RemoveFavorite()
Remove a specified workspace from favorite.
Declaration
public void RemoveFavorite()RemoveGroupMembers(long, List<string>, Dictionary<string, object>)
Remove users from the specified group.
Declaration
public void RemoveGroupMembers(long groupId, List<string> emailIds, Dictionary<string, object> config)Parameters
| Type | Name | Description |
|---|---|---|
| long | groupId | The id of the group. |
| List<string> | emailIds | The email address of the users to be removed from the group. |
| Dictionary<string, object> | config | Contains any additional control configurations. Can be null. |
RemoveShare(List<long>, List<string>, Dictionary<string, object>)
Remove shared views for the specified users.
Declaration
public void RemoveShare(List<long> viewIds, List<string> emailIds, Dictionary<string, object> config)Parameters
| Type | Name | Description |
|---|---|---|
| List<long> | viewIds | View ids whose sharing needs to be removed. |
| List<string> | emailIds | The email address of the users to whom the sharing need to be removed. |
| Dictionary<string, object> | config | Contains any additional control configurations. Can be null. |
RemoveWorkspaceUsers(List<string>, Dictionary<string, object>)
Remove users from the specified workspace.
Declaration
public void RemoveWorkspaceUsers(List<string> emailIds, Dictionary<string, object> config)Parameters
| Type | Name | Description |
|---|---|---|
| List<string> | emailIds | The email address of the users to be removed. |
| Dictionary<string, object> | config | Contains any additional control configurations. Can be null. |
Rename(string, Dictionary<string, object>)
Rename a specified workspace in the organization.
Declaration
public void Rename(string workspaceName, Dictionary<string, object> config)Parameters
| Type | Name | Description |
|---|---|---|
| string | workspaceName | New name of the workspace. |
| Dictionary<string, object> | config | Contains any additional control configurations. Can be null. |
RenameFolder(long, string, Dictionary<string, object>)
Rename a specified folder in the workspace.
Declaration
public void RenameFolder(long folderId, string folderName, Dictionary<string, object> config)Parameters
| Type | Name | Description |
|---|---|---|
| long | folderId | The id of the folder. |
| string | folderName | The new name of the folder. |
| Dictionary<string, object> | config | Contains any additional control configurations. Can be null. |
RenameGroup(long, string, Dictionary<string, object>)
Rename a specified group.
Declaration
public void RenameGroup(long groupId, string groupName, Dictionary<string, object> config)Parameters
| Type | Name | Description |
|---|---|---|
| long | groupId | The id of the group. |
| string | groupName | The new name of the group. |
| Dictionary<string, object> | config | Contains any additional control configurations. Can be null. |
RestoreTrashView(long, Dictionary<string, object>)
Restore the specified view from trash.
Declaration
public void RestoreTrashView(long viewId, Dictionary<string, object> config)Parameters
| Type | Name | Description |
|---|---|---|
| long | viewId | Id of the view. |
| Dictionary<string, object> | config | Contains any additional control configurations. Can be null. |
ShareViews(List<long>, List<string>, Dictionary<string, bool>, Dictionary<string, object>)
Share views to the specified users.
Declaration
public void ShareViews(List<long> viewIds, List<string> emailIds, Dictionary<string, bool> permissions, Dictionary<string, object> config)Parameters
| Type | Name | Description |
|---|---|---|
| List<long> | viewIds | View ids which to be shared. |
| List<string> | emailIds | The email address of the users to whom the views need to be shared. |
| Dictionary<string, bool> | permissions | Contains permission details. |
| Dictionary<string, object> | config | Contains any additional control configurations. Can be null. |
SyncData(long, Dictionary<string, object>)
Initiate data sync for the specified datasource.
Declaration
public void SyncData(long datasourceId, Dictionary<string, object> config)Parameters
| Type | Name | Description |
|---|---|---|
| long | datasourceId | Id of the datasource. |
| Dictionary<string, object> | config | Contains any additional control configurations. Can be null. |
TriggerEmailSchedule(long)
Trigger configured email schedules instantly.
Declaration
public void TriggerEmailSchedule(long scheduleId)Parameters
| Type | Name | Description |
|---|---|---|
| long | scheduleId | Id for the email schedule. |
UpdateDatasourceConnection(long, Dictionary<string, object>)
Update connection details for the specified datasource.
Declaration
public void UpdateDatasourceConnection(long datasourceId, Dictionary<string, object> config)Parameters
| Type | Name | Description |
|---|---|---|
| long | datasourceId | Id of the datasource. |
| Dictionary<string, object> | config | Contains the control configurations. |
UpdateEmailSchedule(long, Dictionary<string, object>)
Update configurations of the specified email schedule in the workspace.
Declaration
public long UpdateEmailSchedule(long scheduleId, Dictionary<string, object> config)Parameters
| Type | Name | Description |
|---|---|---|
| long | scheduleId | Id for the email schedule. |
| Dictionary<string, object> | config | Contains the control configurations. |
Returns
| Type | Description |
|---|---|
| long | Updated schedule id. |
UpdateReport(long, Dictionary<string, object>)
Update the design and configuration of the specified report.
Declaration
public void UpdateReport(long viewId, Dictionary<string, object> config)Parameters
| Type | Name | Description |
|---|---|---|
| long | viewId | Id for the view. |
| Dictionary<string, object> | config | Contains the control configurations. |
UpdateSlideshow(long, Dictionary<string, object>)
Update details of the specified slideshow.
Declaration
public void UpdateSlideshow(long slideId, Dictionary<string, object> config)Parameters
| Type | Name | Description |
|---|---|---|
| long | slideId | The id of the slideshow. |
| Dictionary<string, object> | config | Contains any additional control configurations. Can be null. |
UpdateVariable(long, string, int, int, Dictionary<string, object>)
Update details of the specified variable in the workspace.
Declaration
public void UpdateVariable(long variableId, string variableName, int variableDataType, int variableType, Dictionary<string, object> config)Parameters
| Type | Name | Description |
|---|---|---|
| long | variableId | Id for the variable. |
| string | variableName | New name for the variable. |
| int | variableDataType | New datatype for the variable. |
| int | variableType | New type for the variable. |
| Dictionary<string, object> | config | Contains the control configurations. |