public class ReportClient extends BaseClient
Modifier and Type | Field and Description |
---|---|
static int |
retryCount |
accessToken, authtoken, clientId, clientSecret, DEFAULTTIMEOUT, deleteTempCSVFile, DELIMITERS, domainAuthorization, iamServerURL, oauthConfFilePath, proxyInfo, QUOTED_CHARS, readTimeout, READTIMEOUT, refreshToken, reportServerURL, skipParseError, sslSocketFactory, timeOut
Constructor and Description |
---|
ReportClient(java.lang.String clientId,
java.lang.String clientSecret,
java.lang.String refreshToken)
Creates a new
ReportClient instance with OAuth. |
Modifier and Type | Method and Description |
---|---|
void |
activateUser(java.lang.String userURI,
java.lang.String emailIds,
java.util.Map config)
Activates the specified user(s) in your Zoho Analytics Account.
|
void |
addColumn(java.lang.String tableURI,
java.lang.String columnName,
java.lang.String dataType,
java.util.Map config)
Add a specified column in Zoho Analytics Table.
|
void |
addDbOwner(java.lang.String dbURI,
java.lang.String emailIds,
java.util.Map config)
This method is used to add new admins to the analytics workspace.
|
void |
addGroupMembers(java.lang.String dbURI,
org.json.JSONObject config)
Add new members for the specified group.
|
void |
addLookup(java.lang.String tableURI,
java.lang.String columnName,
java.lang.String referredTable,
java.lang.String referredColumn,
java.lang.String ifErrorOnCreation,
java.util.Map config)
Adds the lookup in the specified child table.
|
java.util.Map |
addRow(java.lang.String tableURI,
java.util.Map columnValues,
java.util.Map config)
Adds a row to the specified table identified by the URI.
|
void |
addUser(java.lang.String userURI,
java.lang.String emailIds,
java.util.Map config)
Adds the specified user(s) into your Zoho Analytics Account.
|
java.util.Map |
autoGenReports(java.lang.String tableURI,
java.lang.String source,
java.util.Map config)
Generate reports for the particular table.
|
java.lang.String |
changeUserRole(java.lang.String userURI,
java.lang.String emailIds,
java.lang.String role,
java.util.Map config)
Change the role of specified users with the new role provided.
|
java.lang.Long |
copyDatabase(java.lang.String dbURI,
java.util.Map config)
Copy a specified workspace identified by the URI.
|
void |
copyFormula(java.lang.String tableURI,
java.lang.String formula,
java.lang.String dbName,
java.lang.String dbKey,
java.util.Map config)
The Copy Formula API is used to copy one or more formula columns from one table to another within the same workspace or across workspaces and even across one user account to another.
|
void |
copyReport(java.lang.String dbURI,
java.lang.String views,
java.lang.String dbName,
java.lang.String dbKey,
java.util.Map config)
The Copy Reports API is used to copy one or more reports from one workspace to another within the same account or even across user accounts.
|
void |
createAnalysisView(java.lang.String dbURI,
java.lang.String viewDesign,
java.util.Map config)
Create a report in the specified workspace.
|
java.lang.Long |
createDatabase(java.lang.String userURI,
java.lang.String dbName,
java.util.Map config)
Create a blank workspace.
|
java.lang.String |
createGroup(java.lang.String dbURI,
org.json.JSONObject config)
Add a new group in the workspace identified by the URI.
|
java.util.Map |
createSimilarViews(java.lang.String tableURI,
java.lang.String refView,
java.lang.String folderName,
boolean customFormula,
boolean aggFormula,
java.util.Map config)
Create similar reports based on another table reports.
|
void |
createSlideShow(java.lang.String dbURI,
org.json.JSONObject config)
Create a new slideshow in the workspace identified by the URI.
|
void |
createTable(java.lang.String dbURI,
java.lang.String tableDesignJSON,
java.util.Map config)
Create a table in the specified workspace.
|
void |
deActivateUser(java.lang.String userURI,
java.lang.String emailIds,
java.util.Map config)
Deactivates the specified user(s) from your Zoho Analytics Account.
|
void |
deleteColumn(java.lang.String tableURI,
java.lang.String columnName,
java.util.Map config)
Delete a specified column from Zoho Analytics Table.
|
java.lang.Long |
deleteData(java.lang.String tableURI,
java.lang.String criteria,
java.util.Map config)
Delete the data in the specified table identified by the URI.
|
void |
deleteDatabase(java.lang.String userURI,
java.lang.String databaseName,
java.util.Map config)
Delete a specified workspace from a Zoho Analytics Account.
|
void |
deleteGroups(java.lang.String dbURI,
org.json.JSONObject config)
Deletes the specified groups from the workspace identified by the URI.
|
void |
deleteSlideShow(java.lang.String dbURI,
org.json.JSONObject config)
Delete the mentioned slides present in the workspace identified by the URI.
|
void |
deleteView(java.lang.String dbURI,
java.lang.String view,
boolean deleteDependentViews,
java.util.Map config)
Deletes the specified view from the workspace.
|
void |
disableDomainDB(java.lang.String userURI,
java.lang.String dbName,
java.lang.String domainName,
java.util.Map config)
Disable workspace for custom domain.
|
void |
enableDomainDB(java.lang.String userURI,
java.lang.String dbName,
java.lang.String domainName,
java.util.Map config)
Enable workspace for custom domain.
|
void |
exportData(java.lang.String tableOrReportURI,
java.lang.String format,
java.io.File exportToFile,
java.lang.String criteria,
java.util.Map exportConfig)
Exports the data/report of table (or report) identified by the URI.
|
void |
exportData(java.lang.String tableOrReportURI,
java.lang.String format,
java.io.OutputStream exportToStream,
java.lang.String criteria,
java.util.Map exportConfig)
Exports the data/report of table (or report) identified by the URI.
|
void |
exportDataUsingSQL(java.lang.String tableOrReportURI,
java.lang.String format,
java.io.File exportToFile,
java.lang.String sqlQuery,
java.util.Map exportConfig)
Exports the data with the given SQL Query.
|
void |
exportDataUsingSQL(java.lang.String tableOrReportURI,
java.lang.String format,
java.io.OutputStream exportToStream,
java.lang.String sqlQuery,
java.util.Map exportConfig)
Exports the data with the given SQL Query.
|
void |
exportDataUsingSQLWithMetaData(java.lang.String tableOrReportURI,
java.lang.String format,
java.io.OutputStream exportToStream,
java.lang.String sqlQuery,
java.util.Map exportConfig)
Internally used.
|
org.json.JSONObject |
folderList(java.lang.String dbURI,
java.util.Map config)
Returns the list of all accessible folders present in the workspace identified by the URI.
|
long |
getConnectionTimeOut()
Returns the timeout until a connection is established.A value of zero means the timeout is not used.
|
java.lang.String |
getCopyDBKey(java.lang.String dbURI,
java.util.Map config)
Get copy workspace key for a specified workspace identified by the URI.
|
org.w3c.dom.Document |
getDashboards(java.lang.String userURI,
java.util.Map config)
Returns the list of owned/shared dashboards present in the ZohoAnalytics account identified by the URI.
|
java.util.ArrayList |
getDataAsList(java.lang.String tableOrReportURI,
java.lang.String criteria,
java.util.Map exportConfig)
Internally Used.
|
java.util.ArrayList |
getDataAsListUsingSQL(java.lang.String tableOrReportURI,
java.lang.String sqlQuery,
java.util.Map exportConfig)
Internally Used.
|
java.lang.Long |
getDatabaseID(java.lang.String userURI,
java.lang.String dbName)
Fetches the workspace ID.
|
org.w3c.dom.Document |
getDatabaseMetaData(java.lang.String uri,
java.lang.String metadata,
java.util.Map config)
This method is used to get the meta information about the reports.
|
void |
getDatabaseMetaData(java.lang.String uri,
java.lang.String format,
java.lang.Object callBackData,
java.util.Map metadataParams)
Internally Used.
|
java.lang.String |
getDatabaseName(java.lang.String userURI,
java.lang.Long dbId)
Fetches workspace name.
|
java.lang.String |
getEmbedURL(java.lang.String tableOrReportURI,
java.util.Map config)
Returns Embed URL of table (or report) identified by the URI.
|
java.util.Map |
getInfo(java.lang.String tableURI,
java.util.Map config)
This method returns the workspace ID (DBID) and View ID (OBJID) of the corresponding workspace.
|
PlanInfo |
getPlanInfo(java.lang.String userURI,
java.util.Map config)
Getting the plan informations.
|
int |
getReadTimeout()
Returns the read timeout value which will wait for the packet to receive from the server end.
|
java.util.Map<java.lang.String,java.util.Set<java.lang.String>> |
getRelatedTablesList(java.lang.String dbURI,
java.lang.String[] tableNamesArray,
java.util.Map config)
This method will return the list of related tables (For Advanced Upload Tool)
|
ShareInfo |
getShareInfo(java.lang.String dbURI,
java.util.Map config)
Get sharing information of the particular workspace.
|
org.json.JSONObject |
getSlideInfo(java.lang.String dbURI,
org.json.JSONObject config)
Returns meta-information of the provided slide present in the workspace identified by the URI.
|
org.json.JSONObject |
getSlideList(java.lang.String dbURI,
org.json.JSONObject config)
Returns the list of all available slides present in the workspace identified by the URI.
|
java.lang.String |
getSlideUrl(java.lang.String dbURI,
org.json.JSONObject config)
This method returns the URL to access the mentioned slide present in the workspace identified by the URI.
|
java.lang.String |
getURI(java.lang.String userEmailId)
Returns the URI for the specified user login email id.
|
java.lang.String |
getURI(java.lang.String dbOwnerEmailId,
java.lang.String dbName)
Returns the URI for the specified workspace.
|
java.lang.String |
getURI(java.lang.String dbOwnerEmailId,
java.lang.String dbName,
java.lang.String tableOrReportName)
Returns the URI for the specified workspace table (or report).
|
static java.lang.String |
getURIForDB(java.lang.String oldURI,
java.lang.String dbName)
Internally Used.
|
java.util.ArrayList |
getUsers(java.lang.String userURI,
java.util.Map config)
Returns the list of users for the particular account.
|
org.w3c.dom.Document |
getViewInfo(java.lang.String dbURI,
java.lang.Long viewId)
Returns view details like view name,description,type from the the particular workspace identified by dbURI.
|
java.lang.String |
getViewName(java.lang.String userURI,
java.lang.Long objId,
java.util.Map config)
This function returns the name of a view in Zoho Analytics.
|
java.lang.String |
getViewURL(java.lang.String tableURI,
java.util.Map config)
This method returns the URL to access the mentioned view.
|
org.json.JSONObject |
groupInfo(java.lang.String dbURI,
org.json.JSONObject config)
Get meta information on the groups present in the workspace identified by the URI.
|
protected java.lang.Object |
handleResponse(org.apache.http.client.methods.HttpRequestBase request,
java.io.InputStream responseAsStream,
java.lang.String action,
java.lang.Object callBackData)
Internally Used.
|
java.util.Map |
hideColumn(java.lang.String tableURI,
java.util.List columnNames,
java.util.Map config)
Hide the shown columns in the particular table.
|
ImportResult |
importData(java.lang.String tableURI,
java.lang.String importType,
java.io.File csvFile,
java.util.Map importConfig,
boolean retryOnRequestTimeout)
Import the data contained in a CSV file into the table identified by the URI.
|
ImportResult |
importData(java.lang.String tableURI,
java.lang.String importType,
java.io.InputStream iStream,
java.util.Map<java.lang.String,java.lang.String> importConfig,
boolean retryOnRequestTimeout)
Import the data from the input stream into the table identified by the URI.
|
ImportResult |
importDataInBatches(java.lang.String tableURI,
java.lang.String importType,
java.io.File csvFile,
java.util.Map importConfig,
int batchSize) |
ImportResult |
importDataInBatches(java.lang.String tableURI,
java.lang.String importType,
java.io.File csvFile,
java.util.Map importConfig,
int batchSize,
java.lang.String reportsTableName,
java.lang.String configFilePath)
Import the data contained in a CSV file into the table identified by the URI.
|
ImportResult |
importDataInBatches(java.lang.String tableURI,
java.lang.String importType,
java.io.InputStream iStream,
java.util.Map<java.lang.String,java.lang.String> importConfig,
int batchSize)
Import data from the input stream into the table identified by the URI.
|
protected ImportResult |
importTblData(java.lang.String tableURI,
java.lang.String importType,
java.io.File csvFile,
java.util.Map importConfig,
java.util.Map dataTypeConfig,
boolean retryOnRequestTimeout) |
boolean |
isColumnExist(java.lang.String tableURI,
java.lang.String columnName,
java.util.Map config)
Checks whether the column exist or not in the view identified by tableURI.
|
boolean |
isDbExist(java.lang.String userURI,
java.lang.String dbName,
java.util.Map config)
Checks whether the workspace exist or not in the ZohoAnalytics account identified by the URI.
|
java.util.Map<java.lang.String,java.lang.String> |
isSystemTable(java.lang.String dbURI,
java.util.Map config)
To check the if the particular tables is system table identified by the URI.
|
boolean |
isValidate(java.lang.String userURI) |
boolean |
isViewExist(java.lang.String dbURI,
java.lang.String viewName,
java.util.Map config)
Checks whether the view exist or not in the workspace identified by dbURI.
|
static void |
main(java.lang.String[] args) |
org.json.JSONObject |
myWorkspaceList(java.lang.String userURI,
java.util.Map config)
Returns the list of all owned workspace present in the ZohoAnalytics account identified by the URI.
|
org.w3c.dom.Document |
recentItems(java.lang.String userURI)
Returns the details of recently accessed views from the ZohoAnalytics account identified by the URI.
|
void |
removeDbOwner(java.lang.String dbURI,
java.lang.String emailIds,
java.util.Map config)
This method is used to remove the existing admins from the analytics workspace.
|
void |
removeGroupMembers(java.lang.String dbURI,
org.json.JSONObject config)
Remove specified members from the group.
|
void |
removeLookup(java.lang.String tableURI,
java.lang.String columnName,
java.util.Map config)
Removes the lookup for the specified column in the given table.
|
void |
removeShare(java.lang.String dbURI,
java.lang.String emailIds,
java.util.Map config)
This method is used to remove the shared views (tables/reports/dashboards) in Zoho Analytics from the users.
|
void |
removeUser(java.lang.String userURI,
java.lang.String emailIds,
java.util.Map config)
Removes the specified user(s) from your Zoho Analytics Account.
|
void |
renameColumn(java.lang.String tableURI,
java.lang.String oldColumnName,
java.lang.String newColumnName,
java.util.Map config)
Rename a specified column in Zoho Analytics Table.
|
void |
renameView(java.lang.String dbURI,
java.lang.String viewName,
java.lang.String newViewName,
java.lang.String newViewDesc,
java.util.Map config)
Rename the specified view with the new name and description.
|
void |
saveAsViews(java.lang.String dbURI,
java.lang.String viewName,
java.lang.String newViewName,
java.util.Map config)
Copy views within the workspace(Duplicate views).
|
protected java.lang.Object |
sendRequest(org.apache.http.impl.client.HttpClientBuilder httpClientBuilder,
org.apache.http.client.methods.HttpRequestBase method,
java.lang.String action,
java.lang.Object callBackData) |
void |
setBatchRetryCountOnFailure(int retryCount) |
void |
setConnectionTimeOut(int timeOut)
Sets the timeout until a connection is established.
|
void |
setDomainAuthorization() |
void |
setNTLMProxy(java.lang.String proxyHost,
int proxyPort,
java.lang.String proxyUserName,
java.lang.String proxyPassword,
java.lang.String protocol)
Used to specify the proxy server details.
|
void |
setOAuthConfFilePath(java.lang.String oauthConfFilePath)
Internally Used.
|
void |
setProxy(java.lang.String proxyHost,
int proxyPort,
java.lang.String proxyUserName,
java.lang.String proxyPassword,
java.lang.String protocol)
Used to specify the proxy server details.
|
void |
setReadTimeout(int readTimeout)
Sets the read timeout which will wait for data response from the server end.
|
org.json.JSONObject |
sharedWorkspaceList(java.lang.String userURI,
java.util.Map config)
Returns the list of all sharec workspace present in the ZohoAnalytics account identified by the URI.
|
void |
shareView(java.lang.String dbURI,
java.lang.String views,
java.lang.String emailIds,
java.util.Map config)
This method is used to share the views (tables/reports/dashboards) created in Zoho Analytics with users.
|
java.util.Map |
showColumn(java.lang.String tableURI,
java.util.List columnNames,
java.util.Map config)
Show the hidden columns in the particular table.
|
void |
skipParseError() |
java.lang.String[] |
truncColumnHeaders(java.lang.String[] colNames,
java.util.Map importConfig) |
java.lang.String |
truncColumnHeaders(java.lang.String columnHeaders,
java.util.Map importConfig) |
void |
updateCloudDBConnection(java.lang.String tableURI,
org.json.JSONObject connInfo,
java.util.Map config)
Update cloud connection information of the given view identified by the URI.
|
java.lang.Long |
updateData(java.lang.String tableURI,
java.util.Map columnValues,
java.lang.String criteria,
java.util.Map config)
Update the data in the specified table identified by the URI.
|
void |
updateGroupInfo(java.lang.String dbURI,
org.json.JSONObject config)
Updates the specified group information from the workspace identified by the URI.
|
void |
updateRemoteDBConnection(java.lang.String dbURI,
org.json.JSONObject connInfo,
java.util.Map config)
Update remote connection information of the given live connect workspace identified by the URI.
|
void |
updateSlideShow(java.lang.String dbURI,
org.json.JSONObject config)
Update the mentioned slide information present in the workspace identified by the URI.
|
java.lang.String |
uriSplCharReplace(java.lang.String value)
Internal method for handling special characters in table or workspace name.
|
org.json.JSONObject |
viewList(java.lang.String dbURI,
java.util.Map config)
Returns the list of all accessible views present in the workspace identified by the URI.
|
org.json.JSONObject |
viewMetadata(java.lang.String tableURI,
java.util.Map config)
Returns metainfo of the given view identified by the URI.
|
eP, eQ, generateAccessToken, getAccessToken, getClientBuilder, logIfNeeded, logIfNeeded, setIamServerURL, setProxyOnClientBuilder, setReportServerURL, writeLine, writeLine
public ReportClient(java.lang.String clientId, java.lang.String clientSecret, java.lang.String refreshToken)
ReportClient
instance with OAuth.clientId
- The client ID string that has been obtained during the client registration.clientSecret
- The client secret string that has been obtained during the client registration.refreshToken
- The refresh token that has been generated from zoho account API.public void setOAuthConfFilePath(java.lang.String oauthConfFilePath)
public long getConnectionTimeOut()
long
value.public int getReadTimeout()
int
value.public void setConnectionTimeOut(int timeOut)
timeOut
- An int
value.public void setReadTimeout(int readTimeout)
readTimeout
- An code>int value.public void setBatchRetryCountOnFailure(int retryCount)
public void skipParseError()
public void setDomainAuthorization()
protected java.lang.Object handleResponse(org.apache.http.client.methods.HttpRequestBase request, java.io.InputStream responseAsStream, java.lang.String action, java.lang.Object callBackData) throws java.io.IOException, ParseException
handleResponse
in class BaseClient
java.io.IOException
ParseException
public java.lang.String getURI(java.lang.String dbOwnerEmailId, java.lang.String dbName, java.lang.String tableOrReportName) throws java.io.IOException
dbOwnerEmailId
- The admin of the workspace containing the table (or report).dbName
- The name of the workspace containing the table (or report).tableOrReportName
- The name of the table (or report).java.io.IOException
- If an error occurs.public java.lang.String getURI(java.lang.String userEmailId) throws java.io.IOException
userEmailId
- User email id to get the user URI.java.io.IOException
- If an error occurs.public java.lang.String getURI(java.lang.String dbOwnerEmailId, java.lang.String dbName) throws java.io.IOException
dbOwnerEmailId
- The owner of the workspace.dbName
- The name of the workspace.java.io.IOException
- If an error occurs.public java.lang.String uriSplCharReplace(java.lang.String value)
public static java.lang.String getURIForDB(java.lang.String oldURI, java.lang.String dbName) throws java.io.UnsupportedEncodingException
java.io.UnsupportedEncodingException
public java.util.Map addRow(java.lang.String tableURI, java.util.Map columnValues, java.util.Map config) throws java.io.IOException, ServerException, ParseException
tableURI
- The URI of the table. See getURI
.columnValues
- Contains the values for the row. The column name(s) are the key.config
- Contains any additional control parameters like ZOHO_DATE_FORMAT. Can be null.Map
of values of the row.java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.public java.lang.Long deleteData(java.lang.String tableURI, java.lang.String criteria, java.util.Map config) throws java.io.IOException, ServerException, ParseException
tableURI
- The URI of the table. See getURI
.criteria
- The criteria to be applied for deleting. Only rows matching the criteria will be deleted. Can be null. In-case it is null, then all rows will be deleted.config
- contains any additional control parameters. Can be null.java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.public java.lang.Long updateData(java.lang.String tableURI, java.util.Map columnValues, java.lang.String criteria, java.util.Map config) throws java.io.IOException, ServerException, ParseException
tableURI
- The URI of the table. See getURI
.columnValues
- Contains the values to be updated. The column name(s) are the key.criteria
- The criteria to be applied for updating. Only rows matching the criteria will be updated. Can be null. In-case it is null, then all rows will be updated.config
- contains any additional control parameters like ZOHO_DATE_FORMAT. Can be null.java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.public void exportData(java.lang.String tableOrReportURI, java.lang.String format, java.io.File exportToFile, java.lang.String criteria, java.util.Map exportConfig) throws java.io.IOException, ServerException, ParseException
tableOrReportURI
- The URI of the table. See getURI
.format
- The format in which the data is to be exported. See Supported Export Formats for the supported types.exportToFile
- Specifies the file to which the data is exported.criteria
- The criteria to be applied for exporting. Only rows matching the criteria will be exported. Can be null. In-case it is null, then all rows will be updated.exportConfig
- contains any additional control parameters. Can be null.java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.public void exportData(java.lang.String tableOrReportURI, java.lang.String format, java.io.OutputStream exportToStream, java.lang.String criteria, java.util.Map exportConfig) throws java.io.IOException, ServerException, ParseException
tableOrReportURI
- The URI of the table. See getURI
.format
- The format in which the data is to be exported. See Export Formats for the supported types.exportToStream
- Specifies the IO stream to which the data is to be exported.criteria
- The criteria to be applied for exporting. Only rows matching the criteria will be exported. Can be null. In-case it is null, then all rows will be updated.exportConfig
- Contains any additional control parameters. Can be null.java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.public void exportDataUsingSQL(java.lang.String tableOrReportURI, java.lang.String format, java.io.File exportToFile, java.lang.String sqlQuery, java.util.Map exportConfig) throws java.io.IOException, ServerException, ParseException
tableOrReportURI
- The URI of the workspace. See getURI
.format
- The format in which the data is to be exported. See Export Formats for the supported types.exportToFile
- Specifies the file to which the data is exported.sqlQuery
- The SQL Query whose output is exported.exportConfig
- contains any additional control parameters. Can be null.java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.public void exportDataUsingSQL(java.lang.String tableOrReportURI, java.lang.String format, java.io.OutputStream exportToStream, java.lang.String sqlQuery, java.util.Map exportConfig) throws java.io.IOException, ServerException, ParseException
tableOrReportURI
- The URI of the workspace. See getURI
.format
- The format in which the data is to be exported. See Export Formats for the supported types.exportToStream
- Specifies the IO stream to which the data is to be exported.sqlQuery
- The SQL Query whose output is exported.exportConfig
- Contains any additional control parameters. Can be null.java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.public void exportDataUsingSQLWithMetaData(java.lang.String tableOrReportURI, java.lang.String format, java.io.OutputStream exportToStream, java.lang.String sqlQuery, java.util.Map exportConfig) throws java.io.IOException, ServerException, ParseException
java.io.IOException
ServerException
ParseException
public java.util.ArrayList getDataAsListUsingSQL(java.lang.String tableOrReportURI, java.lang.String sqlQuery, java.util.Map exportConfig) throws java.io.IOException, ServerException, ParseException
java.io.IOException
ServerException
ParseException
public java.util.ArrayList getDataAsList(java.lang.String tableOrReportURI, java.lang.String criteria, java.util.Map exportConfig) throws java.io.IOException, ServerException, ParseException
java.io.IOException
ServerException
ParseException
public java.lang.Long createDatabase(java.lang.String userURI, java.lang.String dbName, java.util.Map config) throws java.io.IOException, ServerException, ParseException
userURI
- The URI of the user. See getURI
.config
- Contains any additional control parameters.dbName
- Name of the workspace.java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.public java.lang.Long copyDatabase(java.lang.String dbURI, java.util.Map config) throws java.io.IOException, ServerException, ParseException
dbURI
- The URI of the workspace. See getURI
.config
- Contains any additional control parameters.java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.public void deleteDatabase(java.lang.String userURI, java.lang.String databaseName, java.util.Map config) throws java.io.IOException, ServerException, ParseException
userURI
- The URI of the workspace. See getURI
.databaseName
- The name of the workspace to be deleted from the Zoho Analytics Account.config
- Contains any additional control parameters.java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.public void enableDomainDB(java.lang.String userURI, java.lang.String dbName, java.lang.String domainName, java.util.Map config) throws java.io.IOException, ServerException, ParseException
userURI
- The URI of the user. See getURI
.dbName
- The name of the workspace to be enabled to the client portal.domainName
- Client portal domain name.config
- Contains any additional control parameters. Can be null.java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.public void disableDomainDB(java.lang.String userURI, java.lang.String dbName, java.lang.String domainName, java.util.Map config) throws java.io.IOException, ServerException, ParseException
userURI
- the URI of the user. See getURI
.dbName
- The name of the workspace to be disabled to the client portal.domainName
- Client portal domain name.config
- Contains any additional control parameters. Can be null.java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.public void createTable(java.lang.String dbURI, java.lang.String tableDesignJSON, java.util.Map config) throws java.lang.Exception
dbURI
- The URI of the workspace.See getURI
.tableDesignJSON
- Table structure in JSON format.
Example ("TABLENAME":"tablename","TABLEDESCRIPTION":"description","FOLDERNAME": "foldername","COLUMNS":[{"COLUMNNAME":"name","DATATYPE":"datatype","DEFAULT":"null","MANDATORY":"yes","DESCRIPTION":"Testing"},{"COLUMNNAME":"name","DATATYPE":"datatype","DEFAULT":"null","MANDATORY":"yes","DESCRIPTION":"Testing","LOOKUPCOLUMN":{"TABLENAME":"tablename","COLUMNNAME":"columnname"}}]).config
- Contains any additional control parameters. Can be null.java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.java.lang.Exception
public void createAnalysisView(java.lang.String dbURI, java.lang.String viewDesign, java.util.Map config) throws java.lang.Exception
dbURI
- The URI of the workspace.See getURI
.viewDesign
- View structure in JSON format.
Example {"title":"chart","viewtype":"chart","axiscolumns":[{"type":"xaxis","columnname":"Region","operation":"actual"},{"type":"yaxis","columnname":"Sales","operation":"measure"},{"type":"yaxis","columnname":"Cost","operation":"sum"}]}.config
- Contains any additional control parameters. Can be null.java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.java.lang.Exception
public java.util.Map autoGenReports(java.lang.String tableURI, java.lang.String source, java.util.Map config) throws java.io.IOException, ServerException, ParseException
tableURI
- The URI of the table. See getURI
.source
- This will decide the report is based on TABLE or COLUMN.config
- Contains any additional control parameters. Can be null.Map
of result of the generated report.java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.public java.util.Map createSimilarViews(java.lang.String tableURI, java.lang.String refView, java.lang.String folderName, boolean customFormula, boolean aggFormula, java.util.Map config) throws java.io.IOException, ServerException, ParseException
tableURI
- The URI of the table. See getURI
.refView
- The reference table name.folderName
- Folder name where the reports to be saved.customFormula
- If true, it will create reports with custom formula.aggFormula
- If true, it will create reports with aggregate formula.config
- Contains any additional control parameters. Can be null.Map
of result of createSimilarViews.java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.public void saveAsViews(java.lang.String dbURI, java.lang.String viewName, java.lang.String newViewName, java.util.Map config) throws java.io.IOException, ServerException, ParseException
dbURI
- The URI of the workspace.See getURI
.viewName
- Name of the source view.newViewName
- New name for the view.config
- contains any additional control parameters.java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.public void renameView(java.lang.String dbURI, java.lang.String viewName, java.lang.String newViewName, java.lang.String newViewDesc, java.util.Map config) throws java.lang.Exception
dbURI
- The URI of the workspace.See getURI
.viewName
- Current name of the view.newViewName
- New name for the view.newViewDesc
- New description for the view.config
- Contains any additional control parameters.java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.java.lang.Exception
public void deleteView(java.lang.String dbURI, java.lang.String view, boolean deleteDependentViews, java.util.Map config) throws java.io.IOException, ServerException, ParseException
dbURI
- The URI of the workspace.See getURI
.view
- View name to be deleted.deleteDependentViews
- If set to True, then all dependent views will be deleted.If set to False, -> the deleteview action won't happen when dependent views are present, -> deleteview action processed when no dependent views are present.config
- Contains any additional control parameters. Can be null.java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.public void copyReport(java.lang.String dbURI, java.lang.String views, java.lang.String dbName, java.lang.String dbKey, java.util.Map config) throws java.io.IOException, ServerException, ParseException
dbURI
- The URI of the workspace. See getURI
.views
- This parameter holds the list of view names.dbName
- The workspace name where the reports had to be copied.dbKey
- The secret key used for allowing the user to copy the reports.config
- Can contains any additional parameters.java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.public void copyFormula(java.lang.String tableURI, java.lang.String formula, java.lang.String dbName, java.lang.String dbKey, java.util.Map config) throws java.io.IOException, ServerException, ParseException
tableURI
- The URI of the table. See getURI
.formula
- This parameter holds the list of formula names.dbName
- The workspace name where the formula's had to be copied.dbKey
- The secret key used for allowing the user to copy the formula.config
- Can contains any additional parameters.Can be null.java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.public void addColumn(java.lang.String tableURI, java.lang.String columnName, java.lang.String dataType, java.util.Map config) throws java.lang.Exception
tableURI
- The URI of the table. See getURI
.columnName
- The name of the column to be added in the Zoho Analytics Table.dataType
- The data-type of the column to be added in the Zoho Analytics Table.config
- Contains any additional control parameters. Can be null.java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.java.lang.Exception
public void deleteColumn(java.lang.String tableURI, java.lang.String columnName, java.util.Map config) throws java.lang.Exception
tableURI
- The URI of the table. See getURI
.columnName
- The name of the column to be deleted from the Zoho Analytics Table.config
- Contains any additional control parameters.Can e null.java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.java.lang.Exception
public boolean isValidate(java.lang.String userURI) throws java.lang.Exception
java.lang.Exception
public void renameColumn(java.lang.String tableURI, java.lang.String oldColumnName, java.lang.String newColumnName, java.util.Map config) throws java.lang.Exception
tableURI
- The URI of the table. See getURI
.oldColumnName
- The name of the column to be renamed in the Zoho Analytics Table.newColumnName
- New name of the column.config
- Contains any additional control parameters.java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.java.lang.Exception
public java.util.Map hideColumn(java.lang.String tableURI, java.util.List columnNames, java.util.Map config) throws java.io.IOException, ServerException, ParseException
tableURI
- The URI of the table. See getURI
.columnNames
- Contains the name of the columns.config
- Contains any additional control parameters. Can be null.Map
of values of the column details.java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.public java.util.Map showColumn(java.lang.String tableURI, java.util.List columnNames, java.util.Map config) throws java.io.IOException, ServerException, ParseException
tableURI
- The URI of the table. See getURI
.columnNames
- Contains the name of the columns.config
- Contains any additional control parameters. Can be null.Map
of values of the column details.java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.public void addLookup(java.lang.String tableURI, java.lang.String columnName, java.lang.String referredTable, java.lang.String referredColumn, java.lang.String ifErrorOnCreation, java.util.Map config) throws java.lang.Exception
tableURI
- The URI of the table. See getURI
.columnName
- The name of the column to be added in the Zoho Analytics Table.referredTable
- Name of the referred table.referredColumn
- Name of the column in the referred table.ifErrorOnCreation
- ABORT/EMPTY if error on conversion.config
- Contains any additional control parameters.java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.java.lang.Exception
public void removeLookup(java.lang.String tableURI, java.lang.String columnName, java.util.Map config) throws java.lang.Exception
tableURI
- The URI of the table.See getURI
.columnName
- Name of the column.config
- Contains any additional control parameters.java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.java.lang.Exception
public void updateCloudDBConnection(java.lang.String tableURI, org.json.JSONObject connInfo, java.util.Map config) throws java.io.IOException, ServerException, ParseException
tableURI
- The URI of the table.See getURI
.connInfo
- Contains connection information to be updated. Refer UPDATECLOUDDBCONNECTION API.config
- Contains any additional control parameters.java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.public void updateRemoteDBConnection(java.lang.String dbURI, org.json.JSONObject connInfo, java.util.Map config) throws java.io.IOException, ServerException, ParseException
dbURI
- The URI of the table.See getURI
.connInfo
- Contains connection information to be updated. Refer UPDATEREMOTEDBCONNECTION API.config
- Contains any additional control parameters.java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.public void getDatabaseMetaData(java.lang.String uri, java.lang.String format, java.lang.Object callBackData, java.util.Map metadataParams) throws java.io.IOException, ServerException, ParseException
java.io.IOException
ServerException
ParseException
public org.w3c.dom.Document getDatabaseMetaData(java.lang.String uri, java.lang.String metadata, java.util.Map config) throws java.io.IOException, ServerException, ParseException
uri
- The URI of the user or workspace.See getURI
.metadata
- It specifies the information to be fetched.config
- Can contains any additional parameters.Document
of workspace meta information.java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.public java.lang.String getDatabaseName(java.lang.String userURI, java.lang.Long dbId) throws java.lang.Exception
userURI
- The URL of the user. See getURI
.dbId
- Contains the workspace id for that workspace whose name has to be fetched.String
of workspace name for the specified workspace id.java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.java.lang.Exception
public java.lang.Long getDatabaseID(java.lang.String userURI, java.lang.String dbName) throws java.lang.Exception
userURI
- The URL of the user. See getURI
.dbName
- Contains the workspace name for that workspace whose id has to be fetched.String
of workspace id for the specified name.java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.java.lang.Exception
public java.lang.String getCopyDBKey(java.lang.String dbURI, java.util.Map config) throws java.io.IOException, ServerException, ParseException
dbURI
- The URI of the workspace. See getURI
.config
- Contains any additional control parameters. Can be null.String
of workspace key.java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.public boolean isDbExist(java.lang.String userURI, java.lang.String dbName, java.util.Map config) throws java.io.IOException, ServerException, ParseException
userURI
- The URI of the user. See getURI
.dbName
- Contains the name of the workspace.config
- Contains any additional control parameters. Can be null.True
, If workspace exist. False
, otherwise.java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.public boolean isViewExist(java.lang.String dbURI, java.lang.String viewName, java.util.Map config) throws java.io.IOException, ServerException, ParseException
dbURI
- The URI of the workspace. See getURI
.viewName
- Contains the name of the view.config
- Contains any additional control parameters. Can be null.True
, If view exist. False
, otherwise.java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.public boolean isColumnExist(java.lang.String tableURI, java.lang.String columnName, java.util.Map config) throws java.io.IOException, ServerException, ParseException
tableURI
- The URI of the table. See getURI
.columnName
- Contains the name of the column.config
- Contains any additional control parameters. Can be null.True
, If column exist. False
, otherwise.java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.public java.lang.String getViewName(java.lang.String userURI, java.lang.Long objId, java.util.Map config) throws java.io.IOException, ServerException, ParseException
userURI
- The URI of the user. See getURI
.objId
- Object id for the view.config
- Can contains any additional parameters.String
of view name.java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.public java.util.Map getInfo(java.lang.String tableURI, java.util.Map config) throws java.io.IOException, ServerException, ParseException
tableURI
- The URI of the table.See getURI
.config
- Can contains any additional parameters.Map
of DBID and OBJID.java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.public org.w3c.dom.Document getViewInfo(java.lang.String dbURI, java.lang.Long viewId) throws java.io.IOException, ServerException, ParseException
dbURI
- The URI of the workspace. See getURI
viewId
- The id of the view.Document
of view information.java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.public org.w3c.dom.Document recentItems(java.lang.String userURI) throws java.io.IOException, ServerException, ParseException
userURI
- The URL of the user. See getURI
.document
object.java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.public org.w3c.dom.Document getDashboards(java.lang.String userURI, java.util.Map config) throws java.io.IOException, ServerException, ParseException
userURI
- The URL of the user. See getURI
.Document
of all dashboards present in the organization.java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.public org.json.JSONObject myWorkspaceList(java.lang.String userURI, java.util.Map config) throws java.io.IOException, ServerException, ParseException
userURI
- The URL of the user. See getURI
.JSONObject
of all owned workspace present in the organization.java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.public org.json.JSONObject sharedWorkspaceList(java.lang.String userURI, java.util.Map config) throws java.io.IOException, ServerException, ParseException
userURI
- The URL of the user. See getURI
.JSONObject
of all shared workspace present in the organization.java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.public org.json.JSONObject viewList(java.lang.String dbURI, java.util.Map config) throws java.io.IOException, ServerException, ParseException
dbURI
- The URI of the workspace. See getURI
.JSONObject
of all accessible views present in the workspace.java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.public org.json.JSONObject folderList(java.lang.String dbURI, java.util.Map config) throws java.io.IOException, ServerException, ParseException
dbURI
- The URI of the workspace. See getURI
.JSONObject
of all accessible folders present in the workspace.java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.public org.json.JSONObject viewMetadata(java.lang.String tableURI, java.util.Map config) throws java.io.IOException, ServerException, ParseException
tableURI
- The URI of the table.See getURI
.JSONObject
contains metainfo of the provided view.java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.public void shareView(java.lang.String dbURI, java.lang.String views, java.lang.String emailIds, java.util.Map config) throws java.io.IOException, ServerException, ParseException
dbURI
- The URI of the workspace.See getURI
.views
- Contains the view names.emailIds
- Contains the owners email-id.config
- Can contains any additional parameters.java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.public void removeShare(java.lang.String dbURI, java.lang.String emailIds, java.util.Map config) throws java.io.IOException, ServerException, ParseException
dbURI
- The URI of the workspace.See getURI
.emailIds
- Contains the owners email-id.config
- Can contains any additional parameters.java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.public void addDbOwner(java.lang.String dbURI, java.lang.String emailIds, java.util.Map config) throws java.io.IOException, ServerException, ParseException
dbURI
- The URI of the workspace.See getURI
.emailIds
- Contains the owners email-id.config
- Can contains any additional parameters.java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.public void removeDbOwner(java.lang.String dbURI, java.lang.String emailIds, java.util.Map config) throws java.io.IOException, ServerException, ParseException
dbURI
- The URI of the workspace.See getURI
.emailIds
- Contains the owners email-id.config
- Can contains any additional parameters.java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.public ShareInfo getShareInfo(java.lang.String dbURI, java.util.Map config) throws java.lang.Exception
dbURI
- The URI of the workspace. See getURI
.config
- Contains any additional control parameters. Can be null. See User Configuration .java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.java.lang.Exception
public org.json.JSONObject groupInfo(java.lang.String dbURI, org.json.JSONObject config) throws java.io.IOException, ServerException, ParseException
dbURI
- The URI of the workspace. See getURI
.config
- Contains control parameters. Can be null. Refer Group Info API.JSONObject
of group information present in the workspace.java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.public java.lang.String createGroup(java.lang.String dbURI, org.json.JSONObject config) throws java.io.IOException, ServerException, ParseException
dbURI
- The URI of the workspace. See getURI
.config
- Contains control parameters. Refer Create Group API.String
holds id of the created group.java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.public void deleteGroups(java.lang.String dbURI, org.json.JSONObject config) throws java.io.IOException, ServerException, ParseException
dbURI
- The URI of the workspace. See getURI
.config
- Contains control parameters. Refer Delete Group API.java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.public void updateGroupInfo(java.lang.String dbURI, org.json.JSONObject config) throws java.io.IOException, ServerException, ParseException
dbURI
- The URI of the workspace. See getURI
.config
- Contains control parameters. Refer Update Group Info API.java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.public void addGroupMembers(java.lang.String dbURI, org.json.JSONObject config) throws java.io.IOException, ServerException, ParseException
dbURI
- The URI of the workspace. See getURI
.config
- Contains control parameters. Refer Add Group Members API.java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.public void removeGroupMembers(java.lang.String dbURI, org.json.JSONObject config) throws java.io.IOException, ServerException, ParseException
dbURI
- The URI of the workspace. See getURI
.config
- Contains control parameters. Refer Remove Group Members API.java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.public java.lang.String getViewURL(java.lang.String tableURI, java.util.Map config) throws java.io.IOException, ServerException, ParseException
tableURI
- The URI of the table.See getURI
.config
- Can contains any additional parameters.String
of view URL.java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.public java.lang.String getEmbedURL(java.lang.String tableOrReportURI, java.util.Map config) throws java.io.IOException, ServerException, ParseException
tableOrReportURI
- The URI of the table. See getURI
.config
- Contains any additional control parameters. Can be null. See User Configuration .String
of Embed URL.java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.public org.json.JSONObject getSlideList(java.lang.String dbURI, org.json.JSONObject config) throws java.io.IOException, ServerException, ParseException
dbURI
- The URI of the workspace. See getURI
.config
- Contains control parameters. Can be null. Refer GETSLIDELIST API.JSONObject
of all available slides present in the workspace.java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.public org.json.JSONObject getSlideInfo(java.lang.String dbURI, org.json.JSONObject config) throws java.io.IOException, ServerException, ParseException
dbURI
- The URI of the workspace. See getURI
.config
- Contains control parameters. Can be null. Refer GETSLIDEINFO API.JSONObject
of meta-information of the provided slide.java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.public java.lang.String getSlideUrl(java.lang.String dbURI, org.json.JSONObject config) throws java.io.IOException, ServerException, ParseException
dbURI
- The URI of the workspace. See getURI
.config
- Contains slide configuration. Refer GETSLIDEURL API.JSONObject
holds Slide URL.java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.public void createSlideShow(java.lang.String dbURI, org.json.JSONObject config) throws java.io.IOException, ServerException, ParseException
dbURI
- The URI of the workspace. See getURI
.config
- Contains slide configuration. Refer CREATESLIDESHOW API.java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.public void updateSlideShow(java.lang.String dbURI, org.json.JSONObject config) throws java.io.IOException, ServerException, ParseException
dbURI
- The URI of the workspace. See getURI
.config
- Contains slide configuration. Refer UPDATESLIDEINFO API.java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.public void deleteSlideShow(java.lang.String dbURI, org.json.JSONObject config) throws java.io.IOException, ServerException, ParseException
dbURI
- The URI of the workspace. See getURI
.config
- Contains slide configuration. Refer DELETESLIDESHOW API.java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.public java.util.ArrayList getUsers(java.lang.String userURI, java.util.Map config) throws java.io.IOException, ServerException, ParseException
userURI
- The URI of the user. See getURI
.config
- Contains any additional control parameters. Can be null.ArrayList
of users list.java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.public void addUser(java.lang.String userURI, java.lang.String emailIds, java.util.Map config) throws java.io.IOException, ServerException, ParseException
userURI
- The URL of the user. See getURI
.emailIds
- The email addresses of the users to be added to your Zoho Analytics Account separated by comma.config
- Contains any additional control parameters. Can be null.java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.public void removeUser(java.lang.String userURI, java.lang.String emailIds, java.util.Map config) throws java.io.IOException, ServerException, ParseException
userURI
- The URL of the user. See getURI
.emailIds
- The email addresses of the users to be removed from your Zoho Analytics Account separated by comma.config
- Contains any additional control parameters. Can be null.java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.public void activateUser(java.lang.String userURI, java.lang.String emailIds, java.util.Map config) throws java.io.IOException, ServerException, ParseException
userURI
- The URL of the user. See getURI
.emailIds
- The email addresses of the users to be activated in your Zoho Analytics Account separated by comma.config
- Contains any additional control parameters. Can be null.java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.public void deActivateUser(java.lang.String userURI, java.lang.String emailIds, java.util.Map config) throws java.io.IOException, ServerException, ParseException
userURI
- The URL of the user. See getURI
.emailIds
- The email addresses of the users to be deactivated from your Zoho Analytics Account separated by comma.config
- Contains any additional control parameters. Can be null.java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.public PlanInfo getPlanInfo(java.lang.String userURI, java.util.Map config) throws java.lang.Exception
userURI
- The URL of the user. See getURI
.config
- Contains any additional control parameters. Can be null.java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.java.lang.Exception
public java.lang.String changeUserRole(java.lang.String userURI, java.lang.String emailIds, java.lang.String role, java.util.Map config) throws java.io.IOException, ServerException, ParseException
userURI
- The URL of the user. See getURI
.emailIds
- The email addresses of the users whose role has to be changed, separated by comma.role
- New role for the users. can be one of "ORGADMIN"/"USER".config
- Contains any additional control parameters. Can be null.java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.public java.util.Map<java.lang.String,java.util.Set<java.lang.String>> getRelatedTablesList(java.lang.String dbURI, java.lang.String[] tableNamesArray, java.util.Map config) throws java.io.IOException, ServerException, ParseException
java.io.IOException
ServerException
ParseException
public java.util.Map<java.lang.String,java.lang.String> isSystemTable(java.lang.String dbURI, java.util.Map config) throws java.io.IOException, ServerException, ParseException
dbURI
- The URI of the workspace. See getURI
config
- Contains any additional control parameters.java.io.IOException
- if any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- if the server has received the request but did not process the request due to some error.ParseException
- if the server has responded but client was not able to parse the response.public ImportResult importData(java.lang.String tableURI, java.lang.String importType, java.io.InputStream iStream, java.util.Map<java.lang.String,java.lang.String> importConfig, boolean retryOnRequestTimeout) throws java.io.IOException, ServerException, ParseException, java.lang.Exception
tableURI
- The URI of the table. See getURI
.importType
- The type of import. Can be one of
iStream
- The input stream data to be imported into the table.importConfig
- Contains any additional control parameters.
See Importing CSV
for more details.ImportResult
value.java.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.java.lang.Exception
public ImportResult importDataInBatches(java.lang.String tableURI, java.lang.String importType, java.io.InputStream iStream, java.util.Map<java.lang.String,java.lang.String> importConfig, int batchSize) throws java.io.IOException, ServerException, ParseException, java.lang.Exception
tableURI
- The URI of the table. See getURI
.importType
- The type of import. Can be one of
iStream
- The input stream containing the csv data to be imported into the table.importConfig
- Contains any additional control parameters.
See Importing CSV
for more details.batchSize
- The number of rows to be imported in each batch.ImportResult
valuejava.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.java.lang.Exception
public ImportResult importDataInBatches(java.lang.String tableURI, java.lang.String importType, java.io.File csvFile, java.util.Map importConfig, int batchSize) throws java.io.IOException, ServerException, ParseException, java.lang.Exception
java.io.IOException
ServerException
ParseException
java.lang.Exception
public ImportResult importDataInBatches(java.lang.String tableURI, java.lang.String importType, java.io.File csvFile, java.util.Map importConfig, int batchSize, java.lang.String reportsTableName, java.lang.String configFilePath) throws java.io.IOException, ServerException, ParseException, java.lang.Exception
tableURI
- The URI of the table. See getURI
.importType
- The type of import. Can be one of
csvFile
- The file containing the csv data to be imported into the table.importConfig
- Contains any additional control parameters.
See Importing CSV
for more details.batchSize
- The number of rows to be imported in each batch.ImportResult
valuejava.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.java.lang.Exception
public java.lang.String truncColumnHeaders(java.lang.String columnHeaders, java.util.Map importConfig) throws java.lang.Exception
java.lang.Exception
public java.lang.String[] truncColumnHeaders(java.lang.String[] colNames, java.util.Map importConfig) throws java.lang.Exception
java.lang.Exception
public ImportResult importData(java.lang.String tableURI, java.lang.String importType, java.io.File csvFile, java.util.Map importConfig, boolean retryOnRequestTimeout) throws java.io.IOException, ServerException, ParseException
tableURI
- The URI of the table. See getURI
.importType
- The type of import. Can be one of
csvFile
- The file containing the csv data to be imported into the table.importConfig
- Contains any additional control parameters.See retryOnRequestTimeout
- If true then in-case of request timeout, the request is retried.ImportResult
valuejava.io.IOException
- If any communication related error(s) like request time out occurs when trying to contact the service.ServerException
- If the server has received the request but did not process the request due to some error.ParseException
- If the server has responded but client was not able to parse the response.protected ImportResult importTblData(java.lang.String tableURI, java.lang.String importType, java.io.File csvFile, java.util.Map importConfig, java.util.Map dataTypeConfig, boolean retryOnRequestTimeout) throws java.io.IOException, ServerException, ParseException
java.io.IOException
ServerException
ParseException
public void setProxy(java.lang.String proxyHost, int proxyPort, java.lang.String proxyUserName, java.lang.String proxyPassword, java.lang.String protocol)
proxyHost
- The hostname/ip address of the proxy-server.proxyPort
- The proxy server port.proxyUserName
- The user name for proxy-server authentication.proxyPassword
- The password for proxy-server authentication.protocol
- Can be any one of public void setNTLMProxy(java.lang.String proxyHost, int proxyPort, java.lang.String proxyUserName, java.lang.String proxyPassword, java.lang.String protocol)
proxyHost
- The host name of the NTLM proxy serverproxyPort
- The NTLM proxy server port.proxyUserName
- The user name for NTLM proxy-server authentication.proxyPassword
- The password for NTLM proxy-server authentication.protocol
- Can be any one of protected java.lang.Object sendRequest(org.apache.http.impl.client.HttpClientBuilder httpClientBuilder, org.apache.http.client.methods.HttpRequestBase method, java.lang.String action, java.lang.Object callBackData) throws java.io.IOException, ServerException, ParseException
sendRequest
in class BaseClient
java.io.IOException
ServerException
ParseException
public static void main(java.lang.String[] args)
Copyright © 2024 AdventNet Inc. All Rights Reserved.