WorkspaceAPI

var org       = ac.getOrgInstance(orgId);
var workspace = ac.getWorkspaceInstance(orgId, workspaceId);
var view      = ac.getViewInstance(orgId, workspaceId, viewId);
var bulk      = ac.getBulkInstance(orgId, workspaceId);

WorkspaceAPI exposes 117 methods. Method names are camelCase and identifiers are string.

Methods#

addAdmins, addDefault, addFavorite, addGroupMembers, addTagToViews, addWorkspaceUsers, automlAnalysisPrediction, backupWorkspaceNow, changeAlertStatus, changeEmailScheduleStatus, changeFolderHierarchy, changeFolderPosition, changeWorkspaceUserRole, changeWorkspaceUserStatus, copy, copyViews, createAutomlAnalysis, createAutomlAnalysisDeployment, createDashboard, createEmailSchedule, createFolder, createGroup, createQueryTable, createReport, createSlideshow, createTable, createTag, createVariable, delete, deleteAlerts, deleteAutomlAnalysis, deleteAutomlAnalysisDeployment, deleteAutomlAnalysisModel, deleteEmailSchedule, deleteFolder, deleteGroup, deleteSlideshow, deleteTag, deleteTrashView, deleteVariable, deployAutomlAnalysis, disableDomainAccess, downloadWorkspaceBackup, editQueryTable, enableDomainAccess, exportAsTemplate, getAdmins, getAggregateFormulaDependents, getAggregateFormulas, getAggregateFormulaValue, getAlertConfiguration, getAlertEvents, getAlertsInWorkspace, getAutomlAnalysis, getAutomlAnalysisDetails, getDashboardMetadata, getDatasources, getDeploymentDetails, getEmailSchedules, getFolders, getGroupDetails, getGroups, getLinkableWorkspaces, getLinkedWorkspaces, getLinkedWorkspaceSyncDetails, getQueryTableDetails, getQueryTables, getReportMetadata, getSecretKey, getSharedDetailsForViews, getShareInfo, getSlideshowDetails, getSlideshows, getSlideshowUrl, getTaggedViews, getTags, getTrashViews, getVariableDetails, getVariables, getViews, getWorkspaceAccessRestrictions, getWorkspaceBackups, getWorkspaceBackupStatus, getWorkspaceDetails, getWorkspaceLinkingCompatibility, getWorkspaceRestoreStatus, getWorkspaceUsers, linkWorkspaces, makeDefaultFolder, moveViewsToFolder, removeAdmins, removeDefault, removeFavorite, removeGroupMembers, removeShare, removeTagFromViews, removeWorkspaceUsers, rename, renameFolder, renameGroup, restoreTrashView, restoreWorkspaceFromBackup, runAlert, shareViews, syncData, syncLinkedWorkspaces, triggerEmailSchedule, unlinkWorkspaces, updateAlert, updateDashboard, updateDatasourceConnection, updateEmailSchedule, updateReport, updateSlideshow, updateTag, updateVariable, updateWorkspaceAccessRestrictions

addAdmins#

addAdmins(emailIds, config={})

Add admins for the specified workspace.

Raises — Error

addDefault#

addDefault(config={})

Adds a specified workspace as default.

Raises — Error

addFavorite#

addFavorite(config={})

Adds a specified workspace as favorite.

Raises — Error

addGroupMembers#

addGroupMembers(groupId, emailIds, config={})

Add users to the specified group.

Raises — Error

addTagToViews#

addTagToViews(tagId, viewIds, config={})

Adds the specified tag to multiple views in the workspace.

Raises — Error

addWorkspaceUsers#

addWorkspaceUsers(emailIds, role, config={})

Add users to the specified workspace.

Raises — Error

automlAnalysisPrediction#

automlAnalysisPrediction(analysisId, modelId, features, config = {})

Get predictions by providing sample input values for a trained model.

Returns — Prediction result.

Raises — Error

backupWorkspaceNow#

backupWorkspaceNow(config={})

Trigger an instant backup for the specified workspace.

Returns — Triggered backup details.

Raises — Error

changeAlertStatus#

changeAlertStatus(alertIds, enabled, config={})

Enable or disable the specified data alerts in the workspace.

Raises — Error

changeEmailScheduleStatus#

changeEmailScheduleStatus(scheduleId, operation)

Update email schedule status.

Raises — Error

changeFolderHierarchy#

changeFolderHierarchy(folderId, hierarchy, config={})

Swaps the hierarchy of a parent folder and a subfolder.

Raises — Error

changeFolderPosition#

changeFolderPosition(folderId, referenceFolderId, config={})

Place the folder above the reference folder.

Raises — Error

changeWorkspaceUserRole#

changeWorkspaceUserRole(emailIds, role, config={})

Change role for the specified users.

Raises — Error

changeWorkspaceUserStatus#

changeWorkspaceUserStatus(emailIds, operation, config={})

Change users staus in the specified workspace.

Raises — Error

copy#

copy(workspaceName, config={}, destOrgId=null)

Copy the specified workspace from one organization to another or within the organization.

Returns — Copied workspace id.

Raises — Error

copyViews#

copyViews(viewIds, destWorkspaceId, config={}, destOrgId=null)

Copy the specified views from one workspace to another workspace.

Returns — View list.

Raises — Error

createAutomlAnalysis#

createAutomlAnalysis(name, trainingTableId, predictionType, features, serverOption, algorithms, config = {})

Create a new AutoML analysis within the provided workspace.

Returns — Created AutoML Analysis Id.

Raises — Error

createAutomlAnalysisDeployment#

createAutomlAnalysisDeployment(analysisId, modelId, inputTableId, outputTable, outputColumns, predictionColumn, serverOption, importType, scheduleDetails, config = {})

Deploy the AutoML analysis model.

Returns — Created AutoML Deployment details.

Raises — Error

createDashboard#

createDashboard(displayName, layout, config={})

Create a dashboard in the specified workspace.

Returns — Created dashboard id.

Raises — Error

createEmailSchedule#

createEmailSchedule(scheduleName, viewIds, format, emailIds, scheduleDetails, config={})

Create an email schedule in the specified workspace.

Returns — Created email schedule id.

Raises — Error

createFolder#

createFolder(folderName, config={})

Create a folder in the specified workspace.

Returns — Created folder id.

Raises — Error

createGroup#

createGroup(groupName, emailIds, config={})

Create a group in the specified workspace.

Returns — Created group id.

Raises — Error

createQueryTable#

createQueryTable(sqlQuery, queryTableName, config={})

Create a new query table in the workspace.

Returns — Id of the created query table.

Raises — Error

createReport#

createReport(config={})

Create a report in the specified workspace.

Returns — Id of the created view.

Raises — Error

createSlideshow#

createSlideshow(slideName, viewIds, config={})

Create a slideshow in the specified workspace.

Returns — Id of the created slideshow.

Raises — Error

createTable#

createTable(tableDesign, config={})

Create a table in the specified workspace.

Returns — created table id.

Raises — Error

createTag#

createTag(tagName, colorCode, config={})

Create a tag in the specified workspace.

Returns — Created tag id.

Raises — Error

createVariable#

createVariable(variableName, variableDataType, variableType, config={})

Create a variable in the workspace.

Returns — Id of the created variable.

Raises — Error

delete#

delete(config={})

Delete a specified workspace in the organization.

Raises — Error

deleteAlerts#

deleteAlerts(alertIds, config={})

Delete the specified data alerts from the workspace.

Raises — Error

deleteAutomlAnalysis#

deleteAutomlAnalysis(analysisId, config = {})

Delete a specified automl analysis from the given workspace.

Raises — Error

deleteAutomlAnalysisDeployment#

deleteAutomlAnalysisDeployment(analysisId, deploymentId, config = {})

Delete the AutoML analysis deployment.

Raises — Error

deleteAutomlAnalysisModel#

deleteAutomlAnalysisModel(analysisId, modelId, config = {})

Delete a specified model available in the given automl analysis.

Raises — Error

deleteEmailSchedule#

deleteEmailSchedule(scheduleId)

Delete the specified email schedule in the workspace.

Raises — Error

deleteFolder#

deleteFolder(folderId)

Delete a specified folder in the workspace.

Raises — Error

deleteGroup#

deleteGroup(groupId)

Delete a specified group.

Raises — Error

deleteSlideshow#

deleteSlideshow(slideId)

Delete a specified slideshow in the workspace.

Raises — Error

deleteTag#

deleteTag(tagId)

Delete the specified tag from the workspace.

Raises — Error

deleteTrashView#

deleteTrashView(viewId, config={})

Delete the specified view permanently from trash.

Raises — Error

deleteVariable#

deleteVariable(variableId)

Delete a specified variable in the workspace.

Raises — Error

deployAutomlAnalysis#

deployAutomlAnalysis(analysisId, deploymentId, config = {})

Execute the AutoML analysis deployment.

Raises — Error

disableDomainAccess#

disableDomainAccess()

Disable workspace from the specified white label domain.

Raises — Error

downloadWorkspaceBackup#

downloadWorkspaceBackup(backupId, filePath, config={})

Download the specified workspace backup.

Raises — Error

editQueryTable#

editQueryTable(viewId, sqlQuery, config={})

Update the mentioned query table in the workspace.

Raises — Error

enableDomainAccess#

enableDomainAccess()

Enable workspace to the specified white label domain.

Raises — Error

exportAsTemplate#

exportAsTemplate(viewIds, filePath, config={})

Export the mentioned views as templates.

Raises — Error

getAdmins#

getAdmins(config={})

Returns list of admins for the specified workspace.

Returns — Workspace admin list.

Raises — Error

getAggregateFormulaDependents#

getAggregateFormulaDependents(formulaId)

Returns list of all dependent views and formulas for the specified aggregate formula.

Returns — Dependent details.

Raises — Error

getAggregateFormulas#

getAggregateFormulas(config={})

Returns list of all aggregate formulas for the specified workspace.

Returns — Aggregate formula list.

Raises — Error

getAggregateFormulaValue#

getAggregateFormulaValue(formulaId)

Returns the value of the aggregate formula.

Returns — Aggregate formula value.

Raises — Error

getAlertConfiguration#

getAlertConfiguration(alertId)

Returns the configuration of the specified data alert.

Returns — Data alert configuration.

Raises — Error

getAlertEvents#

getAlertEvents(alertId, config={})

Returns the execution events of the specified data alert.

Returns — Data alert events along with the page details.

Raises — Error

getAlertsInWorkspace#

getAlertsInWorkspace()

Returns list of data alerts available in the specified workspace.

Returns — Data alerts list.

Raises — Error

getAutomlAnalysis#

getAutomlAnalysis()

Returns list of automl analysis for the specified workspace.

Returns — AutoML analysis list.

Raises — Error

getAutomlAnalysisDetails#

getAutomlAnalysisDetails(analysisId)

Retrieve detailed information for a specific AutoML analysis.

Returns — AutoML analysis details.

Raises — Error

getDashboardMetadata#

getDashboardMetadata(dashboardId, config={})

Returns the metadata of the specified dashboard.

Returns — Dashboard configuration.

Raises — Error

getDatasources#

getDatasources()

Returns list of datasources for the specified workspace.

Returns — Datasource list.

Raises — Error

getDeploymentDetails#

getDeploymentDetails(analysisId, modelId)

Returns deployment details available for a AutoML analysis model.

Returns — AutoML analysis deployment details.

Raises — Error

getEmailSchedules#

getEmailSchedules()

Returns list of email schedules available in the specified workspace.

Returns — List of email schedules.

Raises — Error

getFolders#

getFolders()

Returns list of all accessible folders for the specified workspace.

Returns — Folder list.

Raises — Error

getGroupDetails#

getGroupDetails(groupId)

Get the details of the specified group.

Returns — Details of the specified group.

Raises — Error

getGroups#

getGroups()

Returns list of groups for the specified workspace.

Returns — Group list.

Raises — Error

getLinkableWorkspaces#

getLinkableWorkspaces()

Returns list of organizations and workspaces that can be linked to the specified master workspace.

Returns — Organizations with their linkable workspaces.

Raises — Error

getLinkedWorkspaces#

getLinkedWorkspaces()

Returns list of workspaces linked to the specified master workspace.

Returns — Linked workspaces list.

Raises — Error

getLinkedWorkspaceSyncDetails#

getLinkedWorkspaceSyncDetails(sandboxIds, config={})

Returns the sync details of the specified linked workspaces.

Returns — Linked workspace sync details.

Raises — Error

getQueryTableDetails#

getQueryTableDetails(queryTableId)

Returns details of the specified query table.

Returns — View details.

Raises — Error

getQueryTables#

getQueryTables(config={})

Returns list of all query tables for the specified workspace.

Returns — Query table list.

Raises — Error

getReportMetadata#

getReportMetadata(viewId)

Returns the metadata of the specified report.

Returns — Report configuration.

Raises — Error

getSecretKey#

getSecretKey(config={})

Returns the secret key of the specified workspace.

Returns — Workspace secret key.

Raises — Error

getSharedDetailsForViews#

getSharedDetailsForViews(viewIds)

Returns shared details of the specified views.

Returns — Folder list.

Raises — Error

getShareInfo#

getShareInfo()

Returns shared details of the specified workspace.

Returns — Workspace share info.

Raises — Error

getSlideshowDetails#

getSlideshowDetails(slideId)

Returns details of the specified slideshow.

Returns — Slideshow details.

Raises — Error

getSlideshows#

getSlideshows()

Returns list of slideshows for the specified workspace.

Returns — Slideshow list.

Raises — Error

getSlideshowUrl#

getSlideshowUrl(slideId, config={})

Returns slide URL to access the specified slideshow.

Returns — Slideshow URL.

Raises — Error

getTaggedViews#

getTaggedViews(tagId)

Returns list of views associated with the specified tag.

Returns — Tagged views list.

Raises — Error

getTags#

getTags()

Returns list of all tags for the specified workspace.

Returns — Tags list.

Raises — Error

getTrashViews#

getTrashViews()

Returns list of all views available in trash for the specified workspace.

Returns — Trash view list.

Raises — Error

getVariableDetails#

getVariableDetails(variableId)

Returns details of the specified variable.

Returns — Variable details.

Raises — Error

getVariables#

getVariables()

Returns list of variables for the specified workspace.

Returns — Variable list.

Raises — Error

getViews#

getViews(config={})

Returns list of all accessible views for the specified workspace.

Returns — View list.

Raises — Error

getWorkspaceAccessRestrictions#

getWorkspaceAccessRestrictions()

Returns the access restriction settings configured for the specified workspace.

Returns — Workspace access restriction settings.

Raises — Error

getWorkspaceBackups#

getWorkspaceBackups()

Returns the backup configuration and the list of backups available for the specified workspace.

Returns — Workspace backup details.

Raises — Error

getWorkspaceBackupStatus#

getWorkspaceBackupStatus(backupId)

Returns the status of the specified workspace backup.

Returns — Backup status details.

Raises — Error

getWorkspaceDetails#

getWorkspaceDetails(config={})

Returns details of the specified workspace.

Returns — Workspace details.

Raises — Error

getWorkspaceLinkingCompatibility#

getWorkspaceLinkingCompatibility(clients, config={})

Returns the linking compatibility details for the specified client workspaces.

Returns — Client workspace compatibility details.

Raises — Error

getWorkspaceRestoreStatus#

getWorkspaceRestoreStatus(restoreId)

Returns the status of the specified workspace restore.

Returns — Restore status details.

Raises — Error

getWorkspaceUsers#

getWorkspaceUsers()

Returns list of users for the specified workspace.

Returns — User list.

Raises — Error

linkWorkspaces#

linkWorkspaces(clients, config={})

Link the specified client workspaces to the master workspace.

Raises — Error

makeDefaultFolder#

makeDefaultFolder(folderId)

Make the specified folder as default.

Raises — Error

moveViewsToFolder#

moveViewsToFolder(folderId, viewIds, config={})

Move views to the mentioned folder.

Raises — Error

removeAdmins#

removeAdmins(emailIds, config={})

Remove admins from the specified workspace.

Raises — Error

removeDefault#

removeDefault(config={})

Remove a specified workspace from default.

Raises — Error

removeFavorite#

removeFavorite(config={})

Remove a specified workspace from favorite.

Raises — Error

removeGroupMembers#

removeGroupMembers(groupId, emailIds, config={})

Remove users from the specified group.

Raises — Error

removeShare#

removeShare(viewIds, emailIds, config={})

Remove shared views for the specified users.

Raises — Error

removeTagFromViews#

removeTagFromViews(tagId, viewIds=null, dissociateAll=false, config={})

Removes the specified tag from multiple views in the workspace.

Raises — Error

removeWorkspaceUsers#

removeWorkspaceUsers(emailIds, config={})

Remove users from the specified workspace.

Raises — Error

rename#

rename(workspaceName, config={})

Rename a specified workspace in the organization.

Raises — Error

renameFolder#

renameFolder(folderId, newFolderName, config={})

Rename a specified folder in the workspace.

Raises — Error

renameGroup#

renameGroup(groupId, newGroupName, config={})

Rename a specified group.

Raises — Error

restoreTrashView#

restoreTrashView(viewId, config={})

Restore the specified view from trash.

Raises — Error

restoreWorkspaceFromBackup#

restoreWorkspaceFromBackup(backupId, confirmRestore, config={})

Restore the specified workspace from the given backup.

Returns — Triggered restore details.

Raises — Error

runAlert#

runAlert(alertId, config={})

Execute the specified data alert immediately.

Raises — Error

shareViews#

shareViews(viewIds, emailIds, permissions, config={})

Share views to the specified users.

Raises — Error

syncData#

syncData(datasourceId, config={})

Initiate data sync for the specified datasource.

Raises — Error

syncLinkedWorkspaces#

syncLinkedWorkspaces(scope, config={})

Sync the metadata of the master workspace to its linked client workspaces.

Raises — Error

triggerEmailSchedule#

triggerEmailSchedule(scheduleId)

Trigger configured email schedules instantly.

Raises — Error

unlinkWorkspaces#

unlinkWorkspaces(scope, config={})

Unlink the client workspaces from the specified master workspace.

Raises — Error

updateAlert#

updateAlert(alertId, alertName, scheduleDetails, rules, config={})

Update the specified data alert in the workspace.

Raises — Error

updateDashboard#

updateDashboard(dashboardId, config={})

Update the specified dashboard in the workspace.

Raises — Error

updateDatasourceConnection#

updateDatasourceConnection(datasourceId, config={})

Update connection details for the specified datasource.

Raises — Error

updateEmailSchedule#

updateEmailSchedule(scheduleId, config)

Update configurations of the specified email schedule in the workspace.

Returns — Updated email schedule id.

Raises — Error

updateReport#

updateReport(viewId, config={})

Update the design and configuration of the specified report.

Raises — Error

updateSlideshow#

updateSlideshow(slideId, config={})

Update details of the specified slideshow.

Raises — Error

updateTag#

updateTag(tagId, config={})

Update details of the specified tag in the workspace.

Raises — Error

updateVariable#

updateVariable(variableId, variableName, variableDataType, variableType, config={})

Update details of the specified variable in the workspace.

Raises — Error

updateWorkspaceAccessRestrictions#

updateWorkspaceAccessRestrictions(config={})

Update the access restriction settings of the specified workspace.

Raises — Error

Related#

• Errors — the failure envelope and codes worth branching on.
• Limits — throttles and quotas that apply to these calls.