Package python :: Module ReportClient :: Class ReportClient
[hide private]
[frames] | no frames]

Class ReportClient

source code

ReportClient provides the python based language binding to the https based api of ManageEngine Analytics Plus.

Instance Methods [hide private]
 
__init__(self, authtoken)
Creates a new ReportClient instance.
source code
 
__sendRequest(self, url, httpMethod, payLoad, action, callBackData) source code
 
handleResponse(self, response, action, callBackData)
Internal method.
source code
dictionary
addRow(self, tableURI, columnValues, config=None)
Adds a row to the specified table identified by the URI.
source code
 
deleteData(self, tableURI, criteria, config)
Delete the data in the specified table identified by the URI.
source code
 
updateData(self, tableURI, columnValues, criteria, config=None)
update the data in the specified table identified by the URI.
source code
ImportResult
importData(self, tableURI, importType, importContent, importConfig=None)
Bulk import data into the table identified by the URI.
source code
ImportResult
importDataAsString(self, tableURI, importType, importContent, importConfig=None)
Bulk import data into the table identified by the URI.
source code
 
exportData(self, tableOrReportURI, format, exportToFileObj, criteria=None, config=None)
Export the data in the specified table identified by the URI.
source code
 
exportDataUsingSQL(self, tableOrReportURI, format, exportToFileObj, sql, config=None)
Export the data with the specified SQL query identified by the URI.
source code
string
copyDatabase(self, dbURI, config=None)
Copy the specified database identified by the URI.
source code
 
deleteDatabase(self, userURI, databaseName, config=None)
Delete the specified database.
source code
dictionary
enableDomainDB(self, userUri, dbName, domainName, config=None)
Enable database for custom domain.
source code
dictionary
disableDomainDB(self, userUri, dbName, domainName, config=None)
Disable database for custom domain.
source code
 
createTable(self, dbURI, tableDesign, config=None)
Create a table in the specified database.
source code
dictionary
autoGenReports(self, tableURI, source, config=None)
Generate reports for the particular table.
source code
dictionary
createSimilarViews(self, tableURI, refView, folderName, customFormula, aggFormula, config=None)
This method is used to create similar views .
source code
 
renameView(self, dbURI, viewName, newViewName, viewDesc='', config=None)
Rename the specified view with the new name and description.
source code
 
copyReports(self, dbURI, views, dbName, dbKey, config=None)
The Copy Reports API is used to copy one or more reports from one database to another within the same account or even across user accounts.
source code
 
copyFormula(self, tableURI, formula, dbName, dbKey, config=None)
The Copy Formula API is used to copy one or more formula columns from one table to another within the same database or across databases and even across one user account to another.
source code
 
addColumn(self, tableURI, columnName, dataType, config=None)
Adds a column into ManageEngine Analytics Plus Table.
source code
 
deleteColumn(self, tableURI, columnName, config=None)
Deletes a column from ManageEngine Analytics Plus Table.
source code
 
renameColumn(self, tableURI, oldColumnName, newColumnName, config=None)
Deactivate the users in the ManageEngine Analytics Plus Account.
source code
list
hideColumn(self, tableURI, columnNames, config=None)
Hide the columns in the table.
source code
list
showColumn(self, tableURI, columnNames, config=None)
Show the columns in the table.
source code
 
addLookup(self, tableURI, columnName, referedTable, referedColumn, onError, config=None)
Add the lookup for the given column.
source code
 
removeLookup(self, tableURI, columnName, config=None)
Remove the lookup for the given column.
source code
dictionary
getDatabaseMetadata(self, requestURI, metadata, config=None)
This method is used to get the meta information about the reports.
source code
string
getDatabaseName(self, userURI, dbid, config=None)
Get database name for a specified database identified by the URI.
source code
string
isDbExist(self, userURI, dbName, config=None)
Check wheather the database is exist or not.
source code
string
getCopyDBKey(self, dbURI, config=None)
Get copy database key for specified database identified by the URI.
source code
string
getViewName(self, userURI, objid, config=None)
This function returns the name of a view in ManageEngine Analytics Plus.
source code
dictionary
getInfo(self, tableURI, config=None)
This method returns the Database ID (DBID) and View ID (OBJID) of the corresponding Database.
source code
 
shareView(self, dbURI, emailIds, views, criteria=None, config=None)
This method is used to share the views (tables/reports/dashboards) created in ManageEngine Analytics Plus with users.
source code
 
removeShare(self, dbURI, emailIds, config=None)
This method is used to remove the shared views (tables/reports/dashboards) in ManageEngine Analytics Plus from the users.
source code
 
addDbOwner(self, dbURI, emailIds, config=None)
This method is used to add new owners to the reports database.
source code
 
removeDbOwner(self, dbURI, emailIds, config=None)
This method is used to remove the existing owners from the reports database.
source code
ShareInfo
getShareInfo(self, dbURI, config=None)
Get the shared informations.
source code
string
getViewUrl(self, tableURI, config=None)
This method returns the URL to access the mentioned view.
source code
string
getEmbedUrl(self, tableURI, criteria=None, config=None)
This method is used to get the embed URL of the particular table / view.
source code
list
getUsers(self, userURI, config=None)
Get users list for the user account.
source code
 
addUser(self, userURI, emailIds, config=None)
Add the users to the ManageEngine Analytics Plus Account.
source code
 
removeUser(self, userURI, emailIds, config=None)
Remove the users from the ManageEngine Analytics Plus Account.
source code
 
activateUser(self, userURI, emailIds, config=None)
Activate the users in the ManageEngine Analytics Plus Account.
source code
 
deActivateUser(self, userURI, emailIds, config=None)
Deactivate the users in the ManageEngine Analytics Plus Account.
source code
PlanInfo
getPlanInfo(self, userURI, config=None)
Get the plan informations.
source code
string
getUserURI(self, dbOwnerName)
Returns the URI for the specified user..
source code
string
getDBURI(self, dbOwnerName, dbName)
Returns the URI for the specified database.
source code
string
getURI(self, dbOwnerName, dbName, tableOrReportName)
Returns the URI for the specified database table (or report).
source code
 
splCharReplace(self, value)
Internal method for handling special charecters in tale or database name.
source code
 
getResp(self, url, httpMethod, payLoad)
Internal method.(For google app integ).
source code
Instance Variables [hide private]
  authtoken
Internal method.
Method Details [hide private]

__init__(self, authtoken)
(Constructor)

source code 

Creates a new ReportClient instance.

Parameters:
  • authtoken (string) - User's authtoken.

handleResponse(self, response, action, callBackData)

source code 

Internal method. To be used by classes extending this.

addRow(self, tableURI, columnValues, config=None)

source code 

Adds a row to the specified table identified by the URI.

Parameters:
  • tableURI (string) - The URI of the table. See getURI.
  • columnValues (dictionary) - Contains the values for the row. The column name(s) are the key.
  • config (dictionary) - Contains any additional control parameters. Can be None.
Returns: dictionary
The values of the row.
Raises:
  • ServerError - If the server has recieved the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

deleteData(self, tableURI, criteria, config)

source code 

Delete the data in the specified table identified by the URI.

Parameters:
  • tableURI (string) - The URI of the table. See getURI.
  • criteria (string) - The criteria to be applied for deleting. Only rows matching the criteria will be updated. Can be None. Incase it is None, then all rows will be deleted.
  • config (dictionary) - Contains any additional control parameters. Can be None.
Raises:
  • ServerError - If the server has recieved the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

updateData(self, tableURI, columnValues, criteria, config=None)

source code 

update the data in the specified table identified by the URI.

Parameters:
  • tableURI (string) - The URI of the table. See getURI.
  • columnValues (dictionary) - Contains the values for the row. The column name(s) are the key.
  • criteria (string) - The criteria to be applied for updating. Only rows matching the criteria will be updated. Can be None. Incase it is None, then all rows will be updated.
  • config (dictionary) - Contains any additional control parameters. Can be None.
Raises:
  • ServerError - If the server has recieved the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

importData(self, tableURI, importType, importContent, importConfig=None)

source code 

Bulk import data into the table identified by the URI.

Parameters:
  • tableURI (string) - The URI of the table. See getURI.
  • importType (string) - The type of import. Can be one of
    1. APPEND
    2. TRUNCATEADD
    3. UPDATEADD

    See Import types for more details.

  • importContent (string) - The data in csv format.
  • importConfig (dictionary) - Contains any additional control parameters. See Import types for more details.
Returns: ImportResult
An ImportResult containing the results of the Import
Raises:
  • ServerError - If the server has recieved the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

importDataAsString(self, tableURI, importType, importContent, importConfig=None)

source code 

Bulk import data into the table identified by the URI.

Parameters:
  • tableURI (string) - The URI of the table. See getURI.
  • importType (string) - The type of import. Can be one of
    1. APPEND
    2. TRUNCATEADD
    3. UPDATEADD

    See Import types for more details.

  • importContent (string) - The data in csv format or json.
  • importConfig (dictionary) - Contains any additional control parameters. See Import types for more details.
Returns: ImportResult
An ImportResult containing the results of the Import.
Raises:
  • ServerError - If the server has recieved the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

exportData(self, tableOrReportURI, format, exportToFileObj, criteria=None, config=None)

source code 

Export the data in the specified table identified by the URI.

Parameters:
  • tableOrReportURI (string) - The URI of the table. See getURI.
  • format (string) - The format in which the data is to be exported. See Supported Export Formats for the supported types.
  • exportToFileObj (file) - File (or file like object) to which the exported data is to be written
  • criteria (string) - The criteria to be applied for exporting. Only rows matching the criteria will be exported. Can be None. Incase it is None, then all rows will be exported.
  • config (dictionary) - Contains any additional control parameters. Can be None.
Raises:
  • ServerError - If the server has recieved the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

exportDataUsingSQL(self, tableOrReportURI, format, exportToFileObj, sql, config=None)

source code 

Export the data with the specified SQL query identified by the URI.

Parameters:
  • tableOrReportURI (string) - The URI of the database. See getDBURI.
  • format (string) - The format in which the data is to be exported. See Supported Export Formats for the supported types.
  • exportToFileObj (file) - File (or file like object) to which the exported data is to be written
  • sql (string) - The sql whose output need to be exported.
  • config (dictionary) - Contains any additional control parameters. Can be None.
Raises:
  • ServerError - If the server has recieved the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

copyDatabase(self, dbURI, config=None)

source code 

Copy the specified database identified by the URI.

Parameters:
  • dbURI (string) - The URI of the database. See getDBURI.
  • config (dictionary) - Contains any additional control parameters like ZOHO_DATABASE_NAME.
Returns: string
The new database id.
Raises:
  • ServerError - If the server has recieved the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

deleteDatabase(self, userURI, databaseName, config=None)

source code 

Delete the specified database.

Parameters:
  • userURI (string) - The URI of the user. See getUserURI.
  • databaseName (string) - The name of the database to be deleted.
  • config (dictionary) - Contains any additional control parameters.
Raises:
  • ServerError - If the server has recieved the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

enableDomainDB(self, userUri, dbName, domainName, config=None)

source code 

Enable database for custom domain.

Parameters:
  • userUri (string) - The URI of the user. See getUserURI.
  • dbName (string) - The database name.
  • domainName (string) - The domain name.
  • config (dictionary) - Contains any additional control parameters. Can be None.
Returns: dictionary
Domain database status.
Raises:
  • ServerError - If the server has recieved the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

disableDomainDB(self, userUri, dbName, domainName, config=None)

source code 

Disable database for custom domain.

Parameters:
  • userUri (string) - The URI of the user. See getUserURI.
  • dbName (string) - The database name.
  • domainName (string) - The domain name.
  • config (dictionary) - Contains any additional control parameters. Can be None.
Returns: dictionary
Domain database status.
Raises:
  • ServerError - If the server has recieved the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

createTable(self, dbURI, tableDesign, config=None)

source code 

Create a table in the specified database.

Parameters:
  • dbURI (string) - The URI of the database. See getDBURI.
  • tableDesign (string) - Table structure in JSON format (includes table name, description, folder name, column and lookup details, is system table).
  • config (dictionary) - Contains any additional control parameters. Can be None.
Raises:
  • ServerError - If the server has recieved the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

autoGenReports(self, tableURI, source, config=None)

source code 

Generate reports for the particular table.

Parameters:
  • tableURI (string) - The URI of the table. See getURI.
  • source (string) - Source should be column or table.
  • config (dictionary) - Contains any additional control parameters. Can be None.
Returns: dictionary
Auto generate report result.
Raises:
  • ServerError - If the server has recieved the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

createSimilarViews(self, tableURI, refView, folderName, customFormula, aggFormula, config=None)

source code 

This method is used to create similar views .

Parameters:
  • tableURI (string) - The URI of the table. See getURI.
  • refView (string) - It contains the refrence view name.
  • folderName (string) - It contains the folder name where the reports to be saved.
  • customFormula (bool) - If its true the reports created with custom formula.
  • aggFormula (bool) - If its true the reports created with aggrigate formula.
  • config (dictionary) - Contains any additional control parameters. Can be None.
Returns: dictionary
Generated reports status.
Raises:
  • ServerError - If the server has recieved the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

renameView(self, dbURI, viewName, newViewName, viewDesc='', config=None)

source code 

Rename the specified view with the new name and description.

Parameters:
  • dbURI (string) - The URI of the database. See getDBURI.
  • viewName (string) - Current name of the view.
  • newViewName (string) - New name for the view.
  • viewDesc (string) - New description for the view.
  • config (dictionary) - Contains any additional control parameters. Can be None.
Raises:
  • ServerError - If the server has recieved the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

copyReports(self, dbURI, views, dbName, dbKey, config=None)

source code 

The Copy Reports API is used to copy one or more reports from one database to another within the same account or even across user accounts.

Parameters:
  • dbURI (string) - The URI of the database. See getDBURI.
  • views (string) - This parameter holds the list of view names.
  • dbName (string) - The database name where the report's had to be copied.
  • dbKey (string) - The secret key used for allowing the user to copy the report.
  • config (dictionary) - Contains any additional control parameters. Can be None.
Raises:
  • ServerError - If the server has recieved the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

copyFormula(self, tableURI, formula, dbName, dbKey, config=None)

source code 

The Copy Formula API is used to copy one or more formula columns from one table to another within the same database or across databases and even across one user account to another.

Parameters:
  • tableURI (string) - The URI of the table. See getURI.
  • formula (string) - This parameter holds the list of formula names.
  • dbName (string) - The database name where the formula's had to be copied.
  • dbKey (string) - The secret key used for allowing the user to copy the formula.
  • config (dictionary) - Contains any additional control parameters. Can be None.
Raises:
  • ServerError - If the server has recieved the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

addColumn(self, tableURI, columnName, dataType, config=None)

source code 

Adds a column into ManageEngine Analytics Plus Table.

Parameters:
  • tableURI (string) - The URI of the table. See getURI.
  • columnName (string) - The column name to be added into ManageEngine Analytics Plus Table.
  • dataType (string) - The data type of the column to be added into ManageEngine Analytics Plus Table.
  • config (dictionary) - Contains any additional control parameters.
Raises:
  • ServerError - If the server has recieved the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

deleteColumn(self, tableURI, columnName, config=None)

source code 

Deletes a column from ManageEngine Analytics Plus Table.

Parameters:
  • tableURI (string) - The URI of the table. See getURI.
  • columnName (string) - The column name to be deleted from ManageEngine Analytics Plus Table.
  • config (dictionary) - Contains any additional control parameters.
Raises:
  • ServerError - If the server has recieved the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

renameColumn(self, tableURI, oldColumnName, newColumnName, config=None)

source code 

Deactivate the users in the ManageEngine Analytics Plus Account.

Parameters:
  • tableURI (string) - The URI of the table. See getURI.
  • oldColumnName (string) - The column name to be renamed in ManageEngine Analytics Plus Table.
  • newColumnName (string) - New name for the column.
  • config (dictionary) - Contains any additional control parameters.
Raises:
  • ServerError - If the server has recieved the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

hideColumn(self, tableURI, columnNames, config=None)

source code 

Hide the columns in the table.

Parameters:
  • tableURI (string) - The URI of the table. See getURI.
  • columnNames (list) - Contains list of column names.
  • config (dictionary) - Contains any additional control parameters. Can be None.
Returns: list
Column status.
Raises:
  • ServerError - If the server has recieved the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

showColumn(self, tableURI, columnNames, config=None)

source code 

Show the columns in the table.

Parameters:
  • tableURI (string) - The URI of the table. See getURI.
  • columnNames (list) - Contains list of column names.
  • config (dictionary) - Contains any additional control parameters. Can be None.
Returns: list
Column status.
Raises:
  • ServerError - If the server has recieved the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

addLookup(self, tableURI, columnName, referedTable, referedColumn, onError, config=None)

source code 

Add the lookup for the given column.

Parameters:
  • tableURI (string) - The URI of the table. See getURI.
  • 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 incase there is an error during lookup.
  • config (dictionary) - Contains any additional control parameters. Can be None.
Raises:
  • ServerError - If the server has recieved the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

removeLookup(self, tableURI, columnName, config=None)

source code 

Remove the lookup for the given column.

Parameters:
  • tableURI (string) - The URI of the table. See getURI.
  • columnName (string) - Name of the column.
  • config (dictionary) - Contains any additional control parameters. Can be None.
Raises:
  • ServerError - If the server has recieved the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

getDatabaseMetadata(self, requestURI, metadata, config=None)

source code 

This method is used to get the meta information about the reports.

Parameters:
  • requestURI (string) - The URI of the database or table.
  • metadata (string) - It specifies the information to be fetched.
  • config (dictionary) - Contains any additional control parameters. Can be None.
Returns: dictionary
The metadata of the database.
Raises:
  • ServerError - If the server has recieved the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

getDatabaseName(self, userURI, dbid, config=None)

source code 

Get database name for a specified database identified by the URI.

Parameters:
  • userURI (string) - The URI of the user. See getUserURI.
  • dbid (string) - The ID of the database.
  • config (dictionary) - Contains any additional control parameters. Can be None.
Returns: string
The Database name.
Raises:
  • ServerError - If the server has recieved the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

isDbExist(self, userURI, dbName, config=None)

source code 

Check wheather the database is exist or not.

Parameters:
  • userURI (string) - The URI of the user. See getUserURI.
  • dbName (string) - Database name.
  • config (dictionary) - Contains any additional control parameters. Can be None.
Returns: string
Return wheather the database is exist or not.
Raises:
  • ServerError - If the server has recieved the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

getCopyDBKey(self, dbURI, config=None)

source code 

Get copy database key for specified database identified by the URI.

Parameters:
  • dbURI (string) - The URI of the database. See getDBURI.
  • config (dictionary) - Contains any additional control parameters like ZOHO_REGENERATE_KEY. Can be None.
Returns: string
Copy Database key.
Raises:
  • ServerError - If the server has recieved the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

getViewName(self, userURI, objid, config=None)

source code 

This function returns the name of a view in ManageEngine Analytics Plus.

Parameters:
  • userURI (string) - The URI of the user. See getUserURI.
  • objid (string) - The view id (object id).
  • config (dictionary) - Contains any additional control parameters. Can be None.
Returns: string
The View name.
Raises:
  • ServerError - If the server has recieved the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

getInfo(self, tableURI, config=None)

source code 

This method returns the Database ID (DBID) and View ID (OBJID) of the corresponding Database.

Parameters:
  • tableURI (string) - The URI of the table. See getURI.
  • config (dictionary) - Contains any additional control parameters. Can be None.
Returns: dictionary
The View-Id (object id) and Database-Id.
Raises:
  • ServerError - If the server has recieved the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

shareView(self, dbURI, emailIds, views, criteria=None, config=None)

source code 

This method is used to share the views (tables/reports/dashboards) created in ManageEngine Analytics Plus with users.

Parameters:
  • dbURI (string) - The URI of the database. See getDBURI.
  • emailIds (string) - It contains the owners email-id.
  • views (string) - It contains the view names.
  • criteria (string) - Set criteria for share. Can be None.
  • config (dictionary) - Contains any additional control parameters. Can be None.
Raises:
  • ServerError - If the server has recieved the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

removeShare(self, dbURI, emailIds, config=None)

source code 

This method is used to remove the shared views (tables/reports/dashboards) in ManageEngine Analytics Plus from the users.

Parameters:
  • dbURI (string) - The URI of the database. See getDBURI.
  • emailIds (string) - It contains the owners email-id.
  • config (dictionary) - Contains any additional control parameters. Can be None.
Raises:
  • ServerError - If the server has recieved the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

addDbOwner(self, dbURI, emailIds, config=None)

source code 

This method is used to add new owners to the reports database.

Parameters:
  • dbURI (string) - The URI of the database. See getDBURI.
  • emailIds (string) - It contains the owners email-id.
  • config (dictionary) - Contains any additional control parameters. Can be None.
Raises:
  • ServerError - If the server has recieved the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

removeDbOwner(self, dbURI, emailIds, config=None)

source code 

This method is used to remove the existing owners from the reports database.

Parameters:
  • dbURI (string) - The URI of the database. See getDBURI.
  • emailIds (string) - It contains the owners email-id.
  • config (dictionary) - Contains any additional control parameters. Can be None.
Raises:
  • ServerError - If the server has recieved the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

getShareInfo(self, dbURI, config=None)

source code 

Get the shared informations.

Parameters:
  • dbURI (string) - The URI of the database. See getDBURI.
  • config (dictionary) - Contains any additional control parameters like ZOHO_REGENERATE_KEY. Can be None.
Returns: ShareInfo
ShareInfo object.
Raises:
  • ServerError - If the server has recieved the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

getViewUrl(self, tableURI, config=None)

source code 

This method returns the URL to access the mentioned view.

Parameters:
  • tableURI (string) - The URI of the table. See getURI.
  • config (dictionary) - Contains any additional control parameters. Can be None.
Returns: string
The view URI.
Raises:
  • ServerError - If the server has recieved the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

getEmbedUrl(self, tableURI, criteria=None, config=None)

source code 

This method is used to get the embed URL of the particular table / view. This API is available only for the White Label Administrator.

Parameters:
  • tableURI (string) - The URI of the table. See getURI.
  • criteria (string) - Set criteria for url. Can be None.
  • config (dictionary) - Contains any additional control parameters. Can be None.
Returns: string
The embed URI.
Raises:
  • ServerError - If the server has recieved the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

getUsers(self, userURI, config=None)

source code 

Get users list for the user account.

Parameters:
  • userURI (string) - The URI of the user. See getUserURI.
  • config (dictionary) - Contains any additional control parameters. Can be None.
Returns: list
The list of user details.
Raises:
  • ServerError - If the server has recieved the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

addUser(self, userURI, emailIds, config=None)

source code 

Add the users to the ManageEngine Analytics Plus Account.

Parameters:
  • userURI (string) - The URI of the user. See getUserURI.
  • emailIds (string) - The email addresses of the users to be added to the ManageEngine Analytics Plus Account separated by comma.
  • config (dictionary) - Contains any additional control parameters.
Raises:
  • ServerError - If the server has recieved the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

removeUser(self, userURI, emailIds, config=None)

source code 

Remove the users from the ManageEngine Analytics Plus Account.

Parameters:
  • userURI (string) - The URI of the user. See getUserURI.
  • emailIds (string) - The email addresses of the users to be removed from the Zoho Reports Account separated by comma.
  • config (dictionary) - Contains any additional control parameters.
Raises:
  • ServerError - If the server has recieved the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

activateUser(self, userURI, emailIds, config=None)

source code 

Activate the users in the ManageEngine Analytics Plus Account.

Parameters:
  • userURI (string) - The URI of the user. See getUserURI.
  • emailIds (string) - The email addresses of the users to be activated in the Zoho Reports Account separated by comma.
  • config (dictionary) - Contains any additional control parameters.
Raises:
  • ServerError - If the server has recieved the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

deActivateUser(self, userURI, emailIds, config=None)

source code 

Deactivate the users in the ManageEngine Analytics Plus Account.

Parameters:
  • userURI (string) - The URI of the user. See getUserURI.
  • emailIds (string) - The email addresses of the users to be deactivated in the Zoho Reports Account separated by comma.
  • config (dictionary) - Contains any additional control parameters.
Raises:
  • ServerError - If the server has recieved the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

getPlanInfo(self, userURI, config=None)

source code 

Get the plan informations.

Parameters:
  • userURI (string) - The URI of the user. See getUserURI.
  • config (dictionary) - Contains any additional control parameters like ZOHO_REGENERATE_KEY. Can be None.
Returns: PlanInfo
PlanInfo object.
Raises:
  • ServerError - If the server has recieved the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

getUserURI(self, dbOwnerName)

source code 

Returns the URI for the specified user..

Parameters:
  • dbOwnerName (string) - User email-id of the database.
Returns: string
The URI for the specified user.

getDBURI(self, dbOwnerName, dbName)

source code 

Returns the URI for the specified database.

Parameters:
  • dbOwnerName (string) - The owner of the database.
  • dbName (string) - The name of the database.
Returns: string
The URI for the specified database.

getURI(self, dbOwnerName, dbName, tableOrReportName)

source code 

Returns the URI for the specified database table (or report).

Parameters:
  • dbOwnerName (string) - The owner of the database containing the table (or report).
  • dbName (string) - The name of the database containing the table (or report).
  • tableOrReportName (string) - The name of the table (or report).
Returns: string
The URI for the specified table (or report).

Instance Variable Details [hide private]

authtoken

Internal method. To send request and receive response from server