ZohoAnalytics

Methods

activateUsers(emailIds, uriPath, params) → {String}

Activate users on a specific account identified by the URI.
Parameters:
Name Type Default Description
emailIds String Comma seperated emailid of users.
uriPath String User URI.
params Object {} Contains any additional control parameters.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Success Message.
Type
String

addColumn(columnName, columnType, uriPath, params) → {String}

Add a new column on the table identified by the URI.
Parameters:
Name Type Default Description
columnName String Name of the column to be created.
columnType String Type of the column to be created.
uriPath String View URI.
params Object {} Contains any additional control parameters.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Success Message.
Type
String

addGroupMembers(uriPath, config) → {String}

Add new members for the specified group present in the workspace identified by the URI.
Parameters:
Name Type Default Description
uriPath String Workspace URI.
config Object {} Contains the required information to add members into the group.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Success Message.
Type
String

addLookup(columnName, referedTable, referedColumn, onError, uriPath, params) → {String}

Add lookup in a specific child table.
Parameters:
Name Type Default Description
columnName String Name of the column (Child column).
referedTable String Name of the referred table (parent table).
referedColumn String Name of the referred column (parent column).
onError String This parameter controls the action to be taken In-case there is an error during lookup.
uriPath String View URI.
params Object {} Contains any additional control parameters.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Success Message.
Type
String

addRow(uriPath, params) → {Object}

Adds a row to a specific table identified by the URI.
Parameters:
Name Type Default Description
uriPath String View URI.
params Object {} Contains any additional control parameters.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Column Names and Added Row Values.
Type
Object

addUsers(emailIds, uriPath, params) → {String}

Add users to a specific account identified by the URI.
Parameters:
Name Type Default Description
emailIds String Comma seperated emailid of users.
uriPath String User URI.
params Object {} Contains any additional control parameters.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Success Message.
Type
String

addWorkspaceAdmin(emailIds, uriPath, params) → {String}

Grant admin permission to users for a specific workspace identified by the URI.
Parameters:
Name Type Default Description
emailIds String Comma seperated emailid of users.
uriPath String Workspace URI.
params Object {} Contains any additional control parameters.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Success Message.
Type
String

autoGenReports(source, uriPath, params) → {String}

Generate reports for the particular table or column.
Parameters:
Name Type Default Description
source String Source should be column or table..
uriPath String View URI.
params Object {} Contains any additional control parameters.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Success Message.
Type
String

changeUserRole(emailIds, role, uriPath, params) → {String}

Change the role of specified users with the new role provided.
Parameters:
Name Type Default Description
emailIds String Comma seperated emailid of users.
role String New role for the users. can be one of "ORGADMIN"/"USER".
uriPath String User URI.
params Object {} Contains any additional control parameters.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Success Message.
Type
String

copyFormula(formulaNames, destWorkspaceName, copydbkey, uriPath, params) → {String}

Copy one or more formula from one view to another within the same account or even across user accounts.
Parameters:
Name Type Default Description
formulaNames String Comma seperated formula names to be copied.
destWorkspaceName String Name of the desctination workspace.
copydbkey String The key generated by GETCOPYDBKEY action for the source workspace.
uriPath String View URI.
params Object {} Contains any additional control parameters.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Success Message.
Type
String

copyReports(viewNames, destWorkspaceName, copydbkey, uriPath, params) → {String}

Copy one or more reports from one workspace to another within the same account or even across user accounts.
Parameters:
Name Type Default Description
viewNames String Comma seperated view names to be copied.
destWorkspaceName String Name of the desctination workspace.
copydbkey String The key generated by GETCOPYDBKEY action for the source workspace.
uriPath String Workspace URI.
params Object {} Contains any additional control parameters.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Success Message.
Type
String

copyWorkspace(newWorkspaceName, copydbkey, uriPath, params) → {Long}

Copy a specific workspace identified by the URI.
Parameters:
Name Type Default Description
newWorkspaceName String Name of the workspace to be created.
copydbkey String The key generated by GETCOPYDBKEY action for the source workspace.
uriPath String Workspace URI.
params Object {} Contains any additional control parameters.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Copied workspace id.
Type
Long

createGroup(uriPath, config) → {Long}

Create a new group in the workspace identified by the URI.
Parameters:
Name Type Default Description
uriPath String Workspace URI.
config Object {} Contains required details to create the group.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Newly created group id.
Type
Long

createSimilarViews(referenceView, folderName, copyCustomFormula, copyAggregateFormula, uriPath, params) → {String}

Generate reports from the table identified by the URI based on the reference table views.
Parameters:
Name Type Default Description
referenceView String Source view to be copied.
folderName String Name of the view to be created.
copyCustomFormula String Source view to be copied.
copyAggregateFormula String Name of the view to be created.
uriPath String View URI.
params Object {} Contains any additional control parameters.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Success Message.
Type
String

createSlideShow(uriPath, config) → {String}

Create a new slideshow in the workspace identified by the URI.
Parameters:
Name Type Default Description
uriPath String Workspace URI.
config Object {} Contains required details to create the slideshow.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Success Message.
Type
String

createTable(config, uriPath, params) → {String}

Creates a table using the given configuration.
Parameters:
Name Type Default Description
config String Table Configuration.
uriPath String Workspace URI.
params Object {} Contains any additional control parameters.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Success Message.
Type
String

createWorkspace(newWorkspaceName, uriPath, params) → {Long}

Create a blank workspace.
Parameters:
Name Type Default Description
newWorkspaceName String Name of the workspace to be created.
uriPath String User URI.
params Object {} Contains any additional control parameters.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Newly created workspace id.
Type
Long

deActivateUsers(emailIds, uriPath, params) → {String}

Deactivate users on a specific account identified by the URI.
Parameters:
Name Type Default Description
emailIds String Comma seperated emailid of users.
uriPath String User URI.
params Object {} Contains any additional control parameters.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Success Message.
Type
String

deleteColumn(columnName, uriPath, params) → {String}

Delete a column from the table identified by the URI.
Parameters:
Name Type Default Description
columnName String Name of the column to be deleted.
uriPath String View URI.
params Object {} Contains any additional control parameters.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Success Message.
Type
String

deleteData(uriPath, params) → {Object}

Delete rows on a specific table identified by the URI.
Parameters:
Name Type Default Description
uriPath String View URI.
params Object {} Contains any additional control parameters.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Success Message and Deleted Rows Count.
Type
Object

deleteGroup(uriPath, config) → {String}

Deletes groups from the workspace identified by the URI.
Parameters:
Name Type Default Description
uriPath String Workspace URI.
config Object {} Contains required details to delete groups.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Success Message.
Type
String

deleteSlideShow(uriPath, config) → {String}

Delete the mentioned slides present in the workspace identified by the URI.
Parameters:
Name Type Default Description
uriPath String Workspace URI.
config Object {} Contains required details to delete slideshows.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Success Message.
Type
String

deleteView(viewName, uriPath, params) → {String}

Delete a table or report from the workspace identified by the URI.
Parameters:
Name Type Default Description
viewName String Name of the view to be deleted.
uriPath String Workspace URI.
params Object {} Contains any additional control parameters.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Success Message.
Type
String

deleteWorkspace(workspaceName, uriPath, params) → {String}

Deletes a specific workspace.
Parameters:
Name Type Default Description
workspaceName String Name of the workspace to be deleted.
uriPath String User URI.
params Object {} Contains any additional control parameters.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Success Message.
Type
String

disableDomainWorkspace(workspaceName, domainName, uriPath, params) → {String}

Disable a workspace for custom domain.
Parameters:
Name Type Default Description
workspaceName String Name of the workspace to be disabled for custom domain.
domainName String Name of the custom domain for which the workspace has to be disabled.
uriPath String User URI.
params Object {} Contains any additional control parameters.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Success Message.
Type
String

enableDomainWorkspace(workspaceName, domainName, uriPath, params) → {String}

Enable a workspace for custom domain.
Parameters:
Name Type Default Description
workspaceName String Name of the workspace to be enabled for custom domain.
domainName String Name of the custom domain for which the workspace has to be enabled.
uriPath String User URI.
params Object {} Contains any additional control parameters.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Success Message.
Type
String

exportData(outputFormat, uriPath, params) → {String}

Export data from a specific table identified by the URI.
Parameters:
Name Type Default Description
outputFormat String local path of the file where data is present.
uriPath String View URI.
params Object {} Contains any additional control parameters.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Data in Specified output format.
Type
String

folderList(uriPath, params) → {Object}

Get the list of all available folders present in the workspace identified by the URI.
Parameters:
Name Type Default Description
uriPath String Workspace URI.
params Object {} Contains any additional control parameters.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
list of available folders.
Type
Object

getCopyDBKey(uriPath, params) → {String}

Get copy workspace key for specified workspace identified by the URI.
Parameters:
Name Type Default Description
uriPath String Workspace URI.
params Object {} Contains any additional control parameters.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
copy workspace key.
Type
String

getDashboards(uriPath, params) → {Object}

Get the list of owned/shared dashboards present in the ZohoAnalytics account identified by the URI.
Parameters:
Name Type Default Description
uriPath String User URI.
params Object {} Contains any additional control parameters.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
The list of dashboards present in the organization.
Type
Object

getEmbedUrl(uriPath, params) → {String}

Get the embed url of a specific view identified by the URI. This API is available only for the White Label Administrator.
Parameters:
Name Type Default Description
uriPath String View URI.
params Object {} Contains any additional control parameters.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Embed URL for the view.
Type
String

getInfo(uriPath, params) → {Object}

Gets the workspace ID (DBID) and View ID (OBJID) of the corresponding workspace.
Parameters:
Name Type Default Description
uriPath String View URI.
params Object {} Contains any additional control parameters.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
workspace id(DBID) and view id(OBJID).
Type
Object

getPlanInfo(uriPath, params) → {Object}

Fetch the user plan info.
Parameters:
Name Type Default Description
uriPath String User URI.
params Object {} Contains any additional control parameters.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
User plan info.
Type
Object

getShareInfo(uriPath, params) → {Object}

Fetch share info for a specific workspace identified by the URI.
Parameters:
Name Type Default Description
uriPath String Workspace URI.
params Object {} Contains any additional control parameters.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Sharing details of the workspace.
Type
Object

getShareInfo(uriPath, config) → {Object}

Fetch the meta information of groups present in the workspace identified by the URI.
Parameters:
Name Type Default Description
uriPath String Workspace URI.
config Object {} Contains any additional control parameters.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Meta information of groups present in the workspace.
Type
Object

getSlideInfo(uriPath, config) → {Object}

Get the meta-information of the provided slide present in the workspace identified by the URI.
Parameters:
Name Type Default Description
uriPath String Workspace URI.
config Object {} Contains required details to get slideinfo.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Object having meta-information of the provided slideshow.
Type
Object

getSlideList(uriPath, config) → {Object}

Get the list of all available slideshow present in the workspace identified by the URI.
Parameters:
Name Type Default Description
uriPath String Workspace URI.
config Object {} Contains any additional control parameters.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Object having list of slideshows present in the workspace.
Type
Object

getSlideUrl(uriPath, config) → {String}

Get the URL to access the mentioned slide present in the workspace identified by the URI.
Parameters:
Name Type Default Description
uriPath String Workspace URI.
config Object {} Contains required details to construct the slide url.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Access url of the slideshow.
Type
String

getUri(emailId, workspaceName, viewName, params) → {String}

Generate Request URI(Either User URI, Workspace URI or View URI) based on the arguments passed.
Parameters:
Name Type Default Description
emailId String EmailId of the user.
workspaceName String null Name of the workspace.
viewName String null Name of the view.
params Object {} Contains any additional control parameters.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
User URI - If emailId alone is passed as param Workspace URI - If emailId and workspaceName are passed as params. View URI - If emailId, workspaceName and viewName are passed as param.
Type
String

getUsers(uriPath, params) → {JSONArray}

Fetch users list for a specific account identified by the URI.
Parameters:
Name Type Default Description
uriPath String User URI.
params Object {} Contains any additional control parameters.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
User list information.
Type
JSONArray

getViewInfo(viewId, uriPath, params) → {Object}

Fetch view details like view name,description,type from the the particular workspace identified by Workspace URI.
Parameters:
Name Type Default Description
viewId Long Id of view for which info is needed.
uriPath String Workspace URI.
params Object {} Contains any additional control parameters.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
The meta information of the view.
Type
Object

getViewName(viewId, uriPath, params) → {String}

Fetch name of the view for the given view id.
Parameters:
Name Type Default Description
viewId String name of the workspace.
uriPath String User URI.
params Object {} Contains any additional control parameters.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
The View name.
Type
String

getViewUrl(uriPath, params) → {String}

Get the standalone url to access a specific view identified by the URI.
Parameters:
Name Type Default Description
uriPath String View URI.
params Object {} Contains any additional control parameters.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Access URL for the view.
Type
String

getWorkspaceID(workspaceName, uriPath, params) → {Long}

Fetch the ID of provided workspace name.
Parameters:
Name Type Default Description
workspaceName String name of the workspace.
uriPath String User URI.
params Object {} Contains any additional control parameters.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
ID of the workspace.
Type
Long

getWorkspaceMetadata(metadataType, uriPath, params) → {Object}

Get workspace/reports meta information.
Parameters:
Name Type Default Description
metadataType String Type of meta information. Can be one of 1. ZOHO_CATALOG_LIST 2. ZOHO_CATALOG_INFO 3. ZOHO_DATATYPES 4. ZOHO_TABLETYPES
uriPath String Workspace URI (or) View URI.
params Object {} Contains any additional control parameters.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Metadata of the workspace.
Type
Object

getWorkspaceName(workspaceId, uriPath, params) → {String}

Get the name of workspace for the provided workspaceId.
Parameters:
Name Type Default Description
workspaceId String Id of the workspace.
uriPath String User URI.
params Object {} Contains any additional control parameters.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Name of the workspace.
Type
String

hideColumn(columnNames, uriPath, params) → {String}

Hide columns on the table identified by the URI.
Parameters:
Name Type Default Description
columnNames String List of column names to be hide.
uriPath String View URI.
params Object {} Contains any additional control parameters.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Success Message.
Type
String

importData(filepath, importType, autoIdentify, onImportError, uriPath, params) → {Object}

Import data from a file to a specific table identified by the URI.
Parameters:
Name Type Default Description
filepath String local path of the file where data is present.
importType String The type of import. Can be one of 1. APPEND 2. TRUNCATEADD 3. UPDATEADD
autoIdentify Boolean If set to true, Import type is set to CSV (or) User need to send the 'ZOHO_IMPORT_FILETYPE' in params.
onImportError String It controls the action to be taken incase there is an error during import. Can be one of 1. ABORT 2. SKIPROW 3. SETCOLUMNEMPTY
uriPath String View URI.
params Object {} Contains any additional control parameters.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
IMPORT Summary.
Type
Object

importDataAsString(importContent, importType, autoIdentify, onImportError, uriPath, params) → {Object}

Import data to a specific table identified by the URI.
Parameters:
Name Type Default Description
importContent String holds the data to be imported.
importType String The type of import. Can be one of 1. APPEND 2. TRUNCATEADD 3. UPDATEADD
autoIdentify Boolean If set to true, Import type is set to CSV (or) User need to send the 'ZOHO_IMPORT_FILETYPE' in params.
onImportError String It controls the action to be taken incase there is an error during import. Can be one of 1. ABORT 2. SKIPROW 3. SETCOLUMNEMPTY
uriPath String View URI.
params Object {} Contains any additional control parameters.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
IMPORT Summary.
Type
Object

isColumnExist(columnName, uriPath, params) → {Boolean}

Checks whether the column exist or not in the view identified by URI.
Parameters:
Name Type Default Description
columnName String name of the column.
uriPath String View URI.
params Object {} Contains any additional control parameters.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
'true' if column exist 'false' otherwise.
Type
Boolean

isViewExist(viewName, uriPath, params) → {Boolean}

Checks whether the view exist or not in the workspace identified by URI.
Parameters:
Name Type Default Description
viewName String name of the view.
uriPath String Workspace URI.
params Object {} Contains any additional control parameters.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
'true' if view exist 'false' otherwise.
Type
Boolean

isWorkspaceExist(workspaceName, uriPath, params) → {Boolean}

Checks whether the workspace exist or not in the ZohoAnalytics account identified by URI.
Parameters:
Name Type Default Description
workspaceName String name of the workspace.
uriPath String User URI.
params Object {} Contains any additional control parameters.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
'true' if workspace exist 'false' otherwise.
Type
Boolean

myWorkspaceList(uriPath, params) → {Object}

Get the list of all owned workspaces present in the ZohoAnalytics account identified by the URI.
Parameters:
Name Type Default Description
uriPath String User URI.
params Object {} Contains any additional control parameters.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
list of owned workspaces.
Type
Object

recentItems(uriPath, params) → {Object}

Get the details of recently accessed views from the ZohoAnalytics account identified by the URI.
Parameters:
Name Type Default Description
uriPath String User URI.
params Object {} Contains any additional control parameters.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Recently modified views.
Type
Object

removeGroupMembers(uriPath, config) → {String}

Remove members from the specified group present in the workspace identified by the URI.
Parameters:
Name Type Default Description
uriPath String Workspace URI.
config Object {} Contains the required information to remove members from the group.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Success Message.
Type
String

removeLookup(columnName, uriPath, params) → {String}

Remove the lookup for the given column.
Parameters:
Name Type Default Description
columnName String Name of the column for which lookup has to removed.
uriPath String View URI.
params Object {} Contains any additional control parameters.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Success Message.
Type
String

removeShare(emailIds, uriPath, params) → {String}

Revoke permissions for the shared users.
Parameters:
Name Type Default Description
emailIds String Comma seperated emailid of users, whose permission to be revoked.
uriPath String Workspace URI.
params Object {} Contains any additional control parameters.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Success Message.
Type
String

removeUsers(emailIds, uriPath, params) → {String}

Remove users from a specific account identified by the URI.
Parameters:
Name Type Default Description
emailIds String Comma seperated emailid of users.
uriPath String User URI.
params Object {} Contains any additional control parameters.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Success Message.
Type
String

removeWorkspaceAdmin(emailIds, uriPath, params) → {String}

Revoke admin users for a specific workspace identified by the URI.
Parameters:
Name Type Default Description
emailIds String Comma seperated emailid of users.
uriPath String Workspace URI.
params Object {} Contains any additional control parameters.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Success Message.
Type
String

renameColumn(oldColumnName, newColumnName, uriPath, params) → {String}

Rename a column with new name from the table identified by the URI.
Parameters:
Name Type Default Description
oldColumnName String Name of the column to be renamed.
newColumnName String New Name of the column.
uriPath String View URI.
params Object {} Contains any additional control parameters.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Success Message.
Type
String

renameView(oldViewName, newViewName, uriPath, params) → {String}

Rename a table or report with a new name from the workspace identified by the URI.
Parameters:
Name Type Default Description
oldViewName String Name of the view to be renamed.
newViewName String New name of the view.
uriPath String Workspace URI.
params Object {} Contains any additional control parameters.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Success Message.
Type
String

saveAs(viewToCopy, newViewName, uriPath, params) → {String}

Create a new view by copying the structure and data of existing view.
Parameters:
Name Type Default Description
viewToCopy String Source view to be copied.
newViewName String Name of the view to be created.
uriPath String Workspace URI.
params Object {} Contains any additional control parameters.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Success Message.
Type
String

sharedWorkspaceList(uriPath, params) → {Object}

Get the list of all shared workspaces present in the ZohoAnalytics account identified by the URI.
Parameters:
Name Type Default Description
uriPath String User URI.
params Object {} Contains any additional control parameters.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
list of shared workspaces.
Type
Object

shareViews(viewNames, emailIds, uriPath, params) → {String}

Share the created views with users and also can update sharing permission granted.
Parameters:
Name Type Default Description
viewNames String Comma seperated name of the views to be shared.
emailIds String Comma seperated emailid of users.
uriPath String Workspace URI.
params Object {} Contains any additional control parameters.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Success Message.
Type
String

showColumn(columnNames, uriPath, params) → {String}

Unhide columns from the table identified by the URI.
Parameters:
Name Type Default Description
columnNames String List of column names to be unhide.
uriPath String View URI.
params Object {} Contains any additional control parameters.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Success Message.
Type
String

updateCloudDBConnection(uriPath, config, params) → {String}

Updates cloud connection information of the given view identified by the URI.
Parameters:
Name Type Default Description
uriPath String View URI.
config Object {} Contains required details to construct the slide url.
params Object {} Contains any additional control parameters.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Success Message.
Type
String

updateData(uriPath, params) → {Object}

Update data on a specific table identified by the URI.
Parameters:
Name Type Default Description
uriPath String View URI.
params Object {} Contains any additional control parameters.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Updated Columns List and Updated Rows Count.
Type
Object

updateGroupInfo(uriPath, config) → {String}

Updates the specified group information present in the workspace identified by the URI.
Parameters:
Name Type Default Description
uriPath String Workspace URI.
config Object {} Contains details on the group which has to be updated.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Success Message.
Type
String

updateRemoteDBConnection(uriPath, config, params) → {String}

Updates cloud connection information of the given live connect workspace identified by the URI.
Parameters:
Name Type Default Description
uriPath String Workspace URI.
config Object {} Contains required details to construct the slide url.
params Object {} Contains any additional control parameters.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Success Message.
Type
String

updateSlideShow(uriPath, config) → {String}

Update the mentioned slide information present in the workspace identified by the URI.
Parameters:
Name Type Default Description
uriPath String Workspace URI.
config Object {} Contains required details to update the slideshow.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
Success Message.
Type
String

viewList(uriPath, params) → {Object}

Get the list of all available views present in the workspace identified by the URI.
Parameters:
Name Type Default Description
uriPath String Workspace URI.
params Object {} Contains any additional control parameters.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
list of available views.
Type
Object

viewMetadata(uriPath, params) → {Object}

Returns metainfo of the given view identified by the URI.
Parameters:
Name Type Default Description
uriPath String View URI.
params Object {} Contains any additional control parameters.
Source:
Throws:
If the request failed due to some error.
Type
Error
Returns:
metainfo of the view.
Type
Object