public class WorkspaceAPI
extends java.lang.Object
Modifier | Constructor and Description |
---|---|
protected |
WorkspaceAPI(AnalyticsClient ac,
long orgId,
long workspaceId)
Creates a new
WorkspaceAPI instance. |
Modifier and Type | Method and 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 |
addWorkspaceUsers(org.json.JSONArray emailIds,
java.lang.String role,
org.json.JSONObject config)
Add users to the specified 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,
java.lang.String role,
org.json.JSONObject config)
Change role of the specified users in the workspace.
|
void |
changeWorkspaceUserStatus(org.json.JSONArray emailIds,
java.lang.String operation,
org.json.JSONObject config)
Change users staus in the specified workspace.
|
long |
copy(java.lang.String newWorkspaceName,
org.json.JSONObject config,
java.lang.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,
java.lang.Long destOrgId)
Copy the specified views from one workspace to another workspace.
|
long |
createFolder(java.lang.String folderName,
org.json.JSONObject config)
Create a folder in the specified workspace.
|
java.lang.String |
createGroup(java.lang.String groupName,
org.json.JSONArray emailIds,
org.json.JSONObject config)
Create a group in the specified workspace.
|
long |
createQueryTable(java.lang.String sqlQuery,
java.lang.String queryTableName,
org.json.JSONObject config)
Create a new query table in the workspace.
|
long |
createSlideshow(java.lang.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 |
createVariable(java.lang.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 |
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 |
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 |
disableDomainAccess()
Disable workspace from the specified white label domain.
|
void |
enableDomainAccess()
Enable workspace to the specified white label domain.
|
org.json.JSONArray |
getAdmins()
Returns list of admins for the specified workspace.
|
org.json.JSONArray |
getDatasources()
Returns list of all datasource for 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.
|
java.lang.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.
|
java.lang.String |
getSlideshowURL(long slideId,
org.json.JSONObject config)
Returns slide URL to access the specified slideshow.
|
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()
Returns list of all accessible views for the specified workspace.
|
org.json.JSONArray |
getWorkspaceUsers()
Returns list of users for the specified 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 |
removeWorkspaceUsers(org.json.JSONArray emailIds,
org.json.JSONObject config)
Remove users from the specified workspace.
|
void |
rename(java.lang.String workspaceName,
org.json.JSONObject config)
Rename a specified workspace in the organization.
|
void |
renameFolder(long folderId,
java.lang.String folderName,
org.json.JSONObject config)
Rename a specified folder in the workspace.
|
void |
renameGroup(long groupId,
java.lang.String groupName,
org.json.JSONObject config)
Rename a specified group.
|
void |
restoreTrashView(long viewId,
org.json.JSONObject config)
Restore the specified view from trash.
|
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 |
updateDatasourceConnection(long datasourceId,
org.json.JSONObject config)
Update connection details for the specified datasource.
|
void |
updateQueryTable(long viewId,
java.lang.String sqlQuery,
org.json.JSONObject config)
Update the mentioned query table in the workspace.
|
void |
updateSlideshow(long slideId,
org.json.JSONObject config)
Update details of the specified slideshow.
|
void |
updateVariable(long variableId,
java.lang.String variableName,
int variableDataType,
int variableType,
org.json.JSONObject config)
Update details of the specified variable in the workspace.
|
protected WorkspaceAPI(AnalyticsClient ac, long orgId, long workspaceId)
WorkspaceAPI
instance.ac
- AnalyticsClient
instance.orgId
- The ID of the organization.workspaceId
- The ID of the workspace.public void rename(java.lang.String workspaceName, org.json.JSONObject config) throws ServerException, ParseException, java.io.IOException, org.json.JSONException
workspaceName
- New name of the workspace.config
- Contains any additional control configurations. Can be null.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.java.io.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.public void delete() throws ServerException, ParseException, java.io.IOException, org.json.JSONException
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.java.io.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.public java.lang.String getSecretKey(org.json.JSONObject config) throws ServerException, ParseException, java.io.IOException, org.json.JSONException
config
- Contains any additional control configurations. Can be null.String
of workspace secret key.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.java.io.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.public long copy(java.lang.String newWorkspaceName, org.json.JSONObject config, java.lang.Long destOrgId) throws ServerException, ParseException, java.io.IOException, org.json.JSONException
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.long
of new workspace id.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.java.io.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.public void addFavorite() throws ServerException, ParseException, java.io.IOException, org.json.JSONException
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.java.io.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.public void removeFavorite() throws ServerException, ParseException, java.io.IOException, org.json.JSONException
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.java.io.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.public void addDefault() throws ServerException, ParseException, java.io.IOException, org.json.JSONException
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.java.io.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.public void removeDefault() throws ServerException, ParseException, java.io.IOException, org.json.JSONException
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.java.io.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.public void enableDomainAccess() throws ServerException, ParseException, java.io.IOException, org.json.JSONException
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.java.io.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.public void disableDomainAccess() throws ServerException, ParseException, java.io.IOException, org.json.JSONException
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.java.io.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.public org.json.JSONArray getViews() throws ServerException, ParseException, java.io.IOException, org.json.JSONException
JSONArray
of views list.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.java.io.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.public long createTable(org.json.JSONObject tableDesign) throws ServerException, ParseException, java.io.IOException, org.json.JSONException
tableDesign
- JSON object of table structure.long
of table id.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.java.io.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.public org.json.JSONArray copyViews(org.json.JSONArray viewIds, long destWorkspaceId, org.json.JSONObject config, java.lang.Long destOrgId) throws ServerException, ParseException, java.io.IOException, org.json.JSONException
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.JSONArray
of views list.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.java.io.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.public org.json.JSONArray getFolders() throws ServerException, ParseException, java.io.IOException, org.json.JSONException
JSONArray
of folders list.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.java.io.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.public long createFolder(java.lang.String folderName, org.json.JSONObject config) throws ServerException, ParseException, java.io.IOException, org.json.JSONException
folderName
- The name of the folder.config
- Contains any additional control configurations. Can be null.long
of folder id.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.java.io.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.public void renameFolder(long folderId, java.lang.String folderName, org.json.JSONObject config) throws ServerException, ParseException, java.io.IOException, org.json.JSONException
folderId
- The id of the folder.folderName
- The new name of the folder.config
- Contains any additional control configurations. Can be null.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.java.io.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.public void deleteFolder(long folderId) throws ServerException, ParseException, java.io.IOException, org.json.JSONException
folderId
- The id of the folder.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.java.io.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.public org.json.JSONArray getGroups() throws ServerException, ParseException, java.io.IOException, org.json.JSONException
JSONArray
of groups list.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.java.io.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.public org.json.JSONObject getGroupDetails(long groupId) throws ServerException, ParseException, java.io.IOException, org.json.JSONException
groupId
- The id of the group.JSONObject
of group details.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.java.io.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.public java.lang.String createGroup(java.lang.String groupName, org.json.JSONArray emailIds, org.json.JSONObject config) throws ServerException, ParseException, java.io.IOException, org.json.JSONException
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.long
of group id.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.java.io.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.public void renameGroup(long groupId, java.lang.String groupName, org.json.JSONObject config) throws ServerException, ParseException, java.io.IOException, org.json.JSONException
groupId
- The id of the group.groupName
- The new name of the group.config
- Contains any additional control configurations. Can be null.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.java.io.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.public void deleteGroup(long groupId) throws ServerException, ParseException, java.io.IOException, org.json.JSONException
groupId
- The id of the group.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.java.io.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.public void addGroupMembers(long groupId, org.json.JSONArray emailIds, org.json.JSONObject config) throws ServerException, ParseException, java.io.IOException, org.json.JSONException
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.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.java.io.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.public void removeGroupMembers(long groupId, org.json.JSONArray emailIds, org.json.JSONObject config) throws ServerException, ParseException, java.io.IOException, org.json.JSONException
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.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.java.io.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.public org.json.JSONArray getAdmins() throws ServerException, ParseException, java.io.IOException, org.json.JSONException
JSONArray
of workspace admins.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.java.io.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.public void addAdmins(org.json.JSONArray emailIds, org.json.JSONObject config) throws ServerException, ParseException, java.io.IOException, org.json.JSONException
emailIds
- The email address of the admin users to be added.config
- Contains any additional control configurations. Can be null.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.java.io.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.public void removeAdmins(org.json.JSONArray emailIds, org.json.JSONObject config) throws ServerException, ParseException, java.io.IOException, org.json.JSONException
emailIds
- The email address of the admin users to be removed.config
- Contains any additional control configurations. Can be null.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.java.io.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.public ShareInfo getShareInfo() throws ServerException, ParseException, java.io.IOException, org.json.JSONException
ShareInfo
object.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.java.io.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.public void shareViews(org.json.JSONArray viewIds, org.json.JSONArray emailIds, org.json.JSONObject permissions, org.json.JSONObject config) throws ServerException, ParseException, java.io.IOException, org.json.JSONException
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.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.java.io.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.public void removeShare(org.json.JSONArray viewIds, org.json.JSONArray emailIds, org.json.JSONObject config) throws ServerException, ParseException, java.io.IOException, org.json.JSONException
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.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.java.io.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.public org.json.JSONArray getSharedDetailsForViews(org.json.JSONArray viewIds) throws ServerException, ParseException, java.io.IOException, org.json.JSONException
viewIds
- Ids of the view to be included in the slideshow.JSONArray
of shared info of views.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.java.io.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.public org.json.JSONArray getSlideshows() throws ServerException, ParseException, java.io.IOException, org.json.JSONException
JSONArray
of slideshows.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.java.io.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.public org.json.JSONObject getSlideshowDetails(long slideId) throws ServerException, ParseException, java.io.IOException, org.json.JSONException
slideId
- The id of the slideshow.JSONObject
of slideshow details.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.java.io.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.public java.lang.String getSlideshowURL(long slideId, org.json.JSONObject config) throws ServerException, ParseException, java.io.IOException, org.json.JSONException
slideId
- The id of the slideshow.config
- Contains any additional control configurations. Can be null.String
of slideshow URL.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.java.io.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.public long createSlideshow(java.lang.String slideName, org.json.JSONArray viewIds, org.json.JSONObject config) throws ServerException, ParseException, java.io.IOException, org.json.JSONException
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.long
of created slideshow id.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.java.io.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.public void updateSlideshow(long slideId, org.json.JSONObject config) throws ServerException, ParseException, java.io.IOException, org.json.JSONException
slideId
- The id of the slideshow.config
- Contains the control configurations.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.java.io.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.public void deleteSlideshow(long slideId) throws ServerException, ParseException, java.io.IOException, org.json.JSONException
slideId
- The id of the slideshow.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.java.io.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.public long createVariable(java.lang.String variableName, int variableDataType, int variableType, org.json.JSONObject config) throws ServerException, ParseException, java.io.IOException, org.json.JSONException
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.long
of created variable id.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.java.io.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.public void updateVariable(long variableId, java.lang.String variableName, int variableDataType, int variableType, org.json.JSONObject config) throws ServerException, ParseException, java.io.IOException, org.json.JSONException
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.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.java.io.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.public void deleteVariable(long variableId) throws ServerException, ParseException, java.io.IOException, org.json.JSONException
variableId
- Id of the variable.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.java.io.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.public org.json.JSONArray getVariables() throws ServerException, ParseException, java.io.IOException, org.json.JSONException
JSONArray
of variables list.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.java.io.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.public org.json.JSONObject getVariableDetails(long variableId) throws ServerException, ParseException, java.io.IOException, org.json.JSONException
variableId
- The id of the variable.JSONObject
of variable details.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.java.io.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.public void makeDefaultFolder(long folderId) throws ServerException, ParseException, java.io.IOException, org.json.JSONException
folderId
- Id of the variable.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.java.io.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.public org.json.JSONArray getDatasources() throws ServerException, ParseException, java.io.IOException, org.json.JSONException
JSONArray
of datasource list.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.java.io.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.public void syncData(long datasourceId, org.json.JSONObject config) throws ServerException, ParseException, java.io.IOException, org.json.JSONException
datasourceId
- Id for the datasource.config
- Contains any additional control configurations. Can be null.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.java.io.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.public void updateDatasourceConnection(long datasourceId, org.json.JSONObject config) throws ServerException, ParseException, java.io.IOException, org.json.JSONException
datasourceId
- Id of the datasource.config
- Contains the control configurations.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.java.io.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.public org.json.JSONArray getTrashViews() throws ServerException, ParseException, java.io.IOException, org.json.JSONException
JSONArray
of trash views.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.java.io.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.public void restoreTrashView(long viewId, org.json.JSONObject config) throws ServerException, ParseException, java.io.IOException, org.json.JSONException
viewId
- Id of the view.config
- Contains any additional control configurations. Can be null.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.java.io.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.public void deleteTrashView(long viewId, org.json.JSONObject config) throws ServerException, ParseException, java.io.IOException, org.json.JSONException
viewId
- Id of the view.config
- Contains any additional control configurations. Can be null.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.java.io.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.public long createQueryTable(java.lang.String sqlQuery, java.lang.String queryTableName, org.json.JSONObject config) throws ServerException, ParseException, java.io.IOException, org.json.JSONException
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.long
of created query table id.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.java.io.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.public void updateQueryTable(long viewId, java.lang.String sqlQuery, org.json.JSONObject config) throws ServerException, ParseException, java.io.IOException, org.json.JSONException
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.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.java.io.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.public void changeFolderHierarchy(long folderId, int hierarchy, org.json.JSONObject config) throws ServerException, ParseException, java.io.IOException, org.json.JSONException
folderId
- Id for the folder.hierarchy
- New hierarchy for the folder. (0 - Parent; 1 - Child)config
- Contains any additional control configurations. Can be null.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.java.io.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.public void changeFolderPosition(long folderId, long referenceFolderId, org.json.JSONObject config) throws ServerException, ParseException, java.io.IOException, org.json.JSONException
folderId
- Id for the folder.referenceFolderId
- Id of the reference folder.config
- Contains any additional control configurations. Can be null.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.java.io.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.public void moveViewsToFolder(long folderId, org.json.JSONArray viewIds, org.json.JSONObject config) throws ServerException, ParseException, java.io.IOException, org.json.JSONException
folderId
- Id for the folder.viewIds
- Ids of the views to be moved.config
- Contains any additional control configurations. Can be null.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.java.io.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.public org.json.JSONArray getWorkspaceUsers() throws ServerException, ParseException, java.io.IOException, org.json.JSONException
JSONArray
of users.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.java.io.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.public void addWorkspaceUsers(org.json.JSONArray emailIds, java.lang.String role, org.json.JSONObject config) throws ServerException, ParseException, java.io.IOException, org.json.JSONException
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.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.java.io.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.public void removeWorkspaceUsers(org.json.JSONArray emailIds, org.json.JSONObject config) throws ServerException, ParseException, java.io.IOException, org.json.JSONException
emailIds
- The email address of the users to be removed.config
- Contains any additional control configurations. Can be null.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.java.io.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.public void changeWorkspaceUserStatus(org.json.JSONArray emailIds, java.lang.String operation, org.json.JSONObject config) throws ServerException, ParseException, java.io.IOException, org.json.JSONException
emailIds
- Email address of the users.operation
- New status for the users ( Values - activate | deactivate )config
- Contains any additional control configurations. Can be null.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.java.io.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.public void changeWorkspaceUserRole(org.json.JSONArray emailIds, java.lang.String role, org.json.JSONObject config) throws ServerException, ParseException, java.io.IOException, org.json.JSONException
emailIds
- Email address of the users.role
- Name of the role.config
- Contains any additional control configurations. Can be null.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.java.io.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.Copyright © 2023 AdventNet Inc. All Rights Reserved.