ZohoAnalytics

Methods

activateUsers(emailIds, config)

Activate users in the specified organization.
Parameters:
Name Type Default Description
emailIds JSONArray The email address of the users to be activated.
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error

addAdmins(emailIds, config)

Add admins for the specified workspace.
Parameters:
Name Type Default Description
emailIds JSONArray The email address of the admin users to be added.
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error

addAggregateFormula(formulaName, expression, config) → {String}

Add a aggregate formula in the specified table.
Parameters:
Name Type Default Description
formulaName String Name of the aggregate formula to be created.
expression String Formula expression.
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Created aggregate formula id.
Type
String

addColumn(columnName, dataType, config) → {String}

Add a column in the specified table.
Parameters:
Name Type Default Description
columnName String The name of the column.
dataType String The data-type of the column.
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Created column id.
Type
String

addDefault()

Adds a specified workspace as default.
Source:
Throws:
If the request failed due to some error.
Type
Error

addFavorite()

Adds a specified workspace as favorite.
Source:
Throws:
If the request failed due to some error.
Type
Error

addFavorite()

Adds a specified view as favorite.
Source:
Throws:
If the request failed due to some error.
Type
Error

addFormulaColumn(formulaName, expression, config) → {String}

Add a formula column in the specified table.
Parameters:
Name Type Default Description
formulaName String Name of the formula column to be created.
expression String Formula expression.
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Created formula column id.
Type
String

addGroupMembers(groupId, emailIds, config)

Add users to the specified group.
Parameters:
Name Type Default Description
groupId String Id of the group.
emailIds JSONArray The email address of the users to be added to the group.
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error

addLookup(columnId, refViewId, refColumnId, config)

Add a lookup in the specified child table.
Parameters:
Name Type Default Description
columnId String Id of the column.
refViewId String The id of the table contains the parent column.
refColumnId String The id of the parent column.
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error

addRow(columnValues, config) → {Object}

Add a single row in the specified table.
Parameters:
Name Type Default Description
columnValues Object Contains the values for the row. The column names are the key.
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Column Names and Added Row Values.
Type
Object

addUsers(emailIds, config)

Add users to the specified organization.
Parameters:
Name Type Default Description
emailIds JSONArray The email address of the users to be added.
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error

addWorkspaceUsers(emailIds, role, config)

Add users to the specified workspace.
Parameters:
Name Type Default Description
emailIds JSONArray The email address of the users to be added.
role String Role for the users to be added.
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error

autoAnalyse(config)

Auto generate reports for the specified table.
Parameters:
Name Type Default Description
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error

autoAnalyseColumn(columnId, config)

Auto generate reports for the specified column.
Parameters:
Name Type Default Description
columnId String Id of the column.
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error

changeEmailScheduleStatus(scheduleId, operation)

Update email schedule status.
Parameters:
Name Type Description
scheduleId String Id for the email schedule.
operation String New status for the schedule ( Values - activate | deactivate )
Source:
Throws:
If the request failed due to some error.
Type
Error

changeFolderHierarchy(folderId, hierarchy, config)

Swaps the hierarchy of a parent folder and a subfolder.
Parameters:
Name Type Default Description
folderId String Id of the folder.
hierarchy Number New hierarchy for the folder. (0 - Parent; 1 - Child).
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error

changeFolderPosition(folderId, referenceFolderId, config)

Place the folder above the reference folder.
Parameters:
Name Type Default Description
folderId String Id of the folder.
referenceFolderId String Id of the reference folder.
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error

changeUserRole(emailIds, role, config)

Change role for the specified users.
Parameters:
Name Type Default Description
emailIds JSONArray The email address of the users.
role String New role for the users.
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error

changeWorkspaceUserRole(emailIds, role, config)

Change role for the specified users.
Parameters:
Name Type Default Description
emailIds JSONArray The email address of the users.
role String New role for the users.
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error

changeWorkspaceUserStatus(emailIds, operation, config)

Change users staus in the specified workspace.
Parameters:
Name Type Default Description
emailIds JSONArray The email address of the users.
operation String New status for the users ( Values - activate | deactivate )
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error

copy(workspaceName, config, destOrgId) → {String}

Copy the specified workspace from one organization to another or within the organization.
Parameters:
Name Type Default Description
workspaceName String Name of the new workspace.
config Object {} Contains any additional control attributes.
destOrgId String null Id of the organization where the destination workspace is present.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Copied workspace id.
Type
String

copyFormulas(formulaNames, destWorkspaceId, config, destOrgId)

Copy the specified formulas from one table to another within the workspace or across workspaces.
Parameters:
Name Type Default Description
formulaNames JSONArray The name of the formula columns to be copied.
destWorkspaceId String The ID of the destination workspace.
config Object {} Contains any additional control attributes.
destOrgId String null Id of the organization where the destination workspace is present.
Source:
Throws:
If the request failed due to some error.
Type
Error

copyViews(viewIds, destWorkspaceId, config, destOrgId) → {JSONArray}

Copy the specified views from one workspace to another workspace.
Parameters:
Name Type Default Description
viewIds JSONArray The id of the views to be copied.
destWorkspaceId String The destination workspace id.
config Object {} Contains any additional control attributes.
destOrgId String null Id of the organization where the destination workspace is present.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
View list.
Type
JSONArray

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

Create an email schedule in the specified workspace.
Parameters:
Name Type Default Description
scheduleName String Name of the email schedule.
viewIds JSONArray View ids to be mailed.
format String The format in which the data has to be mailed.
emailIds JSONArray The recipients' email addresses for sending views.
scheduleDetails Object Contains schedule frequency, date, and time info.
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Created email schedule id.
Type
String

createFolder(folderName, config) → {String}

Create a folder in the specified workspace.
Parameters:
Name Type Default Description
folderName String Name of the folder to be created.
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Created folder id.
Type
String

createGroup(groupName, emailIds, config) → {String}

Create a group in the specified workspace.
Parameters:
Name Type Default Description
groupName String Name of the group.
emailIds JSONArray The email address of the users to be added to the group.
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Created group id.
Type
String

createPrivateUrl(config) → {String}

Create a private URL for the specified view.
Parameters:
Name Type Default Description
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Private URL.
Type
String

createQueryTable(sqlQuery, queryTableName, config) → {String}

Create a new query table in the workspace.
Parameters:
Name Type Default Description
sqlQuery String SQL query to construct the query table.
queryTableName String Name of the query table to be created.
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Id of the created query table.
Type
String

createSimilarViews(refViewId, folderId, config)

Create reports for the specified table based on the reference table.
Parameters:
Name Type Default Description
refViewId String The ID of the reference view.
folderId String The folder id where the views to be saved.
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error

createSlideshow(slideName, viewIds, config) → {String}

Create a slideshow in the specified workspace.
Parameters:
Name Type Default Description
slideName String Name of the slideshow to be created.
viewIds JSONArray Ids of the view to be included in the slideshow.
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Id of the created slideshow.
Type
String

createTable(tableDesign, config) → {String}

Create a table in the specified workspace.
Parameters:
Name Type Default Description
tableDesign Object Table structure.
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
created table id.
Type
String

createVariable(variableName, variableName, variableName, config) → {String}

Create a variable in the workspace.
Parameters:
Name Type Default Description
variableName String Name of the variable to be created.
variableName Number Datatype of the variable to be created.
variableName Number Type of the variable to be created.
config Object {} Contains the control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Id of the created variable.
Type
String

createWorkspace(workspaceName, config) → {String}

Create a blank workspace in the specified organization.
Parameters:
Name Type Default Description
workspaceName String Name of the workspace.
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Created workspace id.
Type
String

deActivateUsers(emailIds, config)

Deactivate users in the specified organization.
Parameters:
Name Type Default Description
emailIds JSONArray The email address of the users to be deactivated.
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error

delete(config)

Delete a specified workspace in the organization.
Parameters:
Name Type Default Description
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error

delete(config)

Delete a specified view in the workspace.
Parameters:
Name Type Default Description
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error

deleteAggregateFormula(formulaId, config)

Delete the specified aggregate formula.
Parameters:
Name Type Default Description
formulaId String Id of the aggregate formula to be deleted.
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error

deleteColumn(columnId, config)

Delete a specified column in the table.
Parameters:
Name Type Default Description
columnId String Id of the column.
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error

deleteEmailSchedule(scheduleId)

Delete the specified email schedule in the workspace.
Parameters:
Name Type Description
scheduleId String Id for the email schedule.
Source:
Throws:
If the request failed due to some error.
Type
Error

deleteFolder(folderId)

Delete a specified folder in the workspace.
Parameters:
Name Type Description
folderId String Id of the folder to be deleted.
Source:
Throws:
If the request failed due to some error.
Type
Error

deleteFormulaColumn(formulaId, config)

Delete the specified formula column.
Parameters:
Name Type Default Description
formulaId String Id of the formula column to be deleted.
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error

deleteGroup(groupId)

Delete a specified group.
Parameters:
Name Type Description
groupId String The id of the group.
Source:
Throws:
If the request failed due to some error.
Type
Error

deleteRow(criteria, config) → {int}

Delete rows in the specified table.
Parameters:
Name Type Default Description
criteria String The criteria to be applied for deleting data. Only rows matching the criteria will be deleted. Should be null for delete all rows.
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Deleted rows count.
Type
int

deleteSlideshow(slideId)

Delete a specified slideshow in the workspace.
Parameters:
Name Type Description
slideId String Id of the slideshow.
Source:
Throws:
If the request failed due to some error.
Type
Error

deleteTrashView(viewId, config)

Delete the specified view permanently from trash.
Parameters:
Name Type Default Description
viewId String Id of the view.
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error

deleteVariable(variableId)

Delete a specified variable in the workspace.
Parameters:
Name Type Description
variableId String Id of the variable.
Source:
Throws:
If the request failed due to some error.
Type
Error

disableDomainAccess()

Disable workspace from the specified white label domain.
Source:
Throws:
If the request failed due to some error.
Type
Error

editAggregateFormula(formulaId, expression, config)

Edit the specified aggregate formula.
Parameters:
Name Type Default Description
formulaId String Id of the aggregate formula to be updated.
expression String Formula expression.
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error

editFormulaColumn(formulaId, expression, config)

Edit the specified formula column.
Parameters:
Name Type Default Description
formulaId String Id of the formula column to be updated.
expression String Formula expression.
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error

editQueryTable(viewId, sqlQuery, config)

Update the mentioned query table in the workspace.
Parameters:
Name Type Default Description
viewId String Id of the query table to be updated.
sqlQuery String New SQL query to be updated.
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error

enableDomainAccess()

Enable workspace to the specified white label domain.
Source:
Throws:
If the request failed due to some error.
Type
Error

exportAsTemplate(viewIds, filePath, config)

Export the mentioned views as templates.
Parameters:
Name Type Default Description
viewIds JSONArray Ids of the view to be exported.
filePath String Path of the file where the data exported to be stored. ( Should be in 'atpt' format )
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error

exportBulkData(jobId, filePath)

Download the exported data for the mentioned job id.
Parameters:
Name Type Description
jobId String Id of the job to be exported.
filePath String Path of the file where the data exported to be stored.
Source:
Throws:
If the request failed due to some error.
Type
Error

exportData(viewId, responseFormat, filePath, config)

Export the mentioned table (or) view data.
Parameters:
Name Type Default Description
viewId String Id of the view to be exported.
responseFormat String The format in which the data is to be exported.
filePath String Path of the file where the data exported to be stored.
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error

getAdmins(config) → {JSONArray}

Returns list of admins for a specified organization.
Parameters:
Name Type Default Description
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Organization admin list.
Type
JSONArray

getAdmins() → {JSONArray}

Returns list of admins for the specified workspace.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Workspace admin list.
Type
JSONArray

getAggregateFormulas() → {JSONArray}

Returns list of all aggregate formulas for the specified table.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Aggregate formula list.
Type
JSONArray

getBulkInstance(orgId, workspaceId)

Returns a new BulkAPI instance.
Parameters:
Name Type Description
orgId String The ID of the organization.
workspaceId String The ID of the workspace.
Source:

getColumnDependents(columnId) → {JSONObject}

Returns list of dependents views and formulas for the specified column.
Parameters:
Name Type Description
columnId String Id of the column.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Dependent details.
Type
JSONObject

getDashboards() → {JSONArray}

Returns list of all accessible dashboards.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Dashboard list.
Type
JSONArray

getDatasources() → {JSONArray}

Returns list of datasources for the specified workspace.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Datasource list.
Type
JSONArray

getEmailSchedules() → {JSONArray}

Returns list of email schedules available in the specified workspace.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
List of email schedules.
Type
JSONArray

getEmbedUrl(config) → {String}

Returns embed URL to access the specified view.
Parameters:
Name Type Default Description
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Embed URL.
Type
String

getExportJobDetails(jobId) → {JSONObject}

Returns the details of the export job.
Parameters:
Name Type Description
jobId String Id of the export job.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Export job details.
Type
JSONObject

getFolders() → {JSONArray}

Returns list of all accessible folders for the specified workspace.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Folder list.
Type
JSONArray

getFormulaColumns() → {JSONArray}

Returns list of all formula columns for the specified table.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Formula column list.
Type
JSONArray

getGroupDetails(groupId) → {Object}

Get the details of the specified group.
Parameters:
Name Type Description
groupId String Id of the group.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Details of the specified group.
Type
Object

getGroups() → {JSONArray}

Returns list of groups for the specified workspace.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Group list.
Type
JSONArray

getImportJobDetails(jobId) → {JSONObject}

Returns the details of the import job.
Parameters:
Name Type Description
jobId String Id of the job.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Import job details.
Type
JSONObject

getLastImportDetails() → {int}

Returns last import details of the specified view.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Last import details.
Type
int

getMetaDetails(workspaceName, viewName, config) → {Object}

Returns details of the specified workspace/view.
Parameters:
Name Type Default Description
workspaceName String Name of the workspace.
viewName String Name of the view. Can be null.
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Workspace (or) View meta details.
Type
Object

getOrgInstance(orgId)

Returns a new OrgAPI instance.
Parameters:
Name Type Description
orgId String The ID of the organization.
Source:

getOrgs() → {JSONArray}

Returns list of all accessible organizations.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Organization list.
Type
JSONArray

getOwnedDashboards() → {JSONArray}

Returns list of owned dashboards.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Dashboard list.
Type
JSONArray

getOwnedWorkspaces() → {JSONArray}

Returns list of owned workspaces.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Workspace list.
Type
JSONArray

getPrivateUrl(config) → {String}

Returns private URL to access the specified view.
Parameters:
Name Type Default Description
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Private URL.
Type
String

getPublishConfigurations() → {Object}

Returns publish configurations for the specified view.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Publish details.
Type
Object

getRecentViews() → {JSONArray}

Returns list of recently accessed views.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
View list.
Type
JSONArray

getResourceDetails() → {Object}

Returns resource usage details of the specified organization.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Resource details.
Type
Object

getSecretKey(config) → {String}

Returns the secret key of the specified workspace.
Parameters:
Name Type Default Description
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Workspace secret key.
Type
String

getShareInfo() → {Object}

Returns shared details of the specified workspace.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Workspace share info.
Type
Object

getSharedDashboards() → {JSONArray}

Returns list of shared dashboards.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Dashboard list.
Type
JSONArray

getSharedDetailsForViews(viewIds) → {JSONArray}

Returns shared details of the specified views.
Parameters:
Name Type Description
viewIds JSONArray The id of the views to be copied.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Folder list.
Type
JSONArray

getSharedWorkspaces() → {JSONArray}

Returns list of shared workspaces.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Workspace list.
Type
JSONArray

getSlideshowDetails(slideId) → {Object}

Returns details of the specified slideshow.
Parameters:
Name Type Description
slideId String Id of the slideshow.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Slideshow details.
Type
Object

getSlideshowUrl(slideId, config) → {String}

Returns slide URL to access the specified slideshow.
Parameters:
Name Type Default Description
slideId String Id of the slideshow.
config Object {} Contains the control configurations
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Slideshow URL.
Type
String

getSlideshows() → {JSONArray}

Returns list of slideshows for the specified workspace.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Slideshow list.
Type
JSONArray

getSubscriptionDetails() → {Object}

Returns subscription details of the specified organization.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Subscription details.
Type
Object

getTrashViews() → {JSONArray}

Returns list of all views available in trash for the specified workspace.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Trash view list.
Type
JSONArray

getUsers() → {JSONArray}

Returns list of users for the specified organization.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
User list.
Type
JSONArray

getVariableDetails(variableId) → {Object}

Returns details of the specified variable.
Parameters:
Name Type Description
variableId String Id of the variable.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Variable details.
Type
Object

getVariables() → {JSONArray}

Returns list of variables for the specified workspace.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Variable list.
Type
JSONArray

getViewDependents() → {JSONArray}

Returns list of dependents views for the specified view.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Dependent view list.
Type
JSONArray

getViewDetails(viewId, config) → {Object}

Returns details of the specified view.
Parameters:
Name Type Default Description
viewId String The ID of the view.
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
View details.
Type
Object

getViewInstance(orgId, workspaceId, viewId)

Returns a new ViewAPI instance.
Parameters:
Name Type Description
orgId String The ID of the organization.
workspaceId String The ID of the workspace.
viewId String The ID of the view.
Source:

getViewUrl(config) → {String}

Returns the URL to access the specified view.
Parameters:
Name Type Default Description
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
View URL.
Type
String

getViews(config) → {JSONArray}

Returns list of all accessible views for the specified workspace.
Parameters:
Name Type Default Description
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
View list.
Type
JSONArray

getWorkspaceDetails(workspaceId) → {Object}

Returns details of the specified workspace.
Parameters:
Name Type Description
workspaceId String The ID of the workspace.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Workspace details.
Type
Object

getWorkspaceInstance(orgId, workspaceId)

Returns a new WorkspaceAPI instance.
Parameters:
Name Type Description
orgId String The ID of the organization.
workspaceId String The ID of the workspace.
Source:

getWorkspaceUsers() → {JSONArray}

Returns list of users for the specified workspace.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
User list.
Type
JSONArray

getWorkspaces() → {JSONArray}

Returns list of all accessible workspaces.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Workspace list.
Type
JSONArray

hideColumns(columnIds, config)

Hide the specified columns in the table.
Parameters:
Name Type Default Description
columnIds JSONArray Ids of the columns to be hidden.
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error

importBulkData(viewId, importType, fileType, autoIdentify, filePath, config) → {String}

Asynchronously import the data contained in the mentioned file into the table.
Parameters:
Name Type Default Description
viewId String Id of the view where the data to be imported.
importType String The type of import. Can be one of - append, truncateadd, updateadd.
fileType String Type of the file to be imported.
autoIdentify String Used to specify whether to auto identify the CSV format. Allowable values - true/false.
filePath String Path of the file to be imported.
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Import job id.
Type
String

importBulkDataAsBatches(viewId, importType, autoIdentify, filePath, batchSize, config) → {String}

Asynchronously import the data contained in the mentioned file into the table.
Parameters:
Name Type Default Description
viewId String Id of the view where the data to be imported.
importType String The type of import. Can be one of - append, truncateadd, updateadd.
autoIdentify String Used to specify whether to auto identify the CSV format. Allowable values - true/false.
filePath String Path of the file to be imported.
batchSize Number Number of lines per batch.
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Import job id.
Type
String

importBulkDataInNewTable(tableName, fileType, autoIdentify, filePath, config) → {String}

Asynchronously create a new table and import the data contained in the mentioned file into the created table.
Parameters:
Name Type Default Description
tableName String Name of the new table to be created.
fileType String Type of the file to be imported.
autoIdentify String Used to specify whether to auto identify the CSV format. Allowable values - true/false.
filePath String Path of the file to be imported.
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Import job id.
Type
String

importData(viewId, importType, fileType, autoIdentify, filePath, config) → {JSONObject}

Import the data contained in the mentioned file into the table.
Parameters:
Name Type Default Description
viewId String Id of the view where the data to be imported.
importType String The type of import. Can be one of - append, truncateadd, updateadd.
fileType String Type of the file to be imported.
autoIdentify String Used to specify whether to auto identify the CSV format. Allowable values - true/false.
filePath String Path of the file to be imported.
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Import result.
Type
JSONObject

importDataInNewTable(tableName, fileType, autoIdentify, filePath, config) → {JSONObject}

Create a new table and import the data contained in the mentioned file into the created table.
Parameters:
Name Type Default Description
tableName String Name of the new table to be created.
fileType String Type of the file to be imported.
autoIdentify String Used to specify whether to auto identify the CSV format. Allowable values - true/false.
filePath String Path of the file to be imported.
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Import result.
Type
JSONObject

importDataInNewTableAsBatches(tableName, fileType, autoIdentify, filePath, batchSize, config) → {JSONObject}

Create a new table and import the data contained in the mentioned file into the created table.
Parameters:
Name Type Default Description
tableName String Name of the new table to be created.
fileType String Type of the file to be imported.
autoIdentify String Used to specify whether to auto identify the CSV format. Allowable values - true/false.
filePath String Path of the file to be imported.
batchSize Number Number of lines per batch.
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Import result.
Type
JSONObject

importRawData(viewId, importType, fileType, autoIdentify, data, config) → {JSONObject}

Import the raw data provided into the table.
Parameters:
Name Type Default Description
viewId String Id of the view where the data to be imported.
importType String The type of import. Can be one of - append, truncateadd, updateadd.
fileType String Type of the file to be imported.
autoIdentify String Used to specify whether to auto identify the CSV format. Allowable values - true/false.
data String Raw data to be imported.
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Import result.
Type
JSONObject

importRawDataInNewTable(tableName, fileType, autoIdentify, data, config) → {JSONObject}

Create a new table and import the raw data provided into the created table.
Parameters:
Name Type Default Description
tableName String Name of the new table to be created.
fileType String Type of the file to be imported.
autoIdentify String Used to specify whether to auto identify the CSV format. Allowable values - true/false.
data String Raw data to be imported.
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Import result.
Type
JSONObject

initiateBulkExport(viewId, responseFormat, config) → {String}

Initiate asynchronous export for the mentioned table (or) view data.
Parameters:
Name Type Default Description
viewId String Id of the view to be exported.
responseFormat String The format in which the data is to be exported.
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Export job id.
Type
String

initiateBulkExportUsingSQL(sqlQuery, responseFormat, config) → {String}

Initiate asynchronous export with the given SQL Query.
Parameters:
Name Type Default Description
sqlQuery String The SQL Query whose output is exported.
responseFormat String The format in which the data is to be exported.
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Export job id.
Type
String

makeDefaultFolder(folderId)

Make the specified folder as default.
Parameters:
Name Type Description
folderId String Id of the folder.
Source:
Throws:
If the request failed due to some error.
Type
Error

makeViewPublic(config) → {String}

Make the specified view publically accessible.
Parameters:
Name Type Default Description
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Public URL.
Type
String

moveViewsToFolder(folderId, viewIds, config)

Move views to the mentioned folder.
Parameters:
Name Type Default Description
folderId String Id of the folder.
viewIds JSONArray View ids to be moved.
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error

refetchData(viewName, config)

Sync data from available datasource for the specified view.
Parameters:
Name Type Default Description
viewName String New name of the view.
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error

removeAdmins(emailIds, config)

Remove admins from the specified workspace.
Parameters:
Name Type Default Description
emailIds JSONArray The email address of the admin users to be removed.
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error

removeDefault()

Remove a specified workspace from default.
Source:
Throws:
If the request failed due to some error.
Type
Error

removeFavorite()

Remove a specified workspace from favorite.
Source:
Throws:
If the request failed due to some error.
Type
Error

removeFavorite()

Remove a specified view from favorite.
Source:
Throws:
If the request failed due to some error.
Type
Error

removeGroupMembers(groupId, emailIds, config)

Remove users from the specified group.
Parameters:
Name Type Default Description
groupId String Id of the group.
emailIds JSONArray The email address of the users to be removed from the group.
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error

removeLookup(columnId, config)

Remove the lookup for the specified column in the table.
Parameters:
Name Type Default Description
columnId String Id of the column.
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error

removePrivateAccess()

Remove private link access for the specified view.
Source:
Throws:
If the request failed due to some error.
Type
Error

removePublicAccess()

Remove public access for the specified view.
Source:
Throws:
If the request failed due to some error.
Type
Error

removeShare(viewIds, emailIds, config)

Remove shared views for the specified users.
Parameters:
Name Type Default Description
viewIds JSONArray View ids whose sharing needs to be removed.
emailIds JSONArray The email address of the users to whom the sharing need to be removed.
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error

removeShare() → {Object}

Returns permissions for the specified view.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Permission details.
Type
Object

removeUsers(emailIds, config)

Remove users from the specified organization.
Parameters:
Name Type Default Description
emailIds JSONArray The email address of the users to be removed.
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error

removeWorkspaceUsers(emailIds, config)

Remove users from the specified workspace.
Parameters:
Name Type Default Description
emailIds JSONArray The email address of the users to be removed.
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error

rename(workspaceName, config)

Rename a specified workspace in the organization.
Parameters:
Name Type Default Description
workspaceName String New name for the workspace.
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error

rename(viewName, config)

Rename a specified view in the workspace.
Parameters:
Name Type Default Description
viewName String New name of the view.
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error

renameColumn(columnId, newColumnName, config)

Rename a specified column in the table.
Parameters:
Name Type Default Description
columnId String Id of the column.
newColumnName String New name for the column.
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error

renameFolder(folderId, folderName, config)

Rename a specified folder in the workspace.
Parameters:
Name Type Default Description
folderId String Id of the folder.
folderName String New name for the folder.
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error

renameGroup(groupId, newGroupName, config)

Rename a specified group.
Parameters:
Name Type Default Description
groupId String Id of the group.
newGroupName String New name for the group.
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error

restoreTrashView(viewId, config)

Restore the specified view from trash.
Parameters:
Name Type Default Description
viewId String Id of the view.
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error

saveAs(newViewName, config) → {String}

Copy a specified view within the workspace.
Parameters:
Name Type Default Description
newViewName String The name of the new view.
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Newly created view id.
Type
String

shareViews(viewIds, emailIds, permissions, config)

Share views to the specified users.
Parameters:
Name Type Default Description
viewIds JSONArray View ids to be shared.
emailIds JSONArray The email address of the users to whom the views need to be shared.
permissions Object Contains permission details.
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error

showColumns(columnIds, config)

Show the specified hidden columns in the table.
Parameters:
Name Type Default Description
columnIds JSONArray Ids of the columns to be shown.
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error

syncData(datasourceId, config)

Initiate data sync for the specified datasource.
Parameters:
Name Type Default Description
datasourceId String Id of the datasource.
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error

triggerEmailSchedule(scheduleId)

Trigger configured email schedules instantly.
Parameters:
Name Type Description
scheduleId String Id for the email schedule.
Source:
Throws:
If the request failed due to some error.
Type
Error

updateDatasourceConnection(datasourceId, config)

Update connection details for the specified datasource.
Parameters:
Name Type Default Description
datasourceId String Id of the datasource.
config Object {} Contains the control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error

updateEmailSchedule(scheduleId, config) → {String}

Update configurations of the specified email schedule in the workspace.
Parameters:
Name Type Description
scheduleId String Id for the email schedule.
config Object Contains the control configurations.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Updated email schedule id.
Type
String

updatePublishConfigurations(config)

Update publish configurations for the specified view.
Parameters:
Name Type Default Description
config Object {} Contains the required control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error

updateRow(columnValues, criteria, config) → {Object}

Update rows in the specified table.
Parameters:
Name Type Default Description
columnValues Object Contains the values for the row. The column names are the key.
criteria String The criteria to be applied for updating data. Only rows matching the criteria will be updated. Should be null for update all rows.
config Object {} Contains any additional control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Updated Columns List and Updated Rows Count.
Type
Object

updateSharedDetails(config)

Update shared details of the specified view.
Parameters:
Name Type Default Description
config Object {} Contains the control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error

updateSlideshow(slideId, config)

Update details of the specified slideshow.
Parameters:
Name Type Default Description
slideId String The id of the slideshow.
config Object {} Contains the control configurations
Source:
Throws:
If the request failed due to some error.
Type
Error

updateVariable(variableId, variableName, variableName, variableName, config)

Update details of the specified variable in the workspace.
Parameters:
Name Type Default Description
variableId String Id of the variable.
variableName String New name for the variable.
variableName Number New datatype for the variable.
variableName Number New type for the variable.
config Object {} Contains the control attributes.
Source:
Throws:
If the request failed due to some error.
Type
Error