BulkAPI contains bulk data operation.
type BulkAPI struct {
// contains filtered or unexported fields
}
func GetBulkInstance(ac *Client, orgid string, workspaceid string) BulkAPI
GetBulkInstance - Returns the BulkAPI object.
ac - Client structure pointer.
orgid - The ID of the organization.
workspaceid - Id of the workspace.
func (bulk *BulkAPI) ExportBulkData(jobid, filepath string) (serverexception *ServerException)
ExportBulkData - Download the exported data for the mentioned job id.
jobid - Returns the export job id.
filepath - Path of the file where the data exported to be stored.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (bulk *BulkAPI) ExportData(viewid, responseformat, filepath string, config map[string]interface{}) (serverexception *ServerException)
ExportData - Export the mentioned table (or) view data.
viewid - Id of the view to be exported.
responseformat - The format in which the data is to be exported.
filepath - Path of the file where the data exported to be stored.
config - Contains the control configurations.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (bulk *BulkAPI) GetExportJobDetails(jobid string) (result interface{}, serverexception *ServerException)
GetExportJobInfo - Returns the details of the export job.
jobid - Id of the export job.
result - Returns the export job details as interface.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (bulk *BulkAPI) GetImportJobDetails(jobid string) (result interface{}, serverexception *ServerException)
GetImportJobDetails - Returns the details of the import job.
jobid - Id of the import job.
result - Returns the import job details as interface.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (bulk *BulkAPI) ImportBulkData(viewid, importtype, filetype, autoidentify, filepath string, config map[string]interface{}) (jobid string, serverexception *ServerException)
ImportBulkData - Asynchronously import the data contained in the mentioned file into the table.
viewid - Id of the view where the data to be imported.
importtype - The type of import. Can be one of - append, truncateadd, updateadd.
filetype - Type of the file to be imported.
autoidentify - Used to specify whether to auto identify the CSV format. Allowable values - true/false.
filepath - Path of the file to be imported.
config - Contains the control configurations.
jobid - Returns the import job id.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (bulk *BulkAPI) ImportBulkDataAsBatches(viewid, importtype, autoidentify, filepath string, batchSize int, config map[string]interface{}) (jobid string, serverexception *ServerException)
ImportBulkData - Asynchronously import the data contained in the mentioned file into the table.
viewid - Id of the view where the data to be imported.
importtype - The type of import. Can be one of - append, truncateadd, updateadd.
filetype - Type of the file to be imported.
autoidentify - Used to specify whether to auto identify the CSV format. Allowable values - true/false.
filepath - Path of the file to be imported.
batchSize - Number of lines per batch.
config - Contains the control configurations.
jobid - Returns the import job id.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (bulk *BulkAPI) ImportBulkDataInNewTable(tablename, filetype, autoidentify, filepath string, config map[string]interface{}) (jobid string, serverexception *ServerException)
ImportBulkDataInNewTable - Asynchronously create a new table and import the data contained in the mentioned file into the created table.
tablename - Name of the new table to be created.
filetype - Type of the file to be imported.
autoidentify - Used to specify whether to auto identify the CSV format. Allowable values - true/false.
filepath - Path of the file to be imported.
config - Contains the control configurations.
jobid - Returns the import job id.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (bulk *BulkAPI) ImportBulkDataInNewTableAsBatches(tablename, autoidentify, filepath string, batchSize int, config map[string]interface{}) (jobid string, serverexception *ServerException)
ImportBulkDataInNewTable - Asynchronously create a new table and import the data contained in the mentioned file into the created table.
tablename - Name of the new table to be created.
filetype - Type of the file to be imported.
autoidentify - Used to specify whether to auto identify the CSV format. Allowable values - true/false.
filepath - Path of the file to be imported.
batchSize - Number of lines per batch
config - Contains the control configurations.
jobid - Returns the import job id.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (bulk *BulkAPI) ImportData(viewid, importtype, filetype, autoidentify, filepath string, config map[string]interface{}) (result interface{}, serverexception *ServerException)
ImportData - Create a new table and import the data contained in the mentioned file into the created table.
viewid - Id of the view where the data to be imported.
importtype - The type of import. Can be one of - append, truncateadd, updateadd.
filetype - Type of the file to be imported.
autoidentify - Used to specify whether to auto identify the CSV format. Allowable values - true/false.
filepath - Path of the file to be imported.
config - Contains the control configurations.
result - Returns the import result as interface.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (bulk *BulkAPI) ImportDataInNewTable(tablename, filetype, autoidentify, filepath string, config map[string]interface{}) (result interface{}, serverexception *ServerException)
ImportDataInNewTable - Create a new table and import the data contained in the mentioned file into the created table.
tablename - Name of the new table to be created.
filetype - Type of the file to be imported.
autoidentify - Used to specify whether to auto identify the CSV format. Allowable values - true/false.
filepath - Path of the file to be imported.
config - Contains the control configurations.
result - Returns the import result as interface.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (bulk *BulkAPI) InitiateBulkExport(viewid, responseformat string, config map[string]interface{}) (jobid string, serverexception *ServerException)
InitiateBulkExport - Initiate asynchronous export for the mentioned table (or) view data.
viewid - Id of the view to be exported.
responseformat - The format in which the data is to be exported.
config - Contains the control configurations.
jobid - Returns the export job id.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (bulk *BulkAPI) InitiateBulkExportUsingSQL(sqlquery, responseformat string, config map[string]interface{}) (jobid string, serverexception *ServerException)
InitiateBulkExportUsingSQL - Initiate asynchronous export with the given SQL Query.
sqlquery - The SQL Query whose output is exported.
responseformat - The format in which the data is to be exported.
config - Contains the control configurations.
jobid - Returns the export job id.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
Client - Contains the client details.
ClientVersion - ZohoAnalytics client version.
AnalyticsServerUrl - ZohoAnalytics domain URL.
AccountsServerUrl - ZohoAccounts domain URL.
ClientId - Client id of the user.
ClientSecret - Client secret of the user.
RefreshToken - Refresh token of the user.
AccessToken - Access token of the user.
type Client struct {
ClientVersion string
AnalyticsServerUrl string
AccountsServerUrl string
ClientId string
ClientSecret string
RefreshToken string
AccessToken string
}
func GetAnalyticsClient(clientid, clientsecret, refreshtoken string) Client
GetAnalyticsClient - Returns the Client object.
clientid - Client id of the user.
clientsecret - Client secret of the user.
refreshtoken - Refresh token of the user.
func (ac *Client) GetDashboars() (views interface{}, serverexception *ServerException)
GetDashboars - Returns list of all accessible dashboards.
views - Returns dashboard list as interface.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (ac *Client) GetOrgs() (orgs interface{}, serverexception *ServerException)
GetOrgs - Returns list of all accessible organizations.
orgs - Returns org list as interface.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (ac *Client) GetOwnedDashboars() (views interface{}, serverexception *ServerException)
GetOwnedDashboars - Returns list of owned dashboards.
views - Returns dashboard list as interface.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (ac *Client) GetOwnedWorkspaces() (workspaces interface{}, serverexception *ServerException)
GetOwnedWorkspaces - Returns list of owned workspaces.
workspaces - Returns workspace list as interface.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (ac *Client) GetRecentViews() (views interface{}, serverexception *ServerException)
GetRecentViews - Returns list of recently accessed views.
views - Returns view list as interface.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (ac *Client) GetSharedDashboars() (views interface{}, serverexception *ServerException)
GetSharedDashboars - Returns list of shared dashboards.
views - Returns dashboard list as interface.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (ac *Client) GetSharedWorkspaces() (workspaces interface{}, serverexception *ServerException)
GetSharedWorkspaces - Returns list of shared workspaces.
workspaces - Returns workspace list as interface.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (ac *Client) GetViewDetails(viewid string, config map[string]interface{}) (viewDetails map[string]interface{}, serverexception *ServerException)
GetViewDetails - Returns details of the specified view.
viewid - The ID of the view.
config - Contains the control configurations.
viewDetails - Returns the view details as interface.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (ac *Client) GetWorkspaceDetails(workspaceid string) (workspaceDetails map[string]interface{}, serverexception *ServerException)
GetWorkspaceDetails - Returns details of the specified workspace.
workspaceid - The ID of the workspace.
workspaceDetails - Returns workspace details as interface.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (ac *Client) GetWorkspaces() (workspaces map[string]interface{}, serverexception *ServerException)
GetWorkspaces - Returns list of all accessible workspaces.
workspaces - Returns workspace list as interface.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
WorkspaceAPI - OrgAPI contains organization level operations.
type OrgAPI struct {
// contains filtered or unexported fields
}
func GetOrgInstance(ac *Client, orgid string) OrgAPI
GetOrgInstance - Returns the OrgAPI object.
ac - Client structure pointer.
orgid - The ID of the organization.
func (org *OrgAPI) ActivateUsers(emailids interface{}, config map[string]interface{}) (serverexception *ServerException)
ActivateUsers - Activate users in the specified organization.
emailids - The email address of the users to be activated.
config - Contains any additional control configurations.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (org *OrgAPI) AddUsers(emailids interface{}, config map[string]interface{}) (serverexception *ServerException)
AddUsers - Add users to the specified organization.
emailids - The email address of the users to be added.
config - Contains any additional control configurations.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (org *OrgAPI) ChangeUserRole(emailids interface{}, role string, config map[string]interface{}) (serverexception *ServerException)
ChangeUserRole - Change role for the specified users.
emailids - The email address of the users.
role - Name of the role to be updated. Can be one of "USER"/"VIEWER"/"ORGADMIN".
config - Contains any additional control configurations.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (org *OrgAPI) CreateWorkspace(workspacename string, config map[string]interface{}) (workspaceid string, serverexception *ServerException)
CreateWorkspace - Create a blank workspace in the specified organization.
workspacename - Name of the workspace to be created.
config - Contains any additional control configurations.
workspaceid - Returns the new workspace id.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (org *OrgAPI) DeactivateUsers(emailids interface{}, config map[string]interface{}) (serverexception *ServerException)
DeactivateUsers - Deactivate users in the specified organization.
emailids - The email address of the users to be deactivated.
config - Contains any additional control configurations.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (org *OrgAPI) GetAdmins() (orgadmins interface{}, serverexception *ServerException)
GetAdmins - Returns list of admins for a specified organization.
orgadmins - Returns orgadmin list as interface.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (org *OrgAPI) GetMetaDetails(workspacename, viewname string) (metadetails interface{}, serverexception *ServerException)
GetMetaDetails - Returns details of the specified workspace/view.
workspacename - The name of the workspace.
viewname - The name of the view.
metadetails - Returns details as interface.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (org *OrgAPI) GetResourceDetails() (resourceinfo interface{}, serverexception *ServerException)
GetResourceDetails - Returns resource usage details of the specified organization.
resourceinfo - Returns details as interface.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (org *OrgAPI) GetSubscriptionDetails() (subscriptioninfo interface{}, serverexception *ServerException)
GetSubscriptionDetails - Returns subscription details of the specified organization.
subscriptioninfo - Returns details as interface.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (org *OrgAPI) GetUsers() (users interface{}, serverexception *ServerException)
GetUsers - Returns list of users for the specified organization.
users - Returns user list as interface.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (org *OrgAPI) RemoveUsers(emailids interface{}, config map[string]interface{}) (serverexception *ServerException)
RemoveUsers - Remove users from the specified organization.
emailids - The email address of the users to be removed.
config - Contains any additional control configurations.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
ServerException - ServerException is thrown if the Analytics server has received the request but did not process the request due to some error.
ErrorCode - The error code sent by the server.
ErrorMessage - The error message sent by the server.
HttpStatusCode - The HTTP status code for the request.
Action - The action to be performed over the resource specified by the URI.
type ServerException struct {
ErrorCode float64
ErrorMessage string
HttpStatusCode int
Action string
}
ViewAPI contains view level operations.
type ViewAPI struct {
// contains filtered or unexported fields
}
func GetViewInstance(ac *Client, orgid string, workspaceid string, viewid string) ViewAPI
GetViewInstance - Returns the ViewAPI object.
ac - Client structure pointer.
orgid - The ID of the organization.
workspaceid - Id of the workspace.
viewid - Id of the view.
func (view *ViewAPI) AddAggregateFormula(formulaname string, expression string, config map[string]interface{}) (formulaid string, serverexception *ServerException)
AddAggregateFormula - Add an aggregate formula in the specified table.
formulaname - Name of the formula to be created.
expression - Formula expression.
config - Contains the control configurations.
formulaid - Returns id of the created formula.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (view *ViewAPI) AddColumn(columnname, datatype string, config map[string]interface{}) (columnid string, serverexception *ServerException)
AddColumn - Add a column in the specified table.
columnname - The name of the column.
datatype - The data-type of the column.
config - Contains the control configurations.
columnid - Returns id of the new column.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (view *ViewAPI) AddFavorite() (serverexception *ServerException)
AddFavorite - Adds a specified view as favorite.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (view *ViewAPI) AddFormulaColumn(formulaname string, expression string, config map[string]interface{}) (formulaid string, serverexception *ServerException)
AddFormulaColumn - Add a formula column in the specified table.
formulaname - Name of the formula column to be created.
expression - Formula expression.
config - Contains the control configurations.
formulaid - Returns id of the formula created.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (view *ViewAPI) AddLookup(columnid, refviewid, refcolumnid string, config map[string]interface{}) (serverexception *ServerException)
AddLookup - Add a lookup in the specified child table.
columnid - The id of the column.
refviewid - The ID of the table contains the parent column.
refcolumnid - The ID of the parent column.
config - Contains the control configurations.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (view *ViewAPI) AddRow(columnvalues, config map[string]interface{}) (data interface{}, serverexception *ServerException)
AddRow - Add a single row in the specified table.
columnvalues - Contains the values for the row. The column names are the key.
config - Contains the control configurations.
data - Returns details of the added rows as interface.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (view *ViewAPI) AutoAnalyse(config map[string]interface{}) (serverexception *ServerException)
AutoAnalyse - Auto generate reports for the specified table.
config - Contains the control configurations.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (view *ViewAPI) AutoAnalyseColumn(columnid string, config map[string]interface{}) (serverexception *ServerException)
AutoAnalyseColumn - Auto generate reports for the specified column.
columnid - The id of the column.
config - Contains the control configurations.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (view *ViewAPI) CopyFormulas(formulanames interface{}, destworkspaceid string, config map[string]interface{}, destorgid string) (serverexception *ServerException)
CopyFormulas - Copy the specified formulas from one table to another within the workspace or across workspaces.
formulanames - The name of the formula columns to be copied.
destworkspaceid - The ID of the destination workspace.
config - Contains the control configurations.
destorgid - Id of the organization where the destination workspace is present.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (view *ViewAPI) CreatePrivateUrl(config map[string]interface{}) (privateurl string, serverexception *ServerException)
CreatePrivateUrl - Create a private URL for the specified view.
config - Contains the control configurations.
privateurl - Returns the private URL.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (view *ViewAPI) CreateSimilarViews(refviewid, folderid string, config map[string]interface{}) (serverexception *ServerException)
CreateSimilarViews - Create reports for the specified table based on the reference table.
refviewid - The ID of the reference view.
folderid - The folder id where the views to be saved.
config - Contains the control configurations.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (view *ViewAPI) Delete(config map[string]interface{}) (serverexception *ServerException)
Delete - Delete a specified view in the workspace.
config - Contains the control configurations.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (view *ViewAPI) DeleteAggregateFormula(formulaid string, config map[string]interface{}) (serverexception *ServerException)
DeleteAggregateFormula - Delete the specified aggregate formula.
formulaid - Id of the aggregate formula to be deleted.
config - Contains the control configurations.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (view *ViewAPI) DeleteColumn(columnid string, config map[string]interface{}) (serverexception *ServerException)
DeleteColumn - Delete a specified column in the table.
columnid - The id of the column.
config - Contains the control configurations.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (view *ViewAPI) DeleteFormulaColumn(formulaid string, config map[string]interface{}) (serverexception *ServerException)
DeleteFormulaColumn - Delete the specified formula column.
formulaid - Id of the formula column to be deleted.
config - Contains the control configurations.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (view *ViewAPI) DeleteRow(criteria string, config map[string]interface{}) (deletedCount float64, serverexception *ServerException)
DeleteRow - Delete rows in the specified table.
criteria - The criteria to be applied for deleting data. Only rows matching the criteria will be deleted. Should be null for delete all rows.
config - Contains the control configurations.
deletedCount - Returns deleted rows count.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (view *ViewAPI) EditAggregateFormula(formulaid string, expression string, config map[string]interface{}) (serverexception *ServerException)
EditAggregateFormula - Edit the specified aggregate formula.
formulaid - Id of the aggregate formula to be updated.
expression - Formula expression.
config - Contains the control configurations.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (view *ViewAPI) EditFormulaColumn(formulaid string, expression string, config map[string]interface{}) (serverexception *ServerException)
EditFormulaColumn - Edit the specified formula column.
formulaid - Id of the formula column to be updated.
expression - Formula expression.
config - Contains the control configurations.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (view *ViewAPI) GetAggregateFormulas() (formulas interface{}, serverexception *ServerException)
GetAggregateFormulas - Returns list of all aggregate formulas for the specified table.
formulas - Returns aggregate formula list as interface.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (view *ViewAPI) GetColumnDependents(columnid string) (dependents interface{}, serverexception *ServerException)
GetColumnDependents - Returns list of dependents views and formulas for the specified column.
columnid - The id of the column.
dependents - Returns dependent list as interface.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (view *ViewAPI) GetEmbedUrl(config map[string]interface{}) (embedurl string, serverexception *ServerException)
GetEmbedUrl - Returns embed URL to access the specified view.
config - Contains the control configurations.
embedurl - Returns the embed URL.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (view *ViewAPI) GetFormulaColumns() (formulas interface{}, serverexception *ServerException)
GetFormulaColumns - Returns list of all formula columns for the specified table.
formulas - Returns formula column list as interface.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (view *ViewAPI) GetLastImportDetails() (importDetails interface{}, serverexception *ServerException)
GetLastImportDetails - Returns last import details of the specified view.
importDetails - Returns the last import details as interface.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (view *ViewAPI) GetMyPermissions() (permissions interface{}, serverexception *ServerException)
GetMyPermissions - Returns permissions for the specified view.
permissions - Returns the permission details as interface.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (view *ViewAPI) GetPrivateUrl(config map[string]interface{}) (privateurl string, serverexception *ServerException)
GetPrivateUrl - Returns private URL to access the specified view.
config - Contains the control configurations.
privateurl - Returns the private URL.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (view *ViewAPI) GetPublishConfigurations() (publishinfo interface{}, serverexception *ServerException)
GetPublishConfigurations - Returns details of the specified slideshow.
publishinfo - Returns publish configurations for the specified view.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (view *ViewAPI) GetViewDependents() (dependents interface{}, serverexception *ServerException)
GetViewDependents - Returns list of dependents views for the specified view.
dependents - Returns dependent list as interface.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (view *ViewAPI) GetViewUrl(config map[string]interface{}) (viewurl string, serverexception *ServerException)
GetViewUrl - Returns the URL to access the specified view.
config - Contains the control configurations.
viewurl - Returns the view URL.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (view *ViewAPI) HideColumns(columnids interface{}) (serverexception *ServerException)
HideColumns - Hide the specified columns in the table.
columnids - Ids of the column to be hidden.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (view *ViewAPI) MakeViewPublic(config map[string]interface{}) (privateurl string, serverexception *ServerException)
MakeViewPublic - Make the specified view publically accessible.
config - Contains the control configurations.
privateurl - Returns the view URL.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (view *ViewAPI) RefetchData(config map[string]interface{}) (serverexception *ServerException)
RefetchData - Sync data from available datasource for the specified view.
config - Contains any additonal control configurations.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (view *ViewAPI) RemoveFavorite() (serverexception *ServerException)
RemoveFavorite - Remove a specified view from favorite.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (view *ViewAPI) RemoveLookup(columnid string, config map[string]interface{}) (serverexception *ServerException)
RemoveLookup - Remove the lookup for the specified column in the table.
columnid - The id of the column.
config - Contains the control configurations.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (view *ViewAPI) RemovePrivateAccess() (serverexception *ServerException)
RemovePrivateAccess - Remove private link access for the specified view.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (view *ViewAPI) RemovePublicAccess() (serverexception *ServerException)
RemovePublicAccess - Remove public access for the specified view.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (view *ViewAPI) Rename(viewename string, config map[string]interface{}) (serverexception *ServerException)
Rename - Rename a specified view in the workspace.
viewename - The new name of the view.
config - Contains the control configurations.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (view *ViewAPI) RenameColumn(columnid, columnname string) (serverexception *ServerException)
RenameColumn - Rename a specified column in the table.
columnid - The id of the column.
columnname - The new name of the column.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (view *ViewAPI) SaveAs(newviewname string, config map[string]interface{}) (viewid string, serverexception *ServerException)
SaveAs - Copy a specified view within the workspace.
newviewname - The name of the new view.
config - Contains the control configurations.
viewid - Returns id of the new view.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (view *ViewAPI) ShowColumns(columnids interface{}) (serverexception *ServerException)
ShowColumns - Show the specified hidden columns in the table.
columnids - Ids of the column to be shown.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (view *ViewAPI) UpdatePublishConfigurations(config map[string]interface{}) (serverexception *ServerException)
UpdatePublishConfigurations - Update publish configurations for the specified view.
config - Contains the control configurations.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (view *ViewAPI) UpdateRow(columnvalues map[string]interface{}, criteria string, config map[string]interface{}) (data interface{}, serverexception *ServerException)
UpdateRow - Update rows in the specified table.
columnvalues - Contains the values for the row. The column names are the key.
criteria - The criteria to be applied for updating data. Only rows matching the criteria will be updated. Should be null for update all rows.
config - Contains the control configurations.
data - Returns details of the updated rows as interface.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (view *ViewAPI) UpdateSharedDetails(config map[string]interface{}) (serverexception *ServerException)
UpdateSharedDetails - Update the existing sharing configuration for views.
config - Contains the control configurations.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
WorkspaceAPI - WorkspaceAPI contains workspace level operations.
type WorkspaceAPI struct {
// contains filtered or unexported fields
}
func GetWorkspaceInstance(ac *Client, orgid string, workspaceid string) WorkspaceAPI
GetWorkspaceInstance - Returns the WorkspaceAPI object.
ac - Client structure pointer.
orgid - The ID of the organization.
workspaceid - Id of the workspace.
func (workspace *WorkspaceAPI) AddAdmins(emailids interface{}, config map[string]interface{}) (serverexception *ServerException)
AddAdmins - Add admins for the specified workspace.
emailids - The email address of the admin users to be added.
config - Contains any additional control configurations.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (workspace *WorkspaceAPI) AddDefault() (serverexception *ServerException)
AddDefault - Adds a specified workspace as default.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (workspace *WorkspaceAPI) AddFavorite() (serverexception *ServerException)
AddFavorite - Adds a specified workspace as favorite.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (workspace *WorkspaceAPI) AddGroupMembers(groupid string, emailids interface{}, config map[string]interface{}) (serverexception *ServerException)
AddGroupMembers - Add users to the specified group.
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.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (workspace *WorkspaceAPI) AddWorkspaceUsers(emailids interface{}, role string, config map[string]interface{}) (serverexception *ServerException)
AddWorkspaceUsers - Add users to the specified workspace.
emailids - The email address of the users to be added.
role - Role of the users to be added.
config - Contains any additional control configurations.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (workspace *WorkspaceAPI) ChangeFolderHierarchy(folderid string, hierarchy int, config map[string]interface{}) (serverexception *ServerException)
ChangeFolderHierarchy - Swaps the hierarchy of a parent folder and a subfolder.
folderid - The id of the folder.
hierarchy - New hierarchy for the folder. (0 - Parent; 1 - Child)
config - Contains any additional control configurations.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (workspace *WorkspaceAPI) ChangeFolderPosition(folderid, referencefolderid string, config map[string]interface{}) (serverexception *ServerException)
ChangeFolderPosition - Place the folder above the reference folder.
folderid - Id of the folder to be moved.
referencefolderid - Id of the reference folder.
config - Contains any additional control configurations.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (workspace *WorkspaceAPI) ChangeWorkspaceUserRole(emailids interface{}, role string, config map[string]interface{}) (serverexception *ServerException)
ChangeWorkspaceUserRole - Change users role in the specified workspace.
emailids - The email address of the users to be modified.
role - New role of the users.
config - Contains any additional control configurations.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (workspace *WorkspaceAPI) ChangeWorkspaceUserStatus(emailids interface{}, operation string, config map[string]interface{}) (serverexception *ServerException)
ChangeWorkspaceUserStatus - Change users staus in the specified workspace.
emailids - The email address of the users to be modified.
operation - New status for the users ( Values - activate | deactivate )
config - Contains any additional control configurations.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (workspace *WorkspaceAPI) Copy(newworkspacename string, config map[string]interface{}, destorgid string) (newworkspaceid string, serverexception *ServerException)
Copy - Copy the specified workspace from one organization to another or within the organization.
newworkspacename - Name of the new workspace.
config - Contains any additional control configurations.
destorgid - Id of the organization where the destination workspace is present.
newworkspaceid - Returns copied workspace id as string.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (workspace *WorkspaceAPI) CopyViews(viewids interface{}, destworkspaceid string, config map[string]interface{}, destorgid string) (views interface{}, serverexception *ServerException)
CopyViews - Copy the specified views from one workspace to another workspace.
viewids - The id of the views to be copied.
destworkspaceid - The destination workspace id.
config - Contains any additional control configurations.
destorgid - Id of the organization where the destination workspace is present.
views - Returns view list as interface.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (workspace *WorkspaceAPI) CreateFolder(foldername string, config map[string]interface{}) (folderid string, serverexception *ServerException)
CreateFolder - Create a folder in the specified workspace.
foldername - The name of the folder.
config - Contains any additional control configurations.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (workspace *WorkspaceAPI) CreateGroup(groupname string, emailids interface{}, config map[string]interface{}) (groupid string, serverexception *ServerException)
CreateGroup - Create a group in the specified workspace.
groupname - Name of the group.
emailids - The email address of the users to be added to the group.
config - Contains any additional control configurations.
groupid - Returns the created group id.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (workspace *WorkspaceAPI) CreateQueryTable(sqlquery string, querytablename string, config map[string]interface{}) (viewid string, serverexception *ServerException)
CreateQueryTable - Create a new query table in the workspace.
sqlquery - SQL query to construct the query table.
querytablename - Name of the query table to be created.
config - Contains the control configurations.
viewid - Returns the newly created view id.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (workspace *WorkspaceAPI) CreateSlideshow(slidename string, viewids interface{}, config map[string]interface{}) (slideid string, serverexception *ServerException)
CreateSlideshow - Create a slideshow in the specified workspace.
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.
slideid - Returns the created slideshow id.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (workspace *WorkspaceAPI) CreateTable(tabledesign map[string]interface{}) (viewid string, serverexception *ServerException)
CreateTable - Create a table in the specified workspace.
tabledesign - Structure of the table to be created.
viewid - Returns created table id.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (workspace *WorkspaceAPI) CreateVariable(variablename string, variabledatatype int, variabletype int, config map[string]interface{}) (variableid string, serverexception *ServerException)
CreateVariable - Create a variable in the workspace.
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.
variableid - Returns the new variable id.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (workspace *WorkspaceAPI) Delete() (serverexception *ServerException)
Delete - Delete a specified workspace in the organization.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (workspace *WorkspaceAPI) DeleteFolder(folderid string) (serverexception *ServerException)
DeleteFolder - Delete a specified folder in the workspace.
folderid - The id of the folder.
config - Contains any additional control configurations.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (workspace *WorkspaceAPI) DeleteGroup(groupid string) (serverexception *ServerException)
DeleteGroup - Delete a specified group.
groupid - The id of the group.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (workspace *WorkspaceAPI) DeleteSlideshow(slideid string) (serverexception *ServerException)
DeleteSlideshow - Delete a specified slideshow in the workspace.
slideid - The id of the slideshow.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (workspace *WorkspaceAPI) DeleteTrashView(viewid string, config map[string]interface{}) (serverexception *ServerException)
DeleteTrashView - Delete the specified view permanently from trash.
viewid - Id of the view.
config - Contains any additional control configurations.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (workspace *WorkspaceAPI) DeleteVariable(variableid string) (serverexception *ServerException)
DeleteVariable - Delete the specified variable in the workspace.
variableid - Id of the variable.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (workspace *WorkspaceAPI) DisableDomainAccess() (serverexception *ServerException)
DisableDomainAccess - Disable workspace from the specified white label domain.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (workspace *WorkspaceAPI) EditQueryTable(viewid, sqlquery string, config map[string]interface{}) (serverexception *ServerException)
EditQueryTable - Update the mentioned query table in the workspace.
viewid - Id of the query table to be updated.
sqlquery - New SQL query to be updated.
config - Contains any additional control configurations.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (workspace *WorkspaceAPI) EnableDomainAccess() (serverexception *ServerException)
EnableDomainAccess - Enable workspace to the specified white label domain.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (workspace *WorkspaceAPI) ExportAsTemplate(viewids interface{}, filepath string, config map[string]interface{}) (serverexception *ServerException)
ExportAsTemplate - Export views as templates.
viewids - View ids to be exported as template.
filepath - Path of the file where the data exported to be stored. ( Should be in 'atpt' format )
config - Contains the control configurations.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (workspace *WorkspaceAPI) GetAdmins() (workspaceadmins interface{}, serverexception *ServerException)
GetAdmins - Returns list of admins for the specified workspace.
workspaceadmins - Returns workspace admin list as interface.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (workspace *WorkspaceAPI) GetDatasources() (datasourcelist interface{}, serverexception *ServerException)
GetDatasources - Returns list of datasources for the specified workspace.
datasourcelist - Returns Datasource list as interface.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (workspace *WorkspaceAPI) GetFolders() (folders interface{}, serverexception *ServerException)
GetFolders - Returns list of all accessible folders for the specified workspace.
folders - Returns folder list as interface.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (workspace *WorkspaceAPI) GetGroupDetails(groupid string) (groupinfo interface{}, serverexception *ServerException)
GetGroupDetails - Returns details of the specified group.
groupid - The id of the group.
groupinfo - Returns group detail as interface.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (workspace *WorkspaceAPI) GetGroups() (groups interface{}, serverexception *ServerException)
GetGroups - Returns list of groups for the specified workspace.
groups - Returns the list of groups as interface.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (workspace *WorkspaceAPI) GetSecretKey(config map[string]interface{}) (secretkey string, serverexception *ServerException)
GetSecretKey - Returns the secret key of the specified workspace.
config - Contains any additional control configurations.
secretkey - Returns workspace secret key.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (workspace *WorkspaceAPI) GetShareInfo() (shareinfo interface{}, serverexception *ServerException)
GetShareInfo - Returns shared details of the specified workspace.
shareinfo - Returns ShareInfo as interface.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (workspace *WorkspaceAPI) GetSharedDetailsForViews(viewids interface{}) (shareinfo interface{}, serverexception *ServerException)
GetSharedDetailsForViews - Returns shared details of the specified views.
viewids - View ids for which sharing details are required.
shareinfo - Returns share details as interface.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (workspace *WorkspaceAPI) GetSlideshowDetails(slideid string) (slideinfo interface{}, serverexception *ServerException)
GetSlideshowDetails - Returns details of the specified slideshow.
slideid - The id of the slideshow.
slideinfo - Returns the slideshow details as interface.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (workspace *WorkspaceAPI) GetSlideshowUrl(slideid string, config map[string]interface{}) (slideurl string, serverexception *ServerException)
GetSlideshowUrl - Returns slide URL to access the specified slideshow.
slideid - The id of the slideshow.
config - Contains the control configurations.
slideurl - Returns the slideshow URL.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (workspace *WorkspaceAPI) GetSlideshows() (slideshows interface{}, serverexception *ServerException)
GetSlideshows - Create a group in the specified workspace.
slideshows - Returns the list of slideshows as interface.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (workspace *WorkspaceAPI) GetTrashViews() (views interface{}, serverexception *ServerException)
GetViews - Returns list of all views available in trash for the specified workspace.
views - Returns view list as interface.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (workspace *WorkspaceAPI) GetVariableDetails(variableid string) (variableinfo interface{}, serverexception *ServerException)
GetVariableDetails - Returns details of the specified variable.
variableid - Id of the variable.
variableinfo - Returns the variable details as interface.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (workspace *WorkspaceAPI) GetVariables() (variablelist interface{}, serverexception *ServerException)
GetVariables - Returns list of variables for the specified workspace.
variablelist - Returns variable list as interface.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (workspace *WorkspaceAPI) GetViews(config map[string]interface{}) (views interface{}, serverexception *ServerException)
GetViews - Returns list of all accessible views for the specified workspace.
config - Contains any additional control configurations.
views - Returns view list as interface.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (workspace *WorkspaceAPI) GetWorkspaceUsers() (users interface{}, serverexception *ServerException)
GetWorkspaceUsers - Returns list of users for the specified workspace.
users - Returns the list of users as interface.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (workspace *WorkspaceAPI) MakeDefaultFolder(folderid string) (serverexception *ServerException)
MakeDefaultFolder - Make the specified folder as default.
folderid - Id of the folder.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (workspace *WorkspaceAPI) MoveViewsToFolder(folderid string, viewids interface{}) (serverexception *ServerException)
MoveViewsToFolder - Move views to the mentioned folder.
folderid - Id of the folder.
viewids - View ids to be moved.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (workspace *WorkspaceAPI) RemoveAdmins(emailids interface{}, config map[string]interface{}) (serverexception *ServerException)
RemoveAdmins - Remove admins from the specified workspace.
emailids - The email address of the admin users to be removed.
config - Contains any additional control configurations.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (workspace *WorkspaceAPI) RemoveDefault() (serverexception *ServerException)
RemoveDefault - Remove a specified workspace from default.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (workspace *WorkspaceAPI) RemoveFavorite() (serverexception *ServerException)
RemoveFavorite - Remove a specified workspace from favorite.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (workspace *WorkspaceAPI) RemoveGroupMembers(groupid string, emailids interface{}, config map[string]interface{}) (serverexception *ServerException)
RemoveGroupMembers - Remove users from the specified group.
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.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (workspace *WorkspaceAPI) RemoveShare(viewids, emailids interface{}, config map[string]interface{}) (serverexception *ServerException)
RemoveShare - Remove shared views for the specified users.
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.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (workspace *WorkspaceAPI) RemoveWorkspaceUsers(emailids interface{}, config map[string]interface{}) (serverexception *ServerException)
RemoveWorkspaceUsers - Remove users from the specified workspace.
emailids - The email address of the users to be removed.
config - Contains any additional control configurations.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (workspace *WorkspaceAPI) Rename(workspacename string, config map[string]interface{}) (serverexception *ServerException)
Rename - Rename a specified workspace in the organization.
workspacename - New name of the workspace.
config - Contains any additional control configurations.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (workspace *WorkspaceAPI) RenameFolder(folderid, folderename string, config map[string]interface{}) (serverexception *ServerException)
RenameFolder - Rename a specified folder in the workspace.
folderid - The id of the folder.
folderename - The new name of the folder.
config - Contains any additional control configurations.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (workspace *WorkspaceAPI) RenameGroup(groupid, groupname string, config map[string]interface{}) (serverexception *ServerException)
RenameGroup - Rename a specified group.
groupid - The id of the group.
groupname - The new name of the group.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (workspace *WorkspaceAPI) RestoreTrashView(viewid string, config map[string]interface{}) (serverexception *ServerException)
RestoreTrashView - Restore the specified view from trash.
viewid - Id of the view.
config - Contains any additional control configurations.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (workspace *WorkspaceAPI) ShareViews(viewids, emailids interface{}, permissions map[string]bool, config map[string]interface{}) (serverexception *ServerException)
ShareViews - Share views to the specified users.
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.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (workspace *WorkspaceAPI) SyncData(datasourceid string, config map[string]interface{}) (serverexception *ServerException)
SyncData - Make the specified folder as default.
datasourceid - Id of the datasource.
config - Contains the control configurations.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (workspace *WorkspaceAPI) UpdateDatasourceConnection(datasourceid string, config map[string]interface{}) (serverexception *ServerException)
UpdateDatasourceConnection - Update connection details for the specified datasource.
datasourceid - Id of the datasource.
config - Contains the control configurations.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (workspace *WorkspaceAPI) UpdateSlideshow(slideid string, config map[string]interface{}) (serverexception *ServerException)
UpdateSlideshow - Update details of the specified slideshow.
slideid - The id of the slideshow.
config - Contains the control configurations.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.
func (workspace *WorkspaceAPI) UpdateVariable(variableid string, variablename string, variabledatatype int, variabletype int, config map[string]interface{}) (serverexception *ServerException)
UpdateVariable - Update details of the specified variable in the workspace.
variableid - Id of the variable.
variablename - New name for the variable.
variabledatatype - New datatype for the variable.
variabletype - New type for the variable.
config - Contains the control configurations.
serverexception - Throws a server exception. If the server has received the request but did not process the request due to some error.