Package com.zoho.analytics.client

Class WorkspaceAPI

java.lang.Object
com.zoho.analytics.client.WorkspaceAPI
public class WorkspaceAPI extends Object
WorkspaceAPI contains workspace level operations.

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    WorkspaceAPI(AnalyticsClient ac, long orgId, long workspaceId)
    Creates a new WorkspaceAPI instance.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addAdmins(org.json.JSONArray emailIds, org.json.JSONObject config)
    Add admins for the specified workspace.
    void
    addDefault()
    Adds a specified workspace as default.
    void
    addFavorite()
    Adds a specified workspace as favorite.
    void
    addGroupMembers(long groupId, org.json.JSONArray emailIds, org.json.JSONObject config)
    Add users to the specified group.
    void
    addTagToViews(long tagId, org.json.JSONArray viewIds, org.json.JSONObject config)
    Adds the specified tag to multiple views in the workspace.
    void
    addWorkspaceUsers(org.json.JSONArray emailIds, String role, org.json.JSONObject config)
    Add users to the specified workspace.
    org.json.JSONObject
    autoMLAnalysisPrediction(String analysisId, String modelId, org.json.JSONObject features, org.json.JSONObject config)
    Generates predictions using a trained AutoML model with sample input values.
    org.json.JSONObject
    backupWorkspaceNow(org.json.JSONObject config)
    Trigger an instant backup for the specified workspace.
    void
    changeAlertStatus(org.json.JSONArray alertIds, boolean enabled, org.json.JSONObject config)
    Enable or disable the specified data alerts in the workspace.
    void
    changeEmailScheduleStatus(long scheduleId, String operation)
    Update configurations of the specified email schedule in the workspace.
    void
    changeFolderHierarchy(long folderId, int hierarchy, org.json.JSONObject config)
    Swaps the hierarchy of a parent folder and a subfolder.
    void
    changeFolderPosition(long folderId, long referenceFolderId, org.json.JSONObject config)
    Place the folder above the reference folder.
    void
    changeWorkspaceUserRole(org.json.JSONArray emailIds, String role, org.json.JSONObject config)
    Change role of the specified users in the workspace.
    void
    changeWorkspaceUserStatus(org.json.JSONArray emailIds, String operation, org.json.JSONObject config)
    Change users staus in the specified workspace.
    long
    copy(String newWorkspaceName, org.json.JSONObject config, Long destOrgId)
    Copy the specified workspace from one organization to another or within the organization.
    org.json.JSONArray
    copyViews(org.json.JSONArray viewIds, long destWorkspaceId, org.json.JSONObject config, Long destOrgId)
    Copy the specified views from one workspace to another workspace.
    String
    createAutoMLAnalysis(String name, String trainingTableId, String predictionType, org.json.JSONArray features, int serverOption, org.json.JSONObject algorithms, org.json.JSONObject config)
    Creates a new AutoML analysis in the workspace.
    org.json.JSONObject
    createAutoMLAnalysisDeployment(String analysisId, String modelId, String inputTableId, String outputTable, org.json.JSONArray outputColumns, String predictionColumn, int serverOption, String importType, Object scheduleDetails, org.json.JSONObject config)
    Creates a deployment for an AutoML analysis model.
    long
    createDashboard(String displayName, String layout, org.json.JSONObject config)
    Create a dashboard in the specified workspace.
    long
    createEmailSchedule(String scheduleName, org.json.JSONArray viewIds, String format, org.json.JSONArray emailIds, org.json.JSONObject scheduleDetails, org.json.JSONObject config)
    Create an email schedule in the specified workspace.
    long
    createFolder(String folderName, org.json.JSONObject config)
    Create a folder in the specified workspace.
    String
    createGroup(String groupName, org.json.JSONArray emailIds, org.json.JSONObject config)
    Create a group in the specified workspace.
    long
    createQueryTable(String sqlQuery, String queryTableName, org.json.JSONObject config)
    Create a new query table in the workspace.
    long
    createReport(org.json.JSONObject config)
    Create a report in the specified workspace.
    long
    createSlideshow(String slideName, org.json.JSONArray viewIds, org.json.JSONObject config)
    Create a slideshow in the specified workspace.
    long
    createTable(org.json.JSONObject tableDesign)
    Create a table in the specified workspace.
    long
    createTag(String tagName, String colorCode, org.json.JSONObject config)
    Create a tag in the specified workspace.
    long
    createVariable(String variableName, int variableDataType, int variableType, org.json.JSONObject config)
    Create a variable in the workspace.
    void
    delete()
    Delete a specified workspace in the organization.
    void
    deleteAlerts(org.json.JSONArray alertIds, org.json.JSONObject config)
    Delete the specified data alerts from the workspace.
    void
    deleteAutoMLAnalysis(String analysisId, org.json.JSONObject config)
    Deletes a specified AutoML analysis from the workspace.
    void
    deleteAutoMLAnalysisDeployment(String analysisId, String deploymentId, org.json.JSONObject config)
    Deletes a specific AutoML deployment.
    void
    deleteAutoMLAnalysisModel(String analysisId, String modelId, org.json.JSONObject config)
    Deletes a specified model from an AutoML analysis.
    void
    deleteEmailSchedule(long scheduleId)
    Delete the specified email schedule in the workspace.
    void
    deleteFolder(long folderId)
    Delete a specified folder in the workspace.
    void
    deleteGroup(long groupId)
    Delete a specified group.
    void
    deleteSlideshow(long slideId)
    Delete a specified slideshow in the workspace.
    void
    deleteTag(long tagId)
    Delete the specified tag from the workspace.
    void
    deleteTrashView(long viewId, org.json.JSONObject config)
    Delete the specified view permanently from trash.
    void
    deleteVariable(long variableId)
    Delete a specified variable in the workspace.
    void
    deployAutoMLAnalysis(String analysisId, String deploymentId, org.json.JSONObject config)
    Executes a specific AutoML deployment.
    void
    disableDomainAccess()
    Disable workspace from the specified white label domain.
    void
    downloadWorkspaceBackup(long backupId, String filePath, org.json.JSONObject config)
    Download the specified workspace backup.
    void
    enableDomainAccess()
    Enable workspace to the specified white label domain.
    void
    exportAsTemplate(org.json.JSONArray viewIds, String filePath, org.json.JSONObject config)
    Export the mentioned views as templates.
    org.json.JSONArray
    getAdmins()
    Returns list of admins for the specified workspace.
    org.json.JSONObject
    getAggregateFormulaDependents(long formulaId)
    Returns list of all dependent views and formulas for the specified aggregate formula.
    org.json.JSONArray
    getAggregateFormulas(org.json.JSONObject config)
    Returns list of all aggregate formulas for the specified workspace.
    String
    getAggregateFormulaValue(long formulaId)
    Returns the value of the aggregate formula.
    org.json.JSONObject
    getAlertConfiguration(long alertId)
    Returns the configuration of the specified data alert.
    org.json.JSONObject
    getAlertEvents(long alertId, org.json.JSONObject config)
    Returns the execution events of the specified data alert.
    org.json.JSONArray
    getAlertsInWorkspace()
    Returns list of data alerts available in the specified workspace.
    org.json.JSONArray
    getAutoMLAnalysis()
    Returns list of AutoML analysis for the specified workspace.
    org.json.JSONObject
    getAutoMLAnalysisDetails(String analysisId)
    Retrieves detailed information for a specific AutoML analysis.
    org.json.JSONObject
    getDashboardMetadata(long dashboardId, org.json.JSONObject config)
    Returns the metadata of the specified dashboard.
    org.json.JSONArray
    getDatasources()
    Returns list of all datasource for the specified workspace.
    org.json.JSONObject
    getDeploymentDetails(String analysisId, String modelId)
    Returns deployment details for a specific AutoML analysis model.
    org.json.JSONArray
    getEmailSchedules()
    Returns list of email schedules available in the specified workspace.
    org.json.JSONArray
    getFolders()
    Returns list of all accessible folders for the specified workspace.
    org.json.JSONObject
    getGroupDetails(long groupId)
    Returns details of the specified group.
    org.json.JSONArray
    getGroups()
    Returns list of groups for the specified workspace.
    org.json.JSONArray
    getLinkableWorkspaces()
    Returns list of organizations and workspaces that can be linked to the specified master workspace.
    org.json.JSONArray
    getLinkedWorkspaces()
    Returns list of workspaces linked to the specified master workspace.
    org.json.JSONArray
    getLinkedWorkspaceSyncDetails(org.json.JSONArray sandboxIds, org.json.JSONObject config)
    Returns the sync details of the specified linked workspaces.
    org.json.JSONObject
    getQueryTableDetails(String queryTableId)
    Returns details of the specified query table.
    org.json.JSONArray
    getQueryTables(org.json.JSONObject config)
    Returns list of all query tables for the specified workspace.
    org.json.JSONObject
    getReportMetadata(long viewId)
    Returns the metadata of the specified report.
    String
    getSecretKey(org.json.JSONObject config)
    Returns the secret key of the specified workspace.
    org.json.JSONArray
    getSharedDetailsForViews(org.json.JSONArray viewIds)
    Returns shared details of the specified views.
    ShareInfo
    getShareInfo()
    Returns shared details of the specified workspace.
    org.json.JSONObject
    getSlideshowDetails(long slideId)
    Returns details of the specified slideshow.
    org.json.JSONArray
    getSlideshows()
    Returns list of slideshows for the specified workspace.
    String
    getSlideshowURL(long slideId, org.json.JSONObject config)
    Returns slide URL to access the specified slideshow.
    org.json.JSONArray
    getTaggedViews(long tagId)
    Returns the list of views associated with the specified tag.
    org.json.JSONArray
    getTags()
    Returns list of all tags for the specified workspace.
    org.json.JSONArray
    getTrashViews()
    Returns list of all views available in trash for the specified workspace.
    org.json.JSONObject
    getVariableDetails(long variableId)
    Returns details of the specified variable.
    org.json.JSONArray
    getVariables()
    Returns list of all variables for the specified workspace.
    org.json.JSONArray
    getViews()
    Deprecated.
    org.json.JSONArray
    getViews(org.json.JSONObject config)
    Returns list of all accessible views for the specified workspace.
    org.json.JSONObject
    getWorkspaceAccessRestrictions()
    Returns the access restriction settings configured for the specified workspace.
    org.json.JSONObject
    getWorkspaceBackups()
    Returns the backup configuration and the list of backups available for the specified workspace.
    org.json.JSONObject
    getWorkspaceBackupStatus(long backupId)
    Returns the status of the specified workspace backup.
    org.json.JSONObject
    getWorkspaceDetails(org.json.JSONObject config)
    Returns details of the specified workspace.
    org.json.JSONArray
    getWorkspaceLinkingCompatibility(org.json.JSONArray clients, org.json.JSONObject config)
    Returns the linking compatibility details for the specified client workspaces.
    org.json.JSONObject
    getWorkspaceMetadata()
    Internally used in JDBC driver
    org.json.JSONObject
    getWorkspaceRestoreStatus(long restoreId)
    Returns the status of the specified workspace restore.
    org.json.JSONArray
    getWorkspaceUsers()
    Returns list of users for the specified workspace.
    void
    linkWorkspaces(org.json.JSONArray clients, org.json.JSONObject config)
    Link the specified client workspaces to the master workspace.
    void
    makeDefaultFolder(long folderId)
    Make the specified folder as default.
    void
    moveViewsToFolder(long folderId, org.json.JSONArray viewIds, org.json.JSONObject config)
    Move views to the mentioned folder.
    void
    removeAdmins(org.json.JSONArray emailIds, org.json.JSONObject config)
    Remove admins from the specified workspace.
    void
    removeDefault()
    Remove a specified workspace from default.
    void
    removeFavorite()
    Remove a specified workspace from favorite.
    void
    removeGroupMembers(long groupId, org.json.JSONArray emailIds, org.json.JSONObject config)
    Remove users from the specified group.
    void
    removeShare(org.json.JSONArray viewIds, org.json.JSONArray emailIds, org.json.JSONObject config)
    Remove shared views for the specified users.
    void
    removeTagFromViews(long tagId, org.json.JSONArray viewIds, boolean dissociateAll, org.json.JSONObject config)
    Removes the specified tag from multiple views in the workspace.
    void
    removeWorkspaceUsers(org.json.JSONArray emailIds, org.json.JSONObject config)
    Remove users from the specified workspace.
    void
    rename(String workspaceName, org.json.JSONObject config)
    Rename a specified workspace in the organization.
    void
    renameFolder(long folderId, String folderName, org.json.JSONObject config)
    Rename a specified folder in the workspace.
    void
    renameGroup(long groupId, String groupName, org.json.JSONObject config)
    Rename a specified group.
    void
    restoreTrashView(long viewId, org.json.JSONObject config)
    Restore the specified view from trash.
    org.json.JSONObject
    restoreWorkspaceFromBackup(long backupId, boolean confirmRestore, org.json.JSONObject config)
    Restore the specified workspace from the given backup.
    void
    runAlert(long alertId, org.json.JSONObject config)
    Execute the specified data alert immediately.
    void
    shareViews(org.json.JSONArray viewIds, org.json.JSONArray emailIds, org.json.JSONObject permissions, org.json.JSONObject config)
    Share views to the specified users.
    void
    syncData(long datasourceId, org.json.JSONObject config)
    Initiate data sync for the specified datasource.
    void
    syncLinkedWorkspaces(String scope, org.json.JSONObject config)
    Sync the metadata of the master workspace to its linked client workspaces.
    void
    triggerEmailSchedule(long scheduleId)
    Trigger configured email schedules instantly.
    void
    unlinkWorkspaces(String scope, org.json.JSONObject config)
    Unlink the client workspaces from the specified master workspace.
    void
    updateAlert(long alertId, String alertName, org.json.JSONObject scheduleDetails, org.json.JSONArray rules, org.json.JSONObject config)
    Update the specified data alert in the workspace.
    void
    updateDashboard(long dashboardId, org.json.JSONObject config)
    Update the specified dashboard in the workspace.
    void
    updateDatasourceConnection(long datasourceId, org.json.JSONObject config)
    Update connection details for the specified datasource.
    long
    updateEmailSchedule(long scheduleId, org.json.JSONObject config)
    Update configurations of the specified email schedule in the workspace.
    void
    updateQueryTable(long viewId, String sqlQuery, org.json.JSONObject config)
    Update the mentioned query table in the workspace.
    void
    updateReport(long viewId, org.json.JSONObject config)
    Update the design and configuration of the specified report.
    void
    updateSlideshow(long slideId, org.json.JSONObject config)
    Update details of the specified slideshow.
    void
    updateTag(long tagId, org.json.JSONObject config)
    Update details of the specified tag in the workspace.
    void
    updateVariable(long variableId, String variableName, int variableDataType, int variableType, org.json.JSONObject config)
    Update details of the specified variable in the workspace.
    void
    updateWorkspaceAccessRestrictions(org.json.JSONObject config)
    Update the access restriction settings of the specified workspace.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • WorkspaceAPI

      protected WorkspaceAPI(AnalyticsClient ac, long orgId, long workspaceId)
      Creates a new WorkspaceAPI instance.
      Parameters:
      ac - AnalyticsClient instance.
      orgId - The ID of the organization.
      workspaceId - The ID of the workspace.

  • Method Details

    • getWorkspaceDetails

      public org.json.JSONObject getWorkspaceDetails(org.json.JSONObject config) throws ServerException, ParseException, IOException, org.json.JSONException
      Returns details of the specified workspace.
      Parameters:
      config - Contains any additional control configurations. Can be null.
      Returns:
      A JSONObject of workspace details.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • rename

      public void rename(String workspaceName, org.json.JSONObject config) throws ServerException, ParseException, IOException, org.json.JSONException
      Rename a specified workspace in the organization.
      Parameters:
      workspaceName - New name of the workspace.
      config - Contains any additional control configurations. Can be null.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • delete

      public void delete() throws ServerException, ParseException, IOException, org.json.JSONException
      Delete a specified workspace in the organization.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • getSecretKey

      public String getSecretKey(org.json.JSONObject config) throws ServerException, ParseException, IOException, org.json.JSONException
      Returns the secret key of the specified workspace.
      Parameters:
      config - Contains any additional control configurations. Can be null.
      Returns:
      A String of workspace secret key.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • copy

      public long copy(String newWorkspaceName, org.json.JSONObject config, Long destOrgId) throws ServerException, ParseException, IOException, org.json.JSONException
      Copy the specified workspace from one organization to another or within the organization.
      Parameters:
      newWorkspaceName - Name of the new workspace.
      config - Contains any additional control configurations. Can be null.
      destOrgId - Id of the organization where the destination workspace is present. Can be null.
      Returns:
      A long of new workspace id.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • addFavorite

      public void addFavorite() throws ServerException, ParseException, IOException, org.json.JSONException
      Adds a specified workspace as favorite.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • removeFavorite

      public void removeFavorite() throws ServerException, ParseException, IOException, org.json.JSONException
      Remove a specified workspace from favorite.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • addDefault

      public void addDefault() throws ServerException, ParseException, IOException, org.json.JSONException
      Adds a specified workspace as default.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • removeDefault

      public void removeDefault() throws ServerException, ParseException, IOException, org.json.JSONException
      Remove a specified workspace from default.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • enableDomainAccess

      public void enableDomainAccess() throws ServerException, ParseException, IOException, org.json.JSONException
      Enable workspace to the specified white label domain.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • disableDomainAccess

      public void disableDomainAccess() throws ServerException, ParseException, IOException, org.json.JSONException
      Disable workspace from the specified white label domain.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • getViews

      public org.json.JSONArray getViews() throws ServerException, ParseException, IOException, org.json.JSONException
      Deprecated.
      Throws:
      ServerException
      ParseException
      IOException
      org.json.JSONException

    • getViews

      public org.json.JSONArray getViews(org.json.JSONObject config) throws ServerException, ParseException, IOException, org.json.JSONException
      Returns list of all accessible views for the specified workspace.
      Parameters:
      config - Contains any additional control configurations. Can be null.
      Returns:
      A JSONArray of views list.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • createTable

      public long createTable(org.json.JSONObject tableDesign) throws ServerException, ParseException, IOException, org.json.JSONException
      Create a table in the specified workspace.
      Parameters:
      tableDesign - JSON object of table structure.
      Returns:
      A long of table id.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • copyViews

      public org.json.JSONArray copyViews(org.json.JSONArray viewIds, long destWorkspaceId, org.json.JSONObject config, Long destOrgId) throws ServerException, ParseException, IOException, org.json.JSONException
      Copy the specified views from one workspace to another workspace.
      Parameters:
      viewIds - The id of the views to be copied.
      destWorkspaceId - The destination workspace id.
      config - Contains any additional control configurations. Can be null.
      destOrgId - Id of the organization where the destination workspace is present. Can be null.
      Returns:
      A JSONArray of views list.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • getFolders

      public org.json.JSONArray getFolders() throws ServerException, ParseException, IOException, org.json.JSONException
      Returns list of all accessible folders for the specified workspace.
      Returns:
      A JSONArray of folders list.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • createFolder

      public long createFolder(String folderName, org.json.JSONObject config) throws ServerException, ParseException, IOException, org.json.JSONException
      Create a folder in the specified workspace.
      Parameters:
      folderName - The name of the folder.
      config - Contains any additional control configurations. Can be null.
      Returns:
      A long of folder id.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • renameFolder

      public void renameFolder(long folderId, String folderName, org.json.JSONObject config) throws ServerException, ParseException, IOException, org.json.JSONException
      Rename a specified folder in the workspace.
      Parameters:
      folderId - The id of the folder.
      folderName - The new name of the folder.
      config - Contains any additional control configurations. Can be null.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • deleteFolder

      public void deleteFolder(long folderId) throws ServerException, ParseException, IOException, org.json.JSONException
      Delete a specified folder in the workspace.
      Parameters:
      folderId - The id of the folder.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • getGroups

      public org.json.JSONArray getGroups() throws ServerException, ParseException, IOException, org.json.JSONException
      Returns list of groups for the specified workspace.
      Returns:
      A JSONArray of groups list.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • getGroupDetails

      public org.json.JSONObject getGroupDetails(long groupId) throws ServerException, ParseException, IOException, org.json.JSONException
      Returns details of the specified group.
      Parameters:
      groupId - The id of the group.
      Returns:
      A JSONObject of group details.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • createGroup

      public String createGroup(String groupName, org.json.JSONArray emailIds, org.json.JSONObject config) throws ServerException, ParseException, IOException, org.json.JSONException
      Create a group in the specified workspace.
      Parameters:
      groupName - Name of the group.
      emailIds - The email address of the users to be added to the group.
      config - Contains any additional control configurations. Can be null.
      Returns:
      A long of group id.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • renameGroup

      public void renameGroup(long groupId, String groupName, org.json.JSONObject config) throws ServerException, ParseException, IOException, org.json.JSONException
      Rename a specified group.
      Parameters:
      groupId - The id of the group.
      groupName - The new name of the group.
      config - Contains any additional control configurations. Can be null.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • deleteGroup

      public void deleteGroup(long groupId) throws ServerException, ParseException, IOException, org.json.JSONException
      Delete a specified group.
      Parameters:
      groupId - The id of the group.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • addGroupMembers

      public void addGroupMembers(long groupId, org.json.JSONArray emailIds, org.json.JSONObject config) throws ServerException, ParseException, IOException, org.json.JSONException
      Add users to the specified group.
      Parameters:
      groupId - The id of the group.
      emailIds - The email address of the users to be added to the group.
      config - Contains any additional control configurations. Can be null.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • removeGroupMembers

      public void removeGroupMembers(long groupId, org.json.JSONArray emailIds, org.json.JSONObject config) throws ServerException, ParseException, IOException, org.json.JSONException
      Remove users from the specified group.
      Parameters:
      groupId - The id of the group.
      emailIds - The email address of the users to be removed from the group.
      config - Contains any additional control configurations. Can be null.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • getAdmins

      public org.json.JSONArray getAdmins() throws ServerException, ParseException, IOException, org.json.JSONException
      Returns list of admins for the specified workspace.
      Returns:
      A JSONArray of workspace admins.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • addAdmins

      public void addAdmins(org.json.JSONArray emailIds, org.json.JSONObject config) throws ServerException, ParseException, IOException, org.json.JSONException
      Add admins for the specified workspace.
      Parameters:
      emailIds - The email address of the admin users to be added.
      config - Contains any additional control configurations. Can be null.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • removeAdmins

      public void removeAdmins(org.json.JSONArray emailIds, org.json.JSONObject config) throws ServerException, ParseException, IOException, org.json.JSONException
      Remove admins from the specified workspace.
      Parameters:
      emailIds - The email address of the admin users to be removed.
      config - Contains any additional control configurations. Can be null.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • getShareInfo

      public ShareInfo getShareInfo() throws ServerException, ParseException, IOException, org.json.JSONException
      Returns shared details of the specified workspace.
      Returns:
      A ShareInfo object.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • shareViews

      public void shareViews(org.json.JSONArray viewIds, org.json.JSONArray emailIds, org.json.JSONObject permissions, org.json.JSONObject config) throws ServerException, ParseException, IOException, org.json.JSONException
      Share views to the specified users.
      Parameters:
      viewIds - View ids which to be shared.
      emailIds - The email address of the users to whom the views need to be shared.
      permissions - Contains permission details.
      config - Contains any additional control configurations. Can be null.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • removeShare

      public void removeShare(org.json.JSONArray viewIds, org.json.JSONArray emailIds, org.json.JSONObject config) throws ServerException, ParseException, IOException, org.json.JSONException
      Remove shared views for the specified users.
      Parameters:
      viewIds - View ids whose sharing needs to be removed.
      emailIds - The email address of the users to whom the sharing need to be removed.
      config - Contains any additional control configurations. Can be null.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • getSharedDetailsForViews

      public org.json.JSONArray getSharedDetailsForViews(org.json.JSONArray viewIds) throws ServerException, ParseException, IOException, org.json.JSONException
      Returns shared details of the specified views.
      Parameters:
      viewIds - Ids of the view to be included in the slideshow.
      Returns:
      A JSONArray of shared info of views.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • getSlideshows

      public org.json.JSONArray getSlideshows() throws ServerException, ParseException, IOException, org.json.JSONException
      Returns list of slideshows for the specified workspace.
      Returns:
      A JSONArray of slideshows.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • getSlideshowDetails

      public org.json.JSONObject getSlideshowDetails(long slideId) throws ServerException, ParseException, IOException, org.json.JSONException
      Returns details of the specified slideshow.
      Parameters:
      slideId - The id of the slideshow.
      Returns:
      A JSONObject of slideshow details.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • getSlideshowURL

      public String getSlideshowURL(long slideId, org.json.JSONObject config) throws ServerException, ParseException, IOException, org.json.JSONException
      Returns slide URL to access the specified slideshow.
      Parameters:
      slideId - The id of the slideshow.
      config - Contains any additional control configurations. Can be null.
      Returns:
      A String of slideshow URL.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • createSlideshow

      public long createSlideshow(String slideName, org.json.JSONArray viewIds, org.json.JSONObject config) throws ServerException, ParseException, IOException, org.json.JSONException
      Create a slideshow in the specified workspace.
      Parameters:
      slideName - Name of the slideshow to be created.
      viewIds - Ids of the view to be included in the slideshow.
      config - Contains any additional control configurations. Can be null.
      Returns:
      A long of created slideshow id.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • updateSlideshow

      public void updateSlideshow(long slideId, org.json.JSONObject config) throws ServerException, ParseException, IOException, org.json.JSONException
      Update details of the specified slideshow.
      Parameters:
      slideId - The id of the slideshow.
      config - Contains the control configurations.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • deleteSlideshow

      public void deleteSlideshow(long slideId) throws ServerException, ParseException, IOException, org.json.JSONException
      Delete a specified slideshow in the workspace.
      Parameters:
      slideId - The id of the slideshow.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • createVariable

      public long createVariable(String variableName, int variableDataType, int variableType, org.json.JSONObject config) throws ServerException, ParseException, IOException, org.json.JSONException
      Create a variable in the workspace.
      Parameters:
      variableName - Name of the variable to be created.
      variableDataType - Datatype of the variable to be created.
      variableType - Type of the variable to be created.
      config - Contains the control configurations.
      Returns:
      A long of created variable id.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • updateVariable

      public void updateVariable(long variableId, String variableName, int variableDataType, int variableType, org.json.JSONObject config) throws ServerException, ParseException, IOException, org.json.JSONException
      Update details of the specified variable in the workspace.
      Parameters:
      variableId - Id for the variable.
      variableName - Name of the variable to be created.
      variableDataType - Datatype of the variable to be created.
      variableType - Type of the variable to be created.
      config - Contains the control configurations.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • deleteVariable

      public void deleteVariable(long variableId) throws ServerException, ParseException, IOException, org.json.JSONException
      Delete a specified variable in the workspace.
      Parameters:
      variableId - Id of the variable.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • getVariables

      public org.json.JSONArray getVariables() throws ServerException, ParseException, IOException, org.json.JSONException
      Returns list of all variables for the specified workspace.
      Returns:
      A JSONArray of variables list.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • getVariableDetails

      public org.json.JSONObject getVariableDetails(long variableId) throws ServerException, ParseException, IOException, org.json.JSONException
      Returns details of the specified variable.
      Parameters:
      variableId - The id of the variable.
      Returns:
      A JSONObject of variable details.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • makeDefaultFolder

      public void makeDefaultFolder(long folderId) throws ServerException, ParseException, IOException, org.json.JSONException
      Make the specified folder as default.
      Parameters:
      folderId - Id of the variable.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • getDatasources

      public org.json.JSONArray getDatasources() throws ServerException, ParseException, IOException, org.json.JSONException
      Returns list of all datasource for the specified workspace.
      Returns:
      A JSONArray of datasource list.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • syncData

      public void syncData(long datasourceId, org.json.JSONObject config) throws ServerException, ParseException, IOException, org.json.JSONException
      Initiate data sync for the specified datasource.
      Parameters:
      datasourceId - Id for the datasource.
      config - Contains any additional control configurations. Can be null.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • updateDatasourceConnection

      public void updateDatasourceConnection(long datasourceId, org.json.JSONObject config) throws ServerException, ParseException, IOException, org.json.JSONException
      Update connection details for the specified datasource.
      Parameters:
      datasourceId - Id of the datasource.
      config - Contains the control configurations.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • getTrashViews

      public org.json.JSONArray getTrashViews() throws ServerException, ParseException, IOException, org.json.JSONException
      Returns list of all views available in trash for the specified workspace.
      Returns:
      A JSONArray of trash views.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • restoreTrashView

      public void restoreTrashView(long viewId, org.json.JSONObject config) throws ServerException, ParseException, IOException, org.json.JSONException
      Restore the specified view from trash.
      Parameters:
      viewId - Id of the view.
      config - Contains any additional control configurations. Can be null.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • deleteTrashView

      public void deleteTrashView(long viewId, org.json.JSONObject config) throws ServerException, ParseException, IOException, org.json.JSONException
      Delete the specified view permanently from trash.
      Parameters:
      viewId - Id of the view.
      config - Contains any additional control configurations. Can be null.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • createQueryTable

      public long createQueryTable(String sqlQuery, String queryTableName, org.json.JSONObject config) throws ServerException, ParseException, IOException, org.json.JSONException
      Create a new query table in the workspace.
      Parameters:
      sqlQuery - SQL query to construct the query table.
      queryTableName - Name of the query table to be created.
      config - Contains any additional control configurations. Can be null.
      Returns:
      A long of created query table id.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • getQueryTables

      public org.json.JSONArray getQueryTables(org.json.JSONObject config) throws ServerException, ParseException, IOException, org.json.JSONException
      Returns list of all query tables for the specified workspace.
      Parameters:
      config - Contains any additional control configurations. Can be null.
      Returns:
      A JSONArray of query tables.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • updateQueryTable

      public void updateQueryTable(long viewId, String sqlQuery, org.json.JSONObject config) throws ServerException, ParseException, IOException, org.json.JSONException
      Update the mentioned query table in the workspace.
      Parameters:
      viewId - Id of the query table to be updated.
      sqlQuery - New SQL query to be updated.
      config - Contains any additional control configurations. Can be null.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • changeFolderHierarchy

      public void changeFolderHierarchy(long folderId, int hierarchy, org.json.JSONObject config) throws ServerException, ParseException, IOException, org.json.JSONException
      Swaps the hierarchy of a parent folder and a subfolder.
      Parameters:
      folderId - Id for the folder.
      hierarchy - New hierarchy for the folder. (0 - Parent; 1 - Child)
      config - Contains any additional control configurations. Can be null.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • changeFolderPosition

      public void changeFolderPosition(long folderId, long referenceFolderId, org.json.JSONObject config) throws ServerException, ParseException, IOException, org.json.JSONException
      Place the folder above the reference folder.
      Parameters:
      folderId - Id for the folder.
      referenceFolderId - Id of the reference folder.
      config - Contains any additional control configurations. Can be null.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • moveViewsToFolder

      public void moveViewsToFolder(long folderId, org.json.JSONArray viewIds, org.json.JSONObject config) throws ServerException, ParseException, IOException, org.json.JSONException
      Move views to the mentioned folder.
      Parameters:
      folderId - Id for the folder.
      viewIds - Ids of the views to be moved.
      config - Contains any additional control configurations. Can be null.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • getWorkspaceUsers

      public org.json.JSONArray getWorkspaceUsers() throws ServerException, ParseException, IOException, org.json.JSONException
      Returns list of users for the specified workspace.
      Returns:
      A JSONArray of users.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • addWorkspaceUsers

      public void addWorkspaceUsers(org.json.JSONArray emailIds, String role, org.json.JSONObject config) throws ServerException, ParseException, IOException, org.json.JSONException
      Add users to the specified workspace.
      Parameters:
      emailIds - The email address of the users to be added.
      role - Role of the users to be added.
      config - Contains any additional control configurations. Can be null.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • removeWorkspaceUsers

      public void removeWorkspaceUsers(org.json.JSONArray emailIds, org.json.JSONObject config) throws ServerException, ParseException, IOException, org.json.JSONException
      Remove users from the specified workspace.
      Parameters:
      emailIds - The email address of the users to be removed.
      config - Contains any additional control configurations. Can be null.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • changeWorkspaceUserStatus

      public void changeWorkspaceUserStatus(org.json.JSONArray emailIds, String operation, org.json.JSONObject config) throws ServerException, ParseException, IOException, org.json.JSONException
      Change users staus in the specified workspace.
      Parameters:
      emailIds - Email address of the users.
      operation - New status for the users ( Values - activate | deactivate )
      config - Contains any additional control configurations. Can be null.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • changeWorkspaceUserRole

      public void changeWorkspaceUserRole(org.json.JSONArray emailIds, String role, org.json.JSONObject config) throws ServerException, ParseException, IOException, org.json.JSONException
      Change role of the specified users in the workspace.
      Parameters:
      emailIds - Email address of the users.
      role - Name of the role.
      config - Contains any additional control configurations. Can be null.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • exportAsTemplate

      public void exportAsTemplate(org.json.JSONArray viewIds, String filePath, org.json.JSONObject config) throws ServerException, ParseException, IOException, org.json.JSONException
      Export the mentioned views as templates.
      Parameters:
      viewIds - Ids of the view to be exported.
      filePath - Path of the file where the data exported to be stored. ( Should be in 'atpt' format )
      config - Contains any additional control configurations. Can be null.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • getEmailSchedules

      public org.json.JSONArray getEmailSchedules() throws ServerException, ParseException, IOException, org.json.JSONException
      Returns list of email schedules available in the specified workspace.
      Returns:
      A JSONArray of emailschedules.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • createEmailSchedule

      public long createEmailSchedule(String scheduleName, org.json.JSONArray viewIds, String format, org.json.JSONArray emailIds, org.json.JSONObject scheduleDetails, org.json.JSONObject config) throws ServerException, ParseException, IOException, org.json.JSONException
      Create an email schedule in the specified workspace.
      Parameters:
      scheduleName - Name of the email schedule.
      viewIds - View ids to be mailed.
      format - The format in which the data has to be mailed.
      emailIds - The recipients' email addresses for sending views.
      scheduleDetails - Contains schedule frequency, date, and time info.
      config - Contains any additional control configurations. Can be null.
      Returns:
      A long of email schedule id.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • updateEmailSchedule

      public long updateEmailSchedule(long scheduleId, org.json.JSONObject config) throws ServerException, ParseException, IOException, org.json.JSONException
      Update configurations of the specified email schedule in the workspace.
      Parameters:
      scheduleId - Id of the email schedule.
      config - Contains the control configurations.
      Returns:
      A long of updatd email schedule id.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • triggerEmailSchedule

      public void triggerEmailSchedule(long scheduleId) throws ServerException, ParseException, IOException, org.json.JSONException
      Trigger configured email schedules instantly.
      Parameters:
      scheduleId - Id of the email schedule.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • changeEmailScheduleStatus

      public void changeEmailScheduleStatus(long scheduleId, String operation) throws ServerException, ParseException, IOException, org.json.JSONException
      Update configurations of the specified email schedule in the workspace.
      Parameters:
      scheduleId - Id of the email schedule.
      operation - New status for the email schedule ( Values - activate | deactivate )
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • deleteEmailSchedule

      public void deleteEmailSchedule(long scheduleId) throws ServerException, ParseException, IOException, org.json.JSONException
      Delete the specified email schedule in the workspace.
      Parameters:
      scheduleId - Id of the email schedule to be deleted.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • getAggregateFormulas

      public org.json.JSONArray getAggregateFormulas(org.json.JSONObject config) throws ServerException, ParseException, IOException, org.json.JSONException
      Returns list of all aggregate formulas for the specified workspace.
      Parameters:
      config - Contains any additional control configurations. Can be null.
      Returns:
      A JSONArray of aggregate formulas.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • getAggregateFormulaDependents

      public org.json.JSONObject getAggregateFormulaDependents(long formulaId) throws ServerException, ParseException, IOException, org.json.JSONException
      Returns list of all dependent views and formulas for the specified aggregate formula.
      Parameters:
      formulaId - Id of the aggregate formula.
      Returns:
      A JSONObject of dependent views and formulas.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • getAggregateFormulaValue

      public String getAggregateFormulaValue(long formulaId) throws ServerException, ParseException, IOException, org.json.JSONException
      Returns the value of the aggregate formula.
      Parameters:
      formulaId - Id of the aggregate formula.
      Returns:
      A String contains aggregate formula value.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • createReport

      public long createReport(org.json.JSONObject config) throws ServerException, ParseException, IOException, org.json.JSONException
      Create a report in the specified workspace.
      Parameters:
      config - Contains the control configurations.
      Returns:
      A long of created view id.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • updateReport

      public void updateReport(long viewId, org.json.JSONObject config) throws ServerException, ParseException, IOException, org.json.JSONException
      Update the design and configuration of the specified report.
      Parameters:
      viewId - Id of the view.
      config - Contains the control configurations.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • getWorkspaceMetadata

      public org.json.JSONObject getWorkspaceMetadata() throws ServerException, ParseException, IOException, org.json.JSONException
      Internally used in JDBC driver
      Throws:
      ServerException
      ParseException
      IOException
      org.json.JSONException

    • getQueryTableDetails

      public org.json.JSONObject getQueryTableDetails(String queryTableId) throws ServerException, ParseException, IOException, org.json.JSONException
      Returns details of the specified query table.
      Parameters:
      queryTableId - Id of the query table.
      Returns:
      Query table details.
      Throws:
      ServerException - If the server failed to process the request.
      ParseException - If the response could not be parsed.
      IOException - If communication errors occur.
      org.json.JSONException - If JSON processing fails.

    • getAutoMLAnalysis

      public org.json.JSONArray getAutoMLAnalysis() throws ServerException, ParseException, IOException, org.json.JSONException
      Returns list of AutoML analysis for the specified workspace.
      Returns:
      AutoML analysis list.
      Throws:
      ServerException - If the server failed to process the request.
      ParseException - If the response could not be parsed.
      IOException - If communication errors occur.
      org.json.JSONException - If JSON processing fails.

    • getAutoMLAnalysisDetails

      public org.json.JSONObject getAutoMLAnalysisDetails(String analysisId) throws ServerException, ParseException, IOException, org.json.JSONException
      Retrieves detailed information for a specific AutoML analysis.
      Parameters:
      analysisId - Id of the AutoML analysis.
      Returns:
      AutoML analysis details.
      Throws:
      ServerException - If the server failed to process the request.
      ParseException - If the response could not be parsed.
      IOException - If communication errors occur.
      org.json.JSONException - If JSON processing fails.

    • getDeploymentDetails

      public org.json.JSONObject getDeploymentDetails(String analysisId, String modelId) throws ServerException, ParseException, IOException, org.json.JSONException
      Returns deployment details for a specific AutoML analysis model.
      Parameters:
      analysisId - Id of the AutoML analysis.
      modelId - Id of the AutoML analysis model.
      Returns:
      Deployment details.
      Throws:
      ServerException - If the server failed to process the request.
      ParseException - If the response could not be parsed.
      IOException - If communication errors occur.
      org.json.JSONException - If JSON processing fails.

    • createAutoMLAnalysis

      public String createAutoMLAnalysis(String name, String trainingTableId, String predictionType, org.json.JSONArray features, int serverOption, org.json.JSONObject algorithms, org.json.JSONObject config) throws ServerException, ParseException, IOException, org.json.JSONException
      Creates a new AutoML analysis in the workspace.
      Parameters:
      name - Name of the AutoML analysis.
      trainingTableId - Id of the training table.
      predictionType - Prediction type (REGRESSION / CLASSIFICATION / CLUSTERING).
      features - Feature column names.
      serverOption - Compute size (1 -> 8GB, 2 -> 16GB, 3 -> 32GB).
      algorithms - Algorithms configuration.
      config - Additional control parameters. Can be null.
      Returns:
      Created AutoML analysis Id.
      Throws:
      ServerException - If the server failed to process the request.
      ParseException - If the response could not be parsed.
      IOException - If communication errors occur.
      org.json.JSONException - If JSON processing fails.

    • deleteAutoMLAnalysis

      public void deleteAutoMLAnalysis(String analysisId, org.json.JSONObject config) throws ServerException, ParseException, IOException, org.json.JSONException
      Deletes a specified AutoML analysis from the workspace.
      Parameters:
      analysisId - Id of the AutoML analysis to be deleted.
      config - Additional control parameters. Can be null.
      Throws:
      ServerException - If the server failed to process the request.
      ParseException - If the response could not be parsed.
      IOException - If communication errors occur.
      org.json.JSONException - If JSON processing fails.

    • deleteAutoMLAnalysisModel

      public void deleteAutoMLAnalysisModel(String analysisId, String modelId, org.json.JSONObject config) throws ServerException, ParseException, IOException, org.json.JSONException
      Deletes a specified model from an AutoML analysis.
      Parameters:
      analysisId - Id of the AutoML analysis.
      modelId - Id of the model to be deleted.
      config - Additional control parameters. Can be null.
      Throws:
      ServerException - If the server failed to process the request.
      ParseException - If the response could not be parsed.
      IOException - If communication errors occur.
      org.json.JSONException - If JSON processing fails.

    • createAutoMLAnalysisDeployment

      public org.json.JSONObject createAutoMLAnalysisDeployment(String analysisId, String modelId, String inputTableId, String outputTable, org.json.JSONArray outputColumns, String predictionColumn, int serverOption, String importType, Object scheduleDetails, org.json.JSONObject config) throws ServerException, ParseException, IOException, org.json.JSONException
      Creates a deployment for an AutoML analysis model.
      Parameters:
      analysisId - Id of the AutoML analysis.
      modelId - Id of the AutoML model.
      inputTableId - Id of the input table.
      outputTable - Name of the output table.
      outputColumns - Columns to be included in the output table.
      predictionColumn - Prediction column name.
      serverOption - Compute size (1 -> 8GB, 2 -> 16GB, 3 -> 32GB).
      importType - Import type (APPEND, TRUNCATEADD, UPDATEADD).
      scheduleDetails - Schedule details. Can be null.
      config - Additional control parameters. Can be null.
      Returns:
      Deployment details.
      Throws:
      ServerException - If the server failed to process the request.
      ParseException - If the response could not be parsed.
      IOException - If communication errors occur.
      org.json.JSONException - If JSON processing fails.

    • deployAutoMLAnalysis

      public void deployAutoMLAnalysis(String analysisId, String deploymentId, org.json.JSONObject config) throws ServerException, ParseException, IOException, org.json.JSONException
      Executes a specific AutoML deployment.
      Parameters:
      analysisId - Id of the AutoML analysis.
      deploymentId - Id of the deployment to be executed.
      config - Additional control parameters. Can be null.
      Throws:
      ServerException - If the server failed to process the request.
      ParseException - If the response could not be parsed.
      IOException - If communication errors occur.
      org.json.JSONException - If JSON processing fails.

    • deleteAutoMLAnalysisDeployment

      public void deleteAutoMLAnalysisDeployment(String analysisId, String deploymentId, org.json.JSONObject config) throws ServerException, ParseException, IOException, org.json.JSONException
      Deletes a specific AutoML deployment.
      Parameters:
      analysisId - Id of the AutoML analysis.
      deploymentId - Id of the deployment to be deleted.
      config - Additional control parameters. Can be null.
      Throws:
      ServerException - If the server failed to process the request.
      ParseException - If the response could not be parsed.
      IOException - If communication errors occur.
      org.json.JSONException - If JSON processing fails.

    • autoMLAnalysisPrediction

      public org.json.JSONObject autoMLAnalysisPrediction(String analysisId, String modelId, org.json.JSONObject features, org.json.JSONObject config) throws ServerException, ParseException, IOException, org.json.JSONException
      Generates predictions using a trained AutoML model with sample input values.
      Parameters:
      analysisId - Id of the AutoML analysis.
      modelId - Id of the AutoML model.
      features - Feature values for prediction.
      config - Additional control parameters. Can be null.
      Returns:
      Prediction details.
      Throws:
      ServerException - If the server failed to process the request.
      ParseException - If the response could not be parsed.
      IOException - If communication errors occur.
      org.json.JSONException - If JSON processing fails.

    • getTags

      public org.json.JSONArray getTags() throws ServerException, ParseException, IOException, org.json.JSONException
      Returns list of all tags for the specified workspace.
      Returns:
      A JSONArray of tags list.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • createTag

      public long createTag(String tagName, String colorCode, org.json.JSONObject config) throws ServerException, ParseException, IOException, org.json.JSONException
      Create a tag in the specified workspace.
      Parameters:
      tagName - Name of the tag to be created.
      colorCode - Color of the tag in HEX color code.
      config - Contains any additional control configurations. Can be null.
      Returns:
      A long of created tag id.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • updateTag

      public void updateTag(long tagId, org.json.JSONObject config) throws ServerException, ParseException, IOException, org.json.JSONException
      Update details of the specified tag in the workspace.
      Parameters:
      tagId - Id of the tag.
      config - Contains the control configurations.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • deleteTag

      public void deleteTag(long tagId) throws ServerException, ParseException, IOException, org.json.JSONException
      Delete the specified tag from the workspace.
      Parameters:
      tagId - Id of the tag.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • addTagToViews

      public void addTagToViews(long tagId, org.json.JSONArray viewIds, org.json.JSONObject config) throws ServerException, ParseException, IOException, org.json.JSONException
      Adds the specified tag to multiple views in the workspace.
      Parameters:
      tagId - Id of the tag.
      viewIds - List of view ids to be associated with the tag.
      config - Contains any additional control configurations. Can be null.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • removeTagFromViews

      public void removeTagFromViews(long tagId, org.json.JSONArray viewIds, boolean dissociateAll, org.json.JSONObject config) throws ServerException, ParseException, IOException, org.json.JSONException
      Removes the specified tag from multiple views in the workspace.
      Parameters:
      tagId - Id of the tag.
      viewIds - List of view ids to be dissociated. Can be null when dissociateAll is true.
      dissociateAll - To dissociate the tag from all associated views.
      config - Contains any additional control configurations. Can be null.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • getTaggedViews

      public org.json.JSONArray getTaggedViews(long tagId) throws ServerException, ParseException, IOException, org.json.JSONException
      Returns the list of views associated with the specified tag.
      Parameters:
      tagId - Id of the tag.
      Returns:
      A JSONArray of tagged views.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • getLinkedWorkspaces

      public org.json.JSONArray getLinkedWorkspaces() throws ServerException, ParseException, IOException, org.json.JSONException
      Returns list of workspaces linked to the specified master workspace.
      Returns:
      A JSONArray of linked workspaces.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • getLinkableWorkspaces

      public org.json.JSONArray getLinkableWorkspaces() throws ServerException, ParseException, IOException, org.json.JSONException
      Returns list of organizations and workspaces that can be linked to the specified master workspace.
      Returns:
      A JSONArray of organizations with their linkable workspaces.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • getWorkspaceLinkingCompatibility

      public org.json.JSONArray getWorkspaceLinkingCompatibility(org.json.JSONArray clients, org.json.JSONObject config) throws ServerException, ParseException, IOException, org.json.JSONException
      Returns the linking compatibility details for the specified client workspaces.
      Parameters:
      clients - Contains the client workspaces to be verified for linking compatibility.
      config - Contains any additional control configurations. Can be null.
      Returns:
      A JSONArray of client workspace compatibility details.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • linkWorkspaces

      public void linkWorkspaces(org.json.JSONArray clients, org.json.JSONObject config) throws ServerException, ParseException, IOException, org.json.JSONException
      Link the specified client workspaces to the master workspace.
      Parameters:
      clients - Contains the client workspaces to be linked with the master workspace.
      config - Contains any additional control configurations. Can be null.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • unlinkWorkspaces

      public void unlinkWorkspaces(String scope, org.json.JSONObject config) throws ServerException, ParseException, IOException, org.json.JSONException
      Unlink the client workspaces from the specified master workspace.
      Parameters:
      scope - Scope of the unlink operation.
      config - Contains any additional control configurations. Can be null.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • syncLinkedWorkspaces

      public void syncLinkedWorkspaces(String scope, org.json.JSONObject config) throws ServerException, ParseException, IOException, org.json.JSONException
      Sync the metadata of the master workspace to its linked client workspaces.
      Parameters:
      scope - Scope of the sync operation.
      config - Contains any additional control configurations. Can be null.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • getLinkedWorkspaceSyncDetails

      public org.json.JSONArray getLinkedWorkspaceSyncDetails(org.json.JSONArray sandboxIds, org.json.JSONObject config) throws ServerException, ParseException, IOException, org.json.JSONException
      Returns the sync details of the specified linked workspaces.
      Parameters:
      sandboxIds - Ids of the linked workspaces for which the sync details are fetched.
      config - Contains any additional control configurations. Can be null.
      Returns:
      A JSONArray of linked workspace sync details.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • getWorkspaceBackups

      public org.json.JSONObject getWorkspaceBackups() throws ServerException, ParseException, IOException, org.json.JSONException
      Returns the backup configuration and the list of backups available for the specified workspace.
      Returns:
      A JSONObject of workspace backup details.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • backupWorkspaceNow

      public org.json.JSONObject backupWorkspaceNow(org.json.JSONObject config) throws ServerException, ParseException, IOException, org.json.JSONException
      Trigger an instant backup for the specified workspace.
      Parameters:
      config - Contains any additional control configurations. Can be null.
      Returns:
      A JSONObject of the triggered backup details.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • getWorkspaceBackupStatus

      public org.json.JSONObject getWorkspaceBackupStatus(long backupId) throws ServerException, ParseException, IOException, org.json.JSONException
      Returns the status of the specified workspace backup.
      Parameters:
      backupId - Id of the backup.
      Returns:
      A JSONObject of backup status details.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • downloadWorkspaceBackup

      public void downloadWorkspaceBackup(long backupId, String filePath, org.json.JSONObject config) throws ServerException, ParseException, IOException, org.json.JSONException
      Download the specified workspace backup.
      Parameters:
      backupId - Id of the backup.
      filePath - Path of the file where the downloaded backup is to be stored.
      config - Contains any additional control configurations. Can be null.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • restoreWorkspaceFromBackup

      public org.json.JSONObject restoreWorkspaceFromBackup(long backupId, boolean confirmRestore, org.json.JSONObject config) throws ServerException, ParseException, IOException, org.json.JSONException
      Restore the specified workspace from the given backup.
      Parameters:
      backupId - Id of the backup.
      confirmRestore - Pass true to confirm that the existing workspace data can be overwritten.
      config - Contains any additional control configurations. Can be null.
      Returns:
      A JSONObject of the triggered restore details.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • getWorkspaceRestoreStatus

      public org.json.JSONObject getWorkspaceRestoreStatus(long restoreId) throws ServerException, ParseException, IOException, org.json.JSONException
      Returns the status of the specified workspace restore.
      Parameters:
      restoreId - Id of the restore.
      Returns:
      A JSONObject of restore status details.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • createDashboard

      public long createDashboard(String displayName, String layout, org.json.JSONObject config) throws ServerException, ParseException, IOException, org.json.JSONException
      Create a dashboard in the specified workspace.
      Parameters:
      displayName - Name of the dashboard.
      layout - Layout configuration of the dashboard.
      config - Contains any additional control configurations. Can be null.
      Returns:
      A long of new dashboard id.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • updateDashboard

      public void updateDashboard(long dashboardId, org.json.JSONObject config) throws ServerException, ParseException, IOException, org.json.JSONException
      Update the specified dashboard in the workspace.
      Parameters:
      dashboardId - Id of the dashboard.
      config - Contains the dashboard configurations to be updated.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • getDashboardMetadata

      public org.json.JSONObject getDashboardMetadata(long dashboardId, org.json.JSONObject config) throws ServerException, ParseException, IOException, org.json.JSONException
      Returns the metadata of the specified dashboard.
      Parameters:
      dashboardId - Id of the dashboard.
      config - Contains any additional control configurations. Can be null.
      Returns:
      A JSONObject of dashboard configuration.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • getReportMetadata

      public org.json.JSONObject getReportMetadata(long viewId) throws ServerException, ParseException, IOException, org.json.JSONException
      Returns the metadata of the specified report.
      Parameters:
      viewId - Id of the report.
      Returns:
      A JSONObject of report configuration.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • getAlertsInWorkspace

      public org.json.JSONArray getAlertsInWorkspace() throws ServerException, ParseException, IOException, org.json.JSONException
      Returns list of data alerts available in the specified workspace.
      Returns:
      A JSONArray of data alerts.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • getAlertConfiguration

      public org.json.JSONObject getAlertConfiguration(long alertId) throws ServerException, ParseException, IOException, org.json.JSONException
      Returns the configuration of the specified data alert.
      Parameters:
      alertId - Id of the data alert.
      Returns:
      A JSONObject of data alert configuration.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • updateAlert

      public void updateAlert(long alertId, String alertName, org.json.JSONObject scheduleDetails, org.json.JSONArray rules, org.json.JSONObject config) throws ServerException, ParseException, IOException, org.json.JSONException
      Update the specified data alert in the workspace.
      Parameters:
      alertId - Id of the data alert.
      alertName - Name of the data alert.
      scheduleDetails - Contains the schedule configurations of the data alert.
      rules - Contains the rules to be evaluated by the data alert.
      config - Contains any additional control configurations. Can be null.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • deleteAlerts

      public void deleteAlerts(org.json.JSONArray alertIds, org.json.JSONObject config) throws ServerException, ParseException, IOException, org.json.JSONException
      Delete the specified data alerts from the workspace.
      Parameters:
      alertIds - Ids of the data alerts to be deleted.
      config - Contains any additional control configurations. Can be null.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • changeAlertStatus

      public void changeAlertStatus(org.json.JSONArray alertIds, boolean enabled, org.json.JSONObject config) throws ServerException, ParseException, IOException, org.json.JSONException
      Enable or disable the specified data alerts in the workspace.
      Parameters:
      alertIds - Ids of the data alerts.
      enabled - Pass true to enable the data alerts and false to disable them.
      config - Contains any additional control configurations. Can be null.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • runAlert

      public void runAlert(long alertId, org.json.JSONObject config) throws ServerException, ParseException, IOException, org.json.JSONException
      Execute the specified data alert immediately.
      Parameters:
      alertId - Id of the data alert.
      config - Contains any additional control configurations. Can be null.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • getAlertEvents

      public org.json.JSONObject getAlertEvents(long alertId, org.json.JSONObject config) throws ServerException, ParseException, IOException, org.json.JSONException
      Returns the execution events of the specified data alert.
      Parameters:
      alertId - Id of the data alert.
      config - Contains any additional control configurations. Can be null.
      Returns:
      A JSONObject of data alert events along with the page details.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • getWorkspaceAccessRestrictions

      public org.json.JSONObject getWorkspaceAccessRestrictions() throws ServerException, ParseException, IOException, org.json.JSONException
      Returns the access restriction settings configured for the specified workspace.
      Returns:
      A JSONObject of workspace access restriction settings.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.

    • updateWorkspaceAccessRestrictions

      public void updateWorkspaceAccessRestrictions(org.json.JSONObject config) throws ServerException, ParseException, IOException, org.json.JSONException
      Update the access restriction settings of the specified workspace.
      Parameters:
      config - Contains the access restriction configurations to be updated.
      Throws:
      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 the client was not able to parse the response.
      IOException - If any communication related errors like request time out occurs, when trying to contact the service.
      org.json.JSONException - If any errors while processing the JSON data.