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

Provisioning New Users

Commonly used methods for provisioning new users include:

Additional settings that are not available as web services may be needed. See Workflow for Creating and Enabling Users.

For a code example, see Python Example: Add a New User.

Managing Existing Users

After a user account is set up, you can get its existing settings and change them.

The following methods provide information about a user's existing setup.

The following methods update user settings.

Disabling or Deleting Users

You can disable a user account without deleting it, or delete it from the system.

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

Space Management

Setting Up a New Space

The following methods help you provision new spaces.

Tip: Use the copyspace method to seed a new space.

Copying or Swapping Spaces

Copy from One Space to Another or Within a Space

General Space Management

Deleting Spaces

Data Management

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

Clear Caches

Add or Update a Live Access Source

Modeling Hierarchies and Levels

Modeling Live Access Spaces

Managing Reports and Other Space Objects

Emails and Restricting Report Distribution

BQL

OEM or White-labeling Tasks

Account Setup

User Profiles

User profiles provide a way to customize the look and feel of Birst.

In the Help see User Profiles and Example User Profiles Code.