CommandWebServices

Webservices provide a standardized mechanism for applications to perform tasks such as communication and integration between disparate systems, expose functionalities as services, execute commands, provision data, enabling data exchange, and so on. For Birst, a webservice performs provisioning and execution for the application.

To see full details of the Birst webservice commands, such as the requests and responses, review the Birst Command Web Services.

For a formal definition, please review the Service Description.

This list provides the supported operations in Birst.

Note: The test form is only available for requests from the local machine. This applies to all these Webservices.

addAclToGroupInSpace

Adds an ACL to a group in a space. Arguments are the Login token, the name of the group, the name of the ACL and the space Id.

addAllowedIPAddrForAccount

Adds an IP address / CIDR netblock for users in the account to be able to log in from. Arguments are the Login token and the IP address / CIDR netblock.

addAllowedIp

Adds an IP address / CIDR netblock for a user to be able to log in from. Arguments are the Login token, the name of the user and the IP address / CIDR netblock.

addCloudConnection

Adds cloud connection. Arguments are Login token, space id, and cloud connection.

addEmailDomains

Adds email domains

addExpressionToSubjectArea

Adds Saved Expression to Custom Subject Area. Arguments are login token, expression name, subject area name, location, and so on.

addGroupToSpace

Creates a group in a space. Arguments are the Login token, the name of the group and the space Id.

addMask

Adds a create mask (regular expression) to a user. Arguments are the Login token, the name of the accountadmin user and the mask which is used to validate email when creating a user.

addOpenID

Adds an OpenID for a user. Arguments are the Login token, the name of the user and the OpenID identifier.

addProductToUser

Adds a product for the user. Arguments are the Login token, the name of the user and product id.

addProxyUser

Adds a new proxy user for a user. Arguments are the Login token, the name of the user and the name of the user who will proxy for the first user.

addSfdcAccountMapping

Adds mapping of SFDC account to Birst account

addUser

Creates a new user. Arguments are the Login token, the name of the user and additional parameters. The username must be unique in the Birst system. Additional parameters are a list of name=value pairs separated by spaces. Valid names are 'password=', 'email=', for example 'password=foo email=foo@bar.com'. If an email address is specified it must be unique. If an email address is not specified, the username is used.

addUserToGroupInSpace

Adds a user to a group in a space. Arguments are the Login token, the name of the user to add, the name of the group and the space Id.

addUserToSpace

Gives a user access to a space. The arguments are the Login token, the name of the user to add, the space Id, and if the user is an admin.

beginDataUpload

Starts a file upload. Arguments are the Login token, the Space ID and the name of the source. Returns a data upload token.

cancelJob

Cancels a job. Arguments include the Login token, space id and the job token. Returns true if cancellation request is successful. Call getDetailedJobStatus and isJobComplete to check the status. Cancellation of asynchronous job might take some time to complete cancellation request.

checkAndCreateDirectory

Creates a new folder. If it already exists, returns false else returns true. Arguments are login token, space id, name of parent folder and the new folder name.

clearCacheInSpace

Clears the cache in the space specified. The arguments are the Login token and the space Id to clear.

clearDashboardCache

Clears the dashboard cache. Arguments are the Login token and the space id.

clearJobStatus

Clears space and job status in case of job is unresponsive. Arguments include the Login token, space id and the job token. Returns true if clear space status request for job is successful. Call getDetailedJobStatus and isJobComplete to check the status.

clearODBCCacheInSpace

Deletes ODBCMetadata cache files. Arguments are the Login token and the space Id.

cloneDashboardPage

Creates a copy of given dashboard with an option of cloning the dashlets of the dashboard as well.

cloneDashboardPageV2

Creates a copy of given dashboard with an option of cloning the dashlets of the dashboard as well.

copyAccountSettings

Copies the settings from one account into another. The arguments are the Login token, the account Id to copy from, the account Id to copy to, a command separated list of settings to copy, list of specific theme/themes and list of color palette/palettes that needs to be copied which are optional parameters

copyAccountSettingsV2

Copies the settings from one account into another. The arguments are the Login token, the account Id to copy from, the account Id to copy to, the resource owner ID, a command separated list of settings to copy, list of specific theme/themes and list of color palette/palettes that needs to be copied which are optional parameters

copyCatalogDirectory

Copies the contents of the catalog from one space to another. The arguments are the Login token, the space Id to copy from, the space Id to copy to and the name of the directory to start the copy. It returns a job token

copyCustomSubjectArea

Copies a custom subject area from one space to another. Arguments include Login token, from space id, name of the custom subject area to copy and the destination space id.

copyFile

Copies a report from one space folder to another folder or file. Arguments are Login token, from space id, from report name, to space id, to directory or report name, and overwrite flag

copyFileOrDirectory

Copies a report or folder from one space folder to another folder. Arguments are Login token, from space id, from report or directory name, to space id and to directory name. It returns a job token

copySpace

Copies the contents from one space into another. The arguments are the Login token, the space Id to copy from, the space Id to copy to, 'replicate' or 'copy' mode, and a command separated list of items to copy. It returns a job token

copySpaceContents

Copies the contents from one space into another. The arguments are the Login token, the space Id to copy from and the space Id to copy to. It returns a job token

copyWorkflow

Copies the workflow from one account into another. The arguments are the Login token, the source account ID, the workflow ID to copy from, the target account ID, the owner ID of the new workflow in target account, the mode(copy/replicate) which is a optional parameter which in case if the mode isreplicate then if there is any workflow with given name in target account then this APIs overrides that workflow in the target account, the space ID mapping for workflow task parameters, the user ID mapping for workflow task parameters, the connection ID mapping for workflow task parameters, application lid mapping for workflow task parameters.

createDashboardCollection

Creates an empty dashboard collection. Arguments are the Login token, the space Id, the collection type and the collection name.

createExpression

Creates an expression. Arguments are the Login token, the space Id and the Expression to create.

createHierarchy

Creates a new hierarchy in the space specified.

createNewDirectory

Creates a new catalog folder. Arguments are login token, space id, name of parent folder and the new folder name.

createNewSpace

Creates a new space. Arguments are Login token, name of space, comments, and automatic.

createNewSpaceUsingSchema

Creates a new space. Arguments are Login token, name of space, name of schema, comments, and automatic.

createProfile

Creates a profile with default options. Arguments are Login token and Profile Name.

createSubjectArea

Creates a custom subject area in a space. Arguments are login token, space id, subject area name, description and permissions

deleteAllDataFromSpace

Deletes all loaded data. Arguments are the login token and the space id.

deleteBirstConnectAgent

Deletes an existing birst connect agent. Arguments are Login token and agent ID and returns true if successful.

deleteCloudConnection

Deletes cloud connection. Arguments are Login token, space id and connection id.

deleteExpression

Deletes an existing expression. Arguments are the Login token, the space Id and the Expression to delete.

deleteFileOrDirectory

Deletes a catalog entry or folder. Arguments are login token, space id and name of the entry or folder.

deleteHierarchy

Deletes a hierarchy from the space specified.

deleteLastDataFromSpace

Deletes the last load data. Arguments are the login token and the space id.

deleteLocaleValueInProfileProperty

Deletes locale specific values from property in a profile. Arguments required are Login token, profileID, propertyName and locale.

deleteProfile

Deletes the profile. Arguments required are Login token and profileID.

deleteSpace

Deletes a space. Arguments are Login token, and space id. Returns a job token.

deleteSubjectArea

Deletes a custom subject area in a space. Arguments are login token, space id and name of subject area.

deleteUser

Deletes a User. Arguments are the Login token and a username.

enableAccount

Enables/Disables an Account. Arguments are the Login token, an AccountID, and a boolean, if true enable, if false disable.

enableSourceInSpace

Enables/disables a data source. Arguments are the Login token, the space id, the name of the data source, and an enabled flag.

enableUser

Enables/disables a User. Arguments are the Login token, a username, and a boolean, if true enable, if false disable.

executeQueryInSpace

Executes a Birst Logical Query. Arguments are the Login token, the Birst logical query, and the space Id. Returns the first 1000 results. See queryMore for retrieving the remainder.

executeQueryInSpaceWithOptions

Executes a Birst Logical Query. Arguments are the Login token, the Birst logical query, the space Id and the query options. Query options contains the 'batchSize', which is 1000 by default. Returns the first few results as specified in 'batchSize'. See queryMore for retrieving the remainder.

executeScheduledReport

Runs the scheduled report. Arguments are the login token, the space id and schedule name.

executeWorkflow

This webservice triggers workflow execution for the given workflow name. Only an Account Admin or a Space Admin (to all spaces in the workflow) is authorized to invoke this API.

exportReportToCSV

Executes a report to be exported to CSV. Arguments are the login token, the space id, the report name, a list of filters and whether to turn off pagination or not.

exportReportToPDF

Executes a report to be exported to PDF. Arguments are the login token, the space id, the report name, a list of filters and whether to turn off pagination or not.

exportReportToPNG

Executes a report to be exportedn to PNG. Arguments are the login token, the space id, the report name, a list of filters and whether to turn off pagination or not.

exportReportToPPT

Executes a report to be exported to PPT. Arguments are the login token, the space id, the report name, a list of filters and whether to turn off pagination or not.

exportReportToRTF

Executes a report to be exported to RTF. Arguments are the login token, the space id, the report name, a list of filters and whether to turn off pagination or not.

exportReportToXLS

Executes a report to be exported to XLS. Arguments are the login token, the space id, the report name, a list of filters and whether to turn off pagination or not.

extractCloudConnectorData

Gets Birst to extract the data sources from any available Connection. Arguments are Login token, space id, Connector Name, Connection Name, Extract Group list and returns an extraction token. Use getJobStatus and isJobComplete to check the status.

extractConnectorData

The extractConnectorData web service is fully deprecated. Use extractCloudConnectorData instead.

extractSalesforceData

The extractSalesforceData web service is fully deprecated. Use extractCloudConnectorData instead.

finishDataUpload

Called after the last chunk of data is uploaded for a particular data source. This causes the system to start analyzing the data, which could take some time. This web service will return immediately, but status can be polled with isJobComplete and getJobStatus. Arguments are Login token, and data upload token.

generateBirstConnectToken

Generates access token for Birst Connect 2.0. Arguments are Login token and returns an json string with username and access_token.

getAgentHealth

Gets health status of agents. Arguments are agent IDs and returns agent status.

getAllHierarchies

Gets list of hierarchies in the space.

getAvailableACLs

Lists all the available ACLs for the logged in account admin. The method will return a list of ACLs associated with the account. Arguments are the Login token.

getDashboardView

Gets the dashboard view that is set for the user.

getDataCharacteristics

Gets data characteristics for given source.Arguments are Login token, space Id and sourceName. This API should only be used for sources getting extracted through SFTP connector. Please use the "Data Characteristics" option in Modeler Connect for sources extracted using other connectors.

getDataUploadStatus

Deprecated, replaced with getJobStatus. Called the get the status after data upload processing is complete. Arguments include the Login token and the data upload token. Returns an array of statuses, some of which could be warnings and some of which could be errors.

getDatabaseLinksStatus

Takes multiple space IDs as input. For each of the space IDs, the API would find out whether joins/grains in the space would require database links to be enabled for the space.

getDefaultProfile

This method retrieves default profile. Argument required is the Login token.

getDefaultProfileDetails

This method retrieves default profile with its properties. Argument required is the Login token.

getDetailedJobStatus

Gets detailed status of an asynchronous job after it has completed (including new statuses). Arguments include the Login token and the job token. Returns an XML representation of the status.

getDirectoryContents

Lists the files and directories in a directory for a space. Arguments are Login token, space id and directory (null value means top level). Returns an XML representation of the contents of the directory.

getDirectoryPermissions

Lists the permissions for a particular directory. Arguments are Login token, space Id and directory (a null value means top level). Returns an XML representation of the directory permissions.

getExportData

Gets the result of a report export call (exportReportToPNG).

getExportJobAsset

Gets asset of an export job.

getExportJobStatus

Gets status of an export job.

getExportJobs

Gets the job ids of a user in a space.

getExpression

Gets an existing expression. Arguments are the Login token, the space Id and the Expression to get.

getExtendedSubjectArea

Gets the extended subject area in a space. Arguments are the login token, space id, and subject area name.

getHierarchy

Gets hierarchy information from the space specified.

getJobStatus

Gets the status of an asynchronous job after it has completed. Arguments include the Login token and the job token. Returns an XML representation of the status.

getLanguageForUser

Returns the locale for a user. Arguments are the Login token, and the user name.

getLatestWorkflowExecutionStatus

This webservice returns the latest workflow execution status for the given workflow name.

getLiveAccessColumnProperties

Gets LiveAccess column properties. Arguments are the Login token, space Id, sourceName, and column name.

getLiveAccessSourceDetails

Gets LiveAccess source data. Arguments are the Login token, the space Id, and the sourceName.

getLoadStatus

Checks if a space is in an extraction, upload, or processing stage.

getODBCMetaData

Gets ODBC driver meta data. Arguments are the Login token and the space Id.

getODBCMetaDataSubjectAreas

Gets ODBC driver meta data - by subject area. Arguments are the Login token and the space Id.

getProfile

Gets information regarding a profile. Arguments required are Login token and profileID.

getProfileDetails

Gets information regarding a profile with properties. Arguments required are Login token and profileID.

getProfileForUser

This method retrieves profile for the given user. Arguments required are Login token and usrename.

getProfileProperty

Gets a property value of profile. Arguments required are Login token, profileID and propertyName.

getProfilePropertyWithLocale

Gets a property value of profile. Arguments required are Login token, profileID and propertyName.

getPublishingStatus

Deprecated, replaced with getJobStatus. Called the get the status after publishing processing is complete. Arguments include the Login token and the publishing token. Returns an array of statuses, some of which could be warnings and some of which could be errors.

getReportData

Gets the data from a report. Arguments are the Login token, the report name, and the space Id. Returns the first 1000 results. See queryMore for retrieving the remainder.

getSfdcAccountMapping

Gets mapping of SFDC account to Birst account.

getSourceDetails

Gets source data. Arguments are the Login token, the space Id and the sourceName.

getSourcesList

Gets sources list. Arguments are the Login token, the space Id.

getSpaceComments

Gets the space comments. Arguments are the Login token and the space Id. The spaceName must be less than 2048 characters.

getSpaceJNLPFile

Gets a JNLP file for a space. Arguments are the Login token, the space Id, and the name of the configuration file (normally _dconfig.xml, defaults to dcconfig.xml).

getSpaceProcessEngineVersion

Gets the space processing engine version. Arguments are the Login token and the space Id. The spaceName must be less than 2048 characters.

GetSpaceProperties

Gets the properties of the space.

getSpaceStatistics

Gets space detail information. Arguments are login token and space id.

getSpaceStatus

Getting the current space status, It will be showing the similar status which shows in Classic Home screen of UI. The input arguments are the Login token, and space Id, and it returns current status of space.

getSubjectAreaContent

Gets a custom subject area. Arguments are the login token, space id, and subject area name.

getSubjectAreaDescription

Gets the description for a subject area in a space. Arguments are login token, space id, subject area name.

getSubjectAreaForLocalization

Deprecated. Used internally to retrieve subject area for localization mapping.

getSubjectAreaPermissions

Gets the permissions for a subject area in a space. Arguments are login token, space id, subject area name.

getUpdatedSubjectArea

Gets the updated subject area based on the BQL query. Arguments are the login token, space id, subject area name and BQL query.

getUserProfile

This method retrieves logged-in user profile. Argument required is the Login token.

getUserProfileDetails

This method retrieves logged-in user profile with its properties. Argument required is the Login token.

getUserRelease

Gets the release for a user. Arguments are the Login token, and the name of the user.

getUsersForProfile

This method retrieves list of users associated with the given profile. Arguments required are Login token and profileID.

getUsersInAccount

This webservice retrieves list of users from the account of invoking user. Only an Account Admin user is authorized to invoke this API.

getVariablesForSpace

List of variables and values defined for a space. Arguments are Login token and space id. Returns an array of arrays, each of which is a name value pair.

getWorkflowById

This webservice fetches workflow for the given workflow Id.

importCubeMetaDataIntoSpace

Import/Reimport cube using realtime connection connection. Arguments are the Login token, the space Id, connectionName, databaseType, cubeName, importType and cacheable.

importPackage

Imports a package into the space. Arguments are the Login token, spaceFrom Id (parent space Id), package name, spaceTo Id (child space Id).

isDataUploadComplete

Deprecated, replaced with isJobComplete. Called to see if the data that was uploaded has finished processing. Arguments are the Login token and the data upload token. Returns true if processing is complete and false otherwise.

isJobComplete

Called to see if an asychonous job has finished processing. Arguments are the Login token and the job token. Returns true if processing is complete and false otherwise.

isPublishingComplete

Deprecated, replaced with isJobComplete. Determines if publishing has completed. Arguments are Login token and publishing token. Return true if publishing has completed and false otherwise.

isWdcAvailable

Returns the response whether current user has access to Web Data Connector.

linkProfileToAccount

This method links a profile to an account. Arguments required are Login token and profileID.

linkProfileToUsers

This method links a profile to multiple users. Arguments required are Login token and profileID.

listAllManagedUsers

List all users' details managed by the logged in user. Arguments are the Login token.

listAllSpaces

Lists all spaces that are owned by Users in this account. Arguments are the login token.

listAllowedIPAddrsForAccount

Lists IPs/CIDR netblocks that a users in the account is allowed to log in from. Argument is the Login token.

listAllowedIps

Lists IPs/CIDR netblocks that a user is allowed to log in from. Arguments are the Login token and the name of the user.

listCloudConnections

Lists cloud connections. Arguments are Login token and spaceId. It would return list of connection.

listCreatedUsers

Lists all users managed by the logged in user. Arguments are the Login token.

listCustomSubjectAreas

Lists all subject areas in a space. Arguments are the login token and the space id.

listEmailDomains

Lists email domains

listGroupAclsInSpace

Lists group ACLs in a space. The method will return a list of ACLs associated with the grroup. Arguments are the Login token, the name of the group and the space Id.

listGroupsInSpace

List the names of the group in a space. Arguments are the Login token and the space Id.

listLanguages

Returns a list of locales in the sytem. Arguments are the Login token.

listManagedUsers

Lists all users managed by the logged in user. Arguments are the Login token.

listOpenIDs

Lists all OpenIDs for a user. Arguments are the Login token and the name of the user.

listProfiles

Lists all the profiles for an account. Arguments required are Login token and accountID.

listProxyUsers

Lists all users who can proxy for a specific user. Arguments are the Login token and the name of the user.

listReleases

Lists all releases. Argument is the Login token.

listSpaces

Lists all spaces that this user has access to. Arguments are the login token.

listUserGroupMembership

Lists all groups that a user belongs to within a space. Arguments are Login token, space Id, user name, include system groups flag.

listUsersInGroupInSpace

Lists all users in a group for a space. Arguments are Login token, name of group and space Id.

listUsersInSpace

Lists all users who have access to a space. Arguments are the Login token and the space Id. A list of user names will be returned.

loadStagingtableFromS3Bucket

Direct Loads Stagingtable from S3 bucket.

Login

Logs in to this web service. Pass the user name and password of the administrator. A token will be returned that should be used for all remaining calls. The token will expire after a certain amount of inactivity or after logout.

LoginViaSaml

Logs in to this web service. Pass the base64 encoded saml assertion. A token will be returned that should be used for all remaining calls. The token will expire after a certain amount of inactivity or after logout.

Logout

Logs out of this web service. Pass the Login token as the argument.

mapAgentsToConnections

Deprecated, replaced with setAgentsToConnectionMapping. Map Agents to Connections. Arguments are Login token, space id, and connection to agent mappings.

mapLiveAccessSource

Adds or Updates Live Access source. Arguments are the login token, space Id, and the source meta data.

migrateLAConnectionToBC2

Migrates BC1 connection to BC2 cloud connection. Arguments are Login token, space id, BC1 connection name and agent name.

MigrateSecurity

Migrates security based on the metadata of files in the catalog.

migrateSpace

Migrates the repository and datastore from source space to target space (operations only). The arguments are Login token, source space Id and target space Id for migration. It returns a job token.

modifyRealTimeConnectionInformation

Modifies real time connection information. Arguments are the Login token, the space id, the name of the connection, the host, the port, the name of the database, the user name, the password and the timeout.

publishData

Starts the processing of uploaded data sources. Arguments are Login token, space id, subgroups (if defined in the space), and the date to use as the load date. Returns a publishing token. Call getDetailedJobStatus and isJobComplete to check the status.

queryMore

Returns additional results from a previously executed Birst Logical Query. Arguments are the Login token and the query token from the previous logical query. Returns the next 1000 results.

rebuildIndices

Rebuilds Indices on the database.

registerBirstConnectAgent

Registers a new birst connect agent. Arguments are Login token, agent name and agent description and returns the unique id of the registered agent.

ReindexFiles

Forces a reindex of the catalog for searchability.

ResetCatalogIndex

Resets the catalog metadata that has been collected so far for this space.

ResynchronizeFiles

Resynchronizes the metadata of files in the catalog.

removeAclFromGroupInSpace

Removes an ACL from a group in a space. Arguments are the Login token, the name of the group, the name of the ACL and the space Id.

removeAllowedIPAddrForAccount

Removes an IP address / CIDR netblock for users in the account to be able to log in from. Arguments are the Login token and the IP address / CIDR netblock.

removeAllowedIp

Removes an IP address / CIDR netblock for a user to be able to log in from. Arguments are the Login token, the name of the user and the IP address / CIDR netblock.

removeEmailDomains

Removes email domains.

removeExpressionFromSubjectArea

Removes Saved Expression from Custom Subject Area. Arguments are login token,expression name, subject area name , location

removeGroupFromSpace

Removes a group from a space. Arguments are the Login token, the name of the group and the space Id.

removeOpenID

Removes an OpenID for a user. Arguments are the Login token, the name of the user and the OpenID identifier.

removeProductFromUser

Removes a product from the user. Arguments are the Login token, the name of the user and product id.

removeProxyUser

Removes a proxy user for a user. Arguments are the Login token, the name of the user who has a proxy user and the name of the proxy user.

removeSfdcAccountMapping

Removes mapping of SFDC account to Birst account.

removeUserFromGroupInSpace

Removes a user from a group. Arguments are the Login token, the name of the user to remove, the name of the group and the space Id.

removeUserFromSpace

Removes a user from a space (that user will no longer have access to the space). Arguments are the Login token, the name of the user and the space Id.

renameFileOrDirectory

Renames a catalog entry or folder. Arguments are login token, space id, name of entry or folder and the new name.

renameSubjectArea

Renames the custom subject area in a space. Arguments are login token, space id, custom subject area old name and new name.

replaceExpressionInReport

Replaces all occurrences of the existing global expression in a report with the new global expression. Arguments are the Login token, the space Id, the report path, the report name, the existing global expression name and the new global expression name.

repointConnection

Re-points cloud connection. Arguments are Login token, space id, original cloud connection id and new cloud connection id.

repointNetworks

Re-points networks in a space. Arguments are the Login token, childSpaceId, oldParentSpaceId, newParentSpaceId.

repointPackages

Re-points packages in a space. Arguments are the Login token, childSpace Id, oldParentSpace Id, newParentSpace Id.

resetPassword

Resets the password for a user. The arguments are the Login token and the name of the user to reset.

resynchronizeSubjectAreas

Updates/Creates indexing data for subject areas.

saveQueryReport

Creates a visualizer report from a BQL query. Arguments are the Login token, the space Id, the report path, the report name and the BQL query.

scheduleExportReport

Schedules a report to be exported and sent to given email addresses.

setAgentsToConnectionMapping

Map Agents to Connections. Arguments are Login token, and connection to agent mappings.

setBackgroundColorForSpace

Sets the background color for space. Arguments are the Login token, the space Id, and the background color.

setCatalogPermissions

Sets permissions for a user on a space (bulk operation). Arguments are Login token, space id, directories, group names, permissions and values for permissions.

setDashboardView

Sets the dashboard view for the user with input username.

setDataCharacteristics

Sets data characteristics for given source. Arguments are Login token, space Id, sourceName and data characteristics. Possible data characteristics options and value formats are: OnlyQuoteAfterSeparator=[true|false], DoNotTreatCarriageReturnAsNewline=[true|false], HasHeaders=[true|false], ForceNumColumns=[true|false], Separator=[char], IgnoredRows=[number], IgnoredLastRows=[number], Quote=[char], Encoding=[string]. This API should only be used for sources getting extracted through SFTP connector. Please use the "Data Characteristics" option in Modeler Connect for sources extracted using other connectors.

setDataUploadOptions

Sets Data upload options for a particular source. Arguments are the Login token, the data upload token and an array of options in the form of optionName=optionValue. Valid options are ConsolidateIdenticalStructures=[true|false], ColumnNamesInFirstRow=[true|false], FilterLikelyNoDataRows=[true|false], LockDataSourceFormat=[true|false], IgnoreQuotesNotAtStartOrEnd=[true|false], RowsToSkipAtStart=n, RowsToSkipAtEnd=n, CharacterEncoding=enc, Separator=

setDefaultLogoForSpace

Sets the default logo for space. Arguments are the Login token, the space Id.

setDenyAddSpace

Sets the flag to deny user to create new space.

setDirectoryPermission

Sets a permission on a directory. Arguments are Login token, space id, directory, group name, permission and value for permission.

setDirectoryPermissions

Sets permissions for a user on a space (bulk operation). Arguments are Login token, space id, directories, group names, permissions and values for permissions.

setEmailFromForSpace

Sets the email address for a space. Arguments are the Login token, the space Id, and the email. The email must be in valid format.

setEmailSubjectForSpace

Sets the email subject for a space. Arguments are the Login token, the space Id, and the subject.

setForegroundColorForSpace

Sets the foreground color for space. Arguments are the Login token, the space Id, and the foreground color.

setLanguageForUser

Sets the locale for a user. Arguments are the Login token, the user name and the language id.

setLiveAccessColumnProperties

Sets LiveAccess column properties. Arguments are the Login token, the space Id and the column properties data.

setLiveAccessSourceDetails

Sets LiveAccess source data. Arguments are the Login token, the space Id, and source data.

setLogoForSpace

Sets the logo for space. Arguments are the Login token, the space Id, and the byte array.

setProfileProperty

Updates property in a profile. Arguments required are Login token, profileID and ProfileProperty.

setSourceDetails

Sets source data. Arguments are the Login token, the space Id and the source data.

setSpaceComments

Sets the space comments. Arguments are the Login token, the space Id, and the spaceComments. The spaceName must be less than 2048 characters.

setSpaceName

Sets the space name. Arguments are the Login token, the space Id, and the spaceName. The spaceName must be less than 256 characters and required.

SetSpaceProperties

Sets the properties of the space. Space has to be in Available state.

setSpaceProcessEngineVersion

Sets the space processing version. Arguments are the Login token, the space Id, and the processingVersion. The spaceName must be less than 2048 characters.

setSpaceSSOPassword

Sets the SSO Password for a space. Arguments are the Login token, the space Id, and the password. The password must be at least 8 characters.

setSubjectArea

Sets the subject area for a space. Arguments are login token, space id, subject area content.

setSubjectAreaDescription

Sets the description for a subject area in a space. Arguments are login token, space id, subject area name and description.

setSubjectAreaPermissions

Sets the permissions for a subject area in a space. Arguments are login token, space id, subject area name and group names.

setUpGenericJDBCRealTimeConnectionForSpace

Adds generic JDBC database type real time connection information. Arguments are the Login token, the space Id, configFileName, connectionName, useDirectConnection, sqlType, driverName, connectionString, filter, userName, password and timeout.

setUpRealTimeConnectionForSpace

Adds real time connection information. Arguments are the Login token, the space Id, configFileName, connectionName, databaseType, useDirectConnection, host, port, databaseName, userName, password and timeout.

setUserDefaultSpace

Sets the default space for a user. Arguments are the Login token, the name of the user, the name of the space, and if the user should default to dashboards.

setUserPassword

Sets the password for a user. Arguments are the Login token, the user name, and the password.

setUserRelease

Sets the release for a user. Arguments are the Login token, the name of the user and the release.

setVariableInSpace

Sets a variable value. Arguments are the Login token, the name of the variable, the value (query) of the variable and the space Id.

submitExportJob

Kicks off an export job.

swapSpaceContents

Swaps 2 spaces. The arguments are the Login token, and the Id's of the 2 spaces. Returns a job token.

swapSpaceForPackages

Swaps 2 spaces and align the created packages (swap the created space IDs in the packages). The arguments are the Login token, and the names of the 2 spaces. Returns a job token.

toggleWhiteSpaceEnablement

Toggles white space patch enablement for designer reports.

unlinkProfileFromAccount

This method unlinks a profile from account. Arguments required are Login token.

unlinkProfileFromUsers

This method unlinks a profile from multiple users. Arguments required are Login token and profileID.

unlockUser

Unlocks a User. Arguments are the Login token and a username.

updateBirstConnectAgent

Updates an existing birst connect agent. Arguments are Login token, agent ID, new agent name and new agent description and returns true if successful.

updateCloudConnection

Updates cloud connection. Arguments are Login token, space id, connection id and cloud connection.

updateExpression

Updates an existing expression. Arguments are the Login token, the space Id and the Expression to update.

updateHierarchy

Updates hierarchy information for the space specified.

updateProfile

Updates profile information. Arguments required are Login token and profileID.

updateUser

Updates user details. Arguments are the Login token, the name of the user and additional parameters. The username must be unique in the Birst system. Additional parameters are a list of name=value pairs separated by spaces. Valid names are 'email=', for example 'email=foo@bar.com'.

upgradeAgent

Upgrades an existing birst connect agent. Arguments are Login token and agent IDs and returns true if successful.

uploadData

Uploads a chunk of data from a particular source. Arguments are Login token, data upload token, the number of bytes sent and a byte array of data. Typically the data would be chunked instead of sending the entire file for performance.

uploadImageToReportCatalog

Uploads image to report catalog. Arguments are the Login token, the space Id, and the byte array.