SOAP Web Service Methods by Category
This topic lists common use cases for Birst SOAP Web Services and the related methods.
To see the SOAP envelopes for a method, access the WSDL documentation at:
https://server_URL/CommandWebService.asmx
Important: The CommandWebService information lists SOAP 1.2 which is not supported.
- Authentication and Logout
- User and Group Management
- Space Management
- Data Management
- Report and Other Space Object Management
- OEM or White-labeling Tasks
Authentication and Logout
User and Group Management
- Provisioning New Users
- Managing Existing Users
- Disabling or Deleting Users
- Managing User Access to Spaces and Groups
- Creating and Managing Groups
Provisioning New Users
Commonly used methods for provisioning new users include:
- addUser
- addOpenID
- setDenyAddSpace
- setUserRelease
- setDashboardView
- addAllowedIP
- setLanguageForUser
- addProductToUser
- addUserToSpace
- addUserToGroupInSpace
Additional settings that are not available as web services may be needed.
Managing Existing Users
After a user account is set up, you can get its existing settings and change them.
- addOpenID
- addProductToUser
- addUserToSpace
- addUserToGroupInSpace
- setDenyAddSpace
- setUserRelease
- setDashboardView
- AddAllowedIP
- AddAllowedIPAddrForAccount
- addProxyUser
The following methods provide information about a user's existing setup.
- getLanguageForUser
- getUserRelease
- getUsersForProfile
- setLanguageForUser
- getUserProfile (see User Profile below)
- getDashboardView
- listCreatedUsers
- listManagedUsers
- listOpenIDs
- listProxyUsers
- listUserGroupMembership
- listUsersInGroupInSpace
- listUsersInSpace
The following methods update user settings.
- removeOpenID
- removeProductFromUser
- removeProxyUser
- removeUserFromGroupInSpace
- removeUserFromSpace
- removeAllowedIP
- removeAllowedIPAddrForAccount
- resetPassword
- setCatalogPermissions
- setDashboardView
- setUserDefaultSpace
- setUserPassword
Disabling or Deleting Users
You can disable a user account without deleting it, or delete it from the system.
- enableUser - disables or enables
Before you delete a user, find out what spaces they own and decide whether to keep them or not. When you delete a user the spaces owned by that user are no longer available. If you want to keep a space, contact Support to have Cloud Operations change the ownership of the space to another user.
Managing User Access to Spaces and Groups
Creating and Managing Groups
- listGroupsInSpace
- addGroupToSpace
- listGroupAclsInSpace
- addAclToGroupInSpace
- removeAclFromGroupInSpace
- removeGroupFromSpace
- listUserGroupMembership
- listUsersInGroupInSpace
- addUserToGroupInSpace
- removeUserFromGroupInSpace
Space Management
- Setting Up a New Space
- Copying or Swapping Spaces
- Copy from One Space to Another or Within a Space
- General Space Management
- Deleting Spaces
Setting Up a New Space
The following methods help you provision new spaces.
Tip: Use the copyspace method to seed a new space.
- createNewSpace
- createNewSpaceUsingSchema - Appliance only
- createSubjectArea
- setSpaceName
- setSpaceSSOPassword
- setLogoForSpace
- setSpaceProcessingEngineVersion
- setSpaceSSOPassword
- setBackgroundColorForSpace
- setDefaultLogoForSpace
- setSubjectArea
- setSubjectAreaDescription
- setSubjectAreaPermissions
Copying or Swapping Spaces
Copy from One Space to Another or Within a Space
General Space Management
Deleting Spaces
Data Management
- Uploading Files
- Uploading Connector Data
- Birst Connect
- Manage Data Mashups
- ODBC
- Salesforce Integration
- Processing Data for a Space
- Deleting or Disabling Data
- Clear Caches
- Add or Update a Live Access Source
Uploading Files
See SOAP C# Example: Upload a File.
Uploading Connector Data
Amazon S3
Birst Connect
Manage Data Mashups
Added API support for importing packages from one space to another by using package name rather than packageID.
- The importPackage API now requires a valid login token and the following arguments:
spaceFromID
packageName
spaceToID
- The repointPackages API lets users point parent packages in a copied or cloned child space from the original Parent space to a copy of that Parent space.
ODBC
Salesforce Integration
Processing Data for a Space
Deleting or Disabling Data
- deleteAllDataFromSpace
- deleteLastDataFromSpace
- deleteExpression
- deleteFileOrDirectory
- deleteSubjectArea
- enableSourceInSpace
Clear Caches
Add or Update a Live Access Source
Modeling Hierarchies and Levels
Modeling Live Access Spaces
- enableSourceInSpace
- getLiveAccessColumnProperties
- getLiveAccessSourceDetails
- setSourceDetails
- importCubeMetaDataIntoSpace
- mapLiveAccessSource
- modifyRealTimeConnectionInformation
- setLiveAccessColumnProperties
- setLiveAccessSourceDetails
- setUpGenericJDBCRealTimeConnectionForSpace
- setUpRealTimeConnectionForSpace
Managing Reports and Other Space Objects
- addExpressionToSubjectArea
- checkAndCreateDirectory
- createNewDirectory
- createExpression
- deleteExpression
- createSubjectArea
- deleteSubjectArea
- checkAndCreateDirectory
- executeScheduledReport
- exportReportToCSV (Designer only)
- exportReportToPDF (Designer and Visualizer)
- exportReportToPNG (Designer only)
- exportReportToPPT (Designer only)
- exportReportToRTF (Designer only)
- exportReportToXLS (Designer and Visualizer)
- getDirectoryContents
- getDirectoryPermissions
- getExportData
- getExpression
- getExtendedSubjectArea
- getReportData
- getSubjectAreaContent
- getSubjectAreaDescription
- getSubjectAreaPermissions
- getUpdatedSubjectArea
- getVariablesForSpace
- listCustomSubjectAreas
- removeExpressionFromSubjectArea
- renameDashboard
- renameDashboardPage
- renameSubjectArea
- scheduleExportReport
- setDirectoryPermission
- setDirectoryPermissions
Emails and Restricting Report Distribution
- setEmailFromForSpace
- setEmailSubjectForSpace
- setForegroundColorForSpace
- addEmailDomains
- listEmailDomains
- removeEmailDomains
BQL
OEM or White-labeling Tasks
Account Setup
User Profiles
User profiles provide a way to customize the look and feel of Birst.
- createProfile
- getDefaultProfile
- getDefaultProfileDetails
- getProfile
- getProfileDetails
- getProfileForUser
- getProfileProperty
- getProfilePropertyWithLocale
- getUsersForProfile
- getUserProfile
- getUserProfileDetails
- deleteLocaleValueInProfileProperty
- deleteProfile
- listProfiles
- setProfileProperty
- linkProfileToAccount
- unlinkProfileFromAccount
- linkProfileToUsers
- unlinkProfileFromUsers
- updateProfile