CommandWebServices

A webservice that performs provisioning and execution for Birst. These operations are supported. For a formal definition, please review the Service Description.

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

GetSpaceProperties

Gets the properties of the space.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/GetSpaceProperties"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetSpaceProperties xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
    </GetSpaceProperties>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetSpacePropertiesResponse xmlns="http://www.birst.com/">
      <GetSpacePropertiesResult>
        <SpaceName>string</SpaceName>
        <SpaceTimeZone>string</SpaceTimeZone>
        <UsageTracking>boolean</UsageTracking>
        <IsDocumentRepository>boolean</IsDocumentRepository>
        <AlwaysOn>boolean</AlwaysOn>
        <DatabaseLinks>boolean</DatabaseLinks>
        <ReadOnly>boolean</ReadOnly>
        <DefaultAnalyzeByDate>boolean</DefaultAnalyzeByDate>
      </GetSpacePropertiesResult>
    </GetSpacePropertiesResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetSpaceProperties xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
    </GetSpaceProperties>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetSpacePropertiesResponse xmlns="http://www.birst.com/">
      <GetSpacePropertiesResult>
        <SpaceName>string</SpaceName>
        <SpaceTimeZone>string</SpaceTimeZone>
        <UsageTracking>boolean</UsageTracking>
        <IsDocumentRepository>boolean</IsDocumentRepository>
        <AlwaysOn>boolean</AlwaysOn>
        <DatabaseLinks>boolean</DatabaseLinks>
        <ReadOnly>boolean</ReadOnly>
        <DefaultAnalyzeByDate>boolean</DefaultAnalyzeByDate>
      </GetSpacePropertiesResult>
    </GetSpacePropertiesResponse>
  </soap12:Body>
</soap12:Envelope>

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.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/Login"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <Login xmlns="http://www.birst.com/">
      <username>string</username>
      <password>string</password>
    </Login>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <LoginResponse xmlns="http://www.birst.com/">
      <LoginResult>string</LoginResult>
    </LoginResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <Login xmlns="http://www.birst.com/">
      <username>string</username>
      <password>string</password>
    </Login>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <LoginResponse xmlns="http://www.birst.com/">
      <LoginResult>string</LoginResult>
    </LoginResponse>
  </soap12:Body>
</soap12:Envelope>

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.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/LoginViaSaml"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <LoginViaSaml xmlns="http://www.birst.com/">
      <samlResponse>string</samlResponse>
    </LoginViaSaml>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <LoginViaSamlResponse xmlns="http://www.birst.com/">
      <LoginViaSamlResult>string</LoginViaSamlResult>
    </LoginViaSamlResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <LoginViaSaml xmlns="http://www.birst.com/">
      <samlResponse>string</samlResponse>
    </LoginViaSaml>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <LoginViaSamlResponse xmlns="http://www.birst.com/">
      <LoginViaSamlResult>string</LoginViaSamlResult>
    </LoginViaSamlResponse>
  </soap12:Body>
</soap12:Envelope>

Logout

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/Logout"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <Logout xmlns="http://www.birst.com/">
      <token>string</token>
    </Logout>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <LogoutResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <Logout xmlns="http://www.birst.com/">
      <token>string</token>
    </Logout>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <LogoutResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

MigrateSecurity

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/MigrateSecurity"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <MigrateSecurity xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
    </MigrateSecurity>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <MigrateSecurityResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <MigrateSecurity xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
    </MigrateSecurity>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <MigrateSecurityResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

ReindexFiles

Forces a reindex of the catalog for searchability.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/ReindexFiles"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ReindexFiles xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
    </ReindexFiles>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ReindexFilesResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <ReindexFiles xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
    </ReindexFiles>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <ReindexFilesResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

ResetCatalogIndex

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/ResetCatalogIndex"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ResetCatalogIndex xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
    </ResetCatalogIndex>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ResetCatalogIndexResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <ResetCatalogIndex xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
    </ResetCatalogIndex>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <ResetCatalogIndexResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

ResynchronizeFiles

Resynchronizes the metadata of files in the catalog.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/ResynchronizeFiles"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ResynchronizeFiles xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <forceStateUpdate>boolean</forceStateUpdate>
    </ResynchronizeFiles>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ResynchronizeFilesResponse xmlns="http://www.birst.com/">
      <ResynchronizeFilesResult>string</ResynchronizeFilesResult>
    </ResynchronizeFilesResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <ResynchronizeFiles xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <forceStateUpdate>boolean</forceStateUpdate>
    </ResynchronizeFiles>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <ResynchronizeFilesResponse xmlns="http://www.birst.com/">
      <ResynchronizeFilesResult>string</ResynchronizeFilesResult>
    </ResynchronizeFilesResponse>
  </soap12:Body>
</soap12:Envelope>

SetSpaceProperties

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/SetSpaceProperties"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <SetSpaceProperties xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <spaceProperties>
        <SpaceName>string</SpaceName>
        <SpaceTimeZone>string</SpaceTimeZone>
        <UsageTracking>boolean</UsageTracking>
        <IsDocumentRepository>boolean</IsDocumentRepository>
        <AlwaysOn>boolean</AlwaysOn>
        <DatabaseLinks>boolean</DatabaseLinks>
        <ReadOnly>boolean</ReadOnly>
        <DefaultAnalyzeByDate>boolean</DefaultAnalyzeByDate>
      </spaceProperties>
    </SetSpaceProperties>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <SetSpacePropertiesResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <SetSpaceProperties xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <spaceProperties>
        <SpaceName>string</SpaceName>
        <SpaceTimeZone>string</SpaceTimeZone>
        <UsageTracking>boolean</UsageTracking>
        <IsDocumentRepository>boolean</IsDocumentRepository>
        <AlwaysOn>boolean</AlwaysOn>
        <DatabaseLinks>boolean</DatabaseLinks>
        <ReadOnly>boolean</ReadOnly>
        <DefaultAnalyzeByDate>boolean</DefaultAnalyzeByDate>
      </spaceProperties>
    </SetSpaceProperties>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <SetSpacePropertiesResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

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.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/addAclToGroupInSpace"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <addAclToGroupInSpace xmlns="http://www.birst.com/">
      <token>string</token>
      <groupName>string</groupName>
      <aclTag>string</aclTag>
      <spaceID>string</spaceID>
    </addAclToGroupInSpace>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <addAclToGroupInSpaceResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <addAclToGroupInSpace xmlns="http://www.birst.com/">
      <token>string</token>
      <groupName>string</groupName>
      <aclTag>string</aclTag>
      <spaceID>string</spaceID>
    </addAclToGroupInSpace>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <addAclToGroupInSpaceResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

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.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/addAllowedIPAddrForAccount"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <addAllowedIPAddrForAccount xmlns="http://www.birst.com/">
      <token>string</token>
      <ip>string</ip>
    </addAllowedIPAddrForAccount>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <addAllowedIPAddrForAccountResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <addAllowedIPAddrForAccount xmlns="http://www.birst.com/">
      <token>string</token>
      <ip>string</ip>
    </addAllowedIPAddrForAccount>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <addAllowedIPAddrForAccountResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

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.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/addAllowedIp"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <addAllowedIp xmlns="http://www.birst.com/">
      <token>string</token>
      <userName>string</userName>
      <ip>string</ip>
    </addAllowedIp>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <addAllowedIpResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <addAllowedIp xmlns="http://www.birst.com/">
      <token>string</token>
      <userName>string</userName>
      <ip>string</ip>
    </addAllowedIp>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <addAllowedIpResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

addCloudConnection

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/addCloudConnection"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <addCloudConnection xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <accountID>string</accountID>
      <cloudConnection>
        <name>string</name>
        <guid>string</guid>
        <connectorType>string</connectorType>
        <connectorAPIVersion>string</connectorAPIVersion>
        <connectionProperties>
          <ConnectionProperty>
            <name>string</name>
            <value>string</value>
            <saveToConfig>boolean</saveToConfig>
            <isSecret>boolean</isSecret>
            <isRequired>boolean</isRequired>
            <isEncrypted>boolean</isEncrypted>
            <displayIndex>int</displayIndex>
            <displayLabel>string</displayLabel>
            <displayType>string</displayType>
            <tooltip>string</tooltip>
          </ConnectionProperty>
          <ConnectionProperty>
            <name>string</name>
            <value>string</value>
            <saveToConfig>boolean</saveToConfig>
            <isSecret>boolean</isSecret>
            <isRequired>boolean</isRequired>
            <isEncrypted>boolean</isEncrypted>
            <displayIndex>int</displayIndex>
            <displayLabel>string</displayLabel>
            <displayType>string</displayType>
            <tooltip>string</tooltip>
          </ConnectionProperty>
        </connectionProperties>
        <dateCreated>long</dateCreated>
        <dateModified>long</dateModified>
        <createdBy>string</createdBy>
        <modifiedBy>string</modifiedBy>
        <startExtractionTime>long</startExtractionTime>
        <endExtractionTime>long</endExtractionTime>
        <migratedConnection>string</migratedConnection>
        <objectsConfigured>boolean</objectsConfigured>
        <onPremise>boolean</onPremise>
        <liveAccess>boolean</liveAccess>
        <restricted>boolean</restricted>
        <shared>boolean</shared>
        <datasourceId>string</datasourceId>
        <agentIDs>
          <string>string</string>
          <string>string</string>
        </agentIDs>
        <agentGroup>string</agentGroup>
      </cloudConnection>
    </addCloudConnection>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <addCloudConnectionResponse xmlns="http://www.birst.com/">
      <addCloudConnectionResult>string</addCloudConnectionResult>
    </addCloudConnectionResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <addCloudConnection xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <accountID>string</accountID>
      <cloudConnection>
        <name>string</name>
        <guid>string</guid>
        <connectorType>string</connectorType>
        <connectorAPIVersion>string</connectorAPIVersion>
        <connectionProperties>
          <ConnectionProperty>
            <name>string</name>
            <value>string</value>
            <saveToConfig>boolean</saveToConfig>
            <isSecret>boolean</isSecret>
            <isRequired>boolean</isRequired>
            <isEncrypted>boolean</isEncrypted>
            <displayIndex>int</displayIndex>
            <displayLabel>string</displayLabel>
            <displayType>string</displayType>
            <tooltip>string</tooltip>
          </ConnectionProperty>
          <ConnectionProperty>
            <name>string</name>
            <value>string</value>
            <saveToConfig>boolean</saveToConfig>
            <isSecret>boolean</isSecret>
            <isRequired>boolean</isRequired>
            <isEncrypted>boolean</isEncrypted>
            <displayIndex>int</displayIndex>
            <displayLabel>string</displayLabel>
            <displayType>string</displayType>
            <tooltip>string</tooltip>
          </ConnectionProperty>
        </connectionProperties>
        <dateCreated>long</dateCreated>
        <dateModified>long</dateModified>
        <createdBy>string</createdBy>
        <modifiedBy>string</modifiedBy>
        <startExtractionTime>long</startExtractionTime>
        <endExtractionTime>long</endExtractionTime>
        <migratedConnection>string</migratedConnection>
        <objectsConfigured>boolean</objectsConfigured>
        <onPremise>boolean</onPremise>
        <liveAccess>boolean</liveAccess>
        <restricted>boolean</restricted>
        <shared>boolean</shared>
        <datasourceId>string</datasourceId>
        <agentIDs>
          <string>string</string>
          <string>string</string>
        </agentIDs>
        <agentGroup>string</agentGroup>
      </cloudConnection>
    </addCloudConnection>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <addCloudConnectionResponse xmlns="http://www.birst.com/">
      <addCloudConnectionResult>string</addCloudConnectionResult>
    </addCloudConnectionResponse>
  </soap12:Body>
</soap12:Envelope>

addEmailDomains

Adds email domains

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/addEmailDomains"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <addEmailDomains xmlns="http://www.birst.com/">
      <token>string</token>
      <domainList>
        <string>string</string>
        <string>string</string>
      </domainList>
    </addEmailDomains>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <addEmailDomainsResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <addEmailDomains xmlns="http://www.birst.com/">
      <token>string</token>
      <domainList>
        <string>string</string>
        <string>string</string>
      </domainList>
    </addEmailDomains>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <addEmailDomainsResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

addExpressionToSubjectArea

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/addExpressionToSubjectArea"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <addExpressionToSubjectArea xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <expressionName>string</expressionName>
      <csaName>string</csaName>
      <location>string</location>
    </addExpressionToSubjectArea>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <addExpressionToSubjectAreaResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <addExpressionToSubjectArea xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <expressionName>string</expressionName>
      <csaName>string</csaName>
      <location>string</location>
    </addExpressionToSubjectArea>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <addExpressionToSubjectAreaResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

addGroupToSpace

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/addGroupToSpace"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <addGroupToSpace xmlns="http://www.birst.com/">
      <token>string</token>
      <groupName>string</groupName>
      <spaceID>string</spaceID>
    </addGroupToSpace>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <addGroupToSpaceResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <addGroupToSpace xmlns="http://www.birst.com/">
      <token>string</token>
      <groupName>string</groupName>
      <spaceID>string</spaceID>
    </addGroupToSpace>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <addGroupToSpaceResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

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.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/addMask"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <addMask xmlns="http://www.birst.com/">
      <token>string</token>
      <userName>string</userName>
      <mask>string</mask>
    </addMask>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <addMaskResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <addMask xmlns="http://www.birst.com/">
      <token>string</token>
      <userName>string</userName>
      <mask>string</mask>
    </addMask>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <addMaskResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

addOpenID

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/addOpenID"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <addOpenID xmlns="http://www.birst.com/">
      <token>string</token>
      <userName>string</userName>
      <openID>string</openID>
    </addOpenID>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <addOpenIDResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <addOpenID xmlns="http://www.birst.com/">
      <token>string</token>
      <userName>string</userName>
      <openID>string</openID>
    </addOpenID>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <addOpenIDResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

addProductToUser

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/addProductToUser"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <addProductToUser xmlns="http://www.birst.com/">
      <token>string</token>
      <userName>string</userName>
      <productId>int</productId>
    </addProductToUser>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <addProductToUserResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <addProductToUser xmlns="http://www.birst.com/">
      <token>string</token>
      <userName>string</userName>
      <productId>int</productId>
    </addProductToUser>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <addProductToUserResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

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.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/addProxyUser"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <addProxyUser xmlns="http://www.birst.com/">
      <token>string</token>
      <userName>string</userName>
      <proxyUserName>string</proxyUserName>
      <expiration>dateTime</expiration>
    </addProxyUser>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <addProxyUserResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <addProxyUser xmlns="http://www.birst.com/">
      <token>string</token>
      <userName>string</userName>
      <proxyUserName>string</proxyUserName>
      <expiration>dateTime</expiration>
    </addProxyUser>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <addProxyUserResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

addSfdcAccountMapping

Adds mapping of SFDC account to Birst account

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/addSfdcAccountMapping"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <addSfdcAccountMapping xmlns="http://www.birst.com/">
      <token>string</token>
      <sfdcOrgID>string</sfdcOrgID>
    </addSfdcAccountMapping>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <addSfdcAccountMappingResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <addSfdcAccountMapping xmlns="http://www.birst.com/">
      <token>string</token>
      <sfdcOrgID>string</sfdcOrgID>
    </addSfdcAccountMapping>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <addSfdcAccountMappingResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

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.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/addUser"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <addUser xmlns="http://www.birst.com/">
      <token>string</token>
      <userName>string</userName>
      <additionalParams>string</additionalParams>
    </addUser>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <addUserResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <addUser xmlns="http://www.birst.com/">
      <token>string</token>
      <userName>string</userName>
      <additionalParams>string</additionalParams>
    </addUser>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <addUserResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

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.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/addUserToGroupInSpace"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <addUserToGroupInSpace xmlns="http://www.birst.com/">
      <token>string</token>
      <userName>string</userName>
      <groupName>string</groupName>
      <spaceID>string</spaceID>
    </addUserToGroupInSpace>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <addUserToGroupInSpaceResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <addUserToGroupInSpace xmlns="http://www.birst.com/">
      <token>string</token>
      <userName>string</userName>
      <groupName>string</groupName>
      <spaceID>string</spaceID>
    </addUserToGroupInSpace>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <addUserToGroupInSpaceResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

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.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/addUserToSpace"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <addUserToSpace xmlns="http://www.birst.com/">
      <token>string</token>
      <userName>string</userName>
      <spaceID>string</spaceID>
      <hasAdmin>boolean</hasAdmin>
    </addUserToSpace>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <addUserToSpaceResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <addUserToSpace xmlns="http://www.birst.com/">
      <token>string</token>
      <userName>string</userName>
      <spaceID>string</spaceID>
      <hasAdmin>boolean</hasAdmin>
    </addUserToSpace>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <addUserToSpaceResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

beginDataUpload

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/beginDataUpload"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <beginDataUpload xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <sourceName>string</sourceName>
    </beginDataUpload>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <beginDataUploadResponse xmlns="http://www.birst.com/">
      <beginDataUploadResult>string</beginDataUploadResult>
    </beginDataUploadResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <beginDataUpload xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <sourceName>string</sourceName>
    </beginDataUpload>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <beginDataUploadResponse xmlns="http://www.birst.com/">
      <beginDataUploadResult>string</beginDataUploadResult>
    </beginDataUploadResponse>
  </soap12:Body>
</soap12:Envelope>

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.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/cancelJob"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <cancelJob xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <jobToken>string</jobToken>
    </cancelJob>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <cancelJobResponse xmlns="http://www.birst.com/">
      <cancelJobResult>boolean</cancelJobResult>
    </cancelJobResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <cancelJob xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <jobToken>string</jobToken>
    </cancelJob>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <cancelJobResponse xmlns="http://www.birst.com/">
      <cancelJobResult>boolean</cancelJobResult>
    </cancelJobResponse>
  </soap12:Body>
</soap12:Envelope>

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.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/checkAndCreateDirectory"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <checkAndCreateDirectory xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <parentDir>string</parentDir>
      <newDirectoryName>string</newDirectoryName>
    </checkAndCreateDirectory>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <checkAndCreateDirectoryResponse xmlns="http://www.birst.com/">
      <checkAndCreateDirectoryResult>boolean</checkAndCreateDirectoryResult>
    </checkAndCreateDirectoryResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <checkAndCreateDirectory xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <parentDir>string</parentDir>
      <newDirectoryName>string</newDirectoryName>
    </checkAndCreateDirectory>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <checkAndCreateDirectoryResponse xmlns="http://www.birst.com/">
      <checkAndCreateDirectoryResult>boolean</checkAndCreateDirectoryResult>
    </checkAndCreateDirectoryResponse>
  </soap12:Body>
</soap12:Envelope>

clearCacheInSpace

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/clearCacheInSpace"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <clearCacheInSpace xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
    </clearCacheInSpace>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <clearCacheInSpaceResponse xmlns="http://www.birst.com/">
      <clearCacheInSpaceResult>boolean</clearCacheInSpaceResult>
    </clearCacheInSpaceResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <clearCacheInSpace xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
    </clearCacheInSpace>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <clearCacheInSpaceResponse xmlns="http://www.birst.com/">
      <clearCacheInSpaceResult>boolean</clearCacheInSpaceResult>
    </clearCacheInSpaceResponse>
  </soap12:Body>
</soap12:Envelope>

clearDashboardCache

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/clearDashboardCache"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <clearDashboardCache xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
    </clearDashboardCache>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <clearDashboardCacheResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <clearDashboardCache xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
    </clearDashboardCache>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <clearDashboardCacheResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

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.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/clearJobStatus"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <clearJobStatus xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <jobToken>string</jobToken>
    </clearJobStatus>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <clearJobStatusResponse xmlns="http://www.birst.com/">
      <clearJobStatusResult>boolean</clearJobStatusResult>
    </clearJobStatusResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <clearJobStatus xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <jobToken>string</jobToken>
    </clearJobStatus>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <clearJobStatusResponse xmlns="http://www.birst.com/">
      <clearJobStatusResult>boolean</clearJobStatusResult>
    </clearJobStatusResponse>
  </soap12:Body>
</soap12:Envelope>

clearODBCCacheInSpace

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/clearODBCCacheInSpace"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <clearODBCCacheInSpace xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
    </clearODBCCacheInSpace>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <clearODBCCacheInSpaceResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <clearODBCCacheInSpace xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
    </clearODBCCacheInSpace>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <clearODBCCacheInSpaceResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

cloneDashboardPage

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/cloneDashboardPage"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <cloneDashboardPage xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <request>
        <srcDashboardLocation>PUBLIC or PRIVATE</srcDashboardLocation>
        <srcDashboardName>string</srcDashboardName>
        <srcPageName>string</srcPageName>
        <destDashboardLocation>PUBLIC or PRIVATE</destDashboardLocation>
        <destDashboardName>string</destDashboardName>
        <destPageName>string</destPageName>
        <mode>DEEP or SHALLOW</mode>
      </request>
    </cloneDashboardPage>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <cloneDashboardPageResponse xmlns="http://www.birst.com/">
      <cloneDashboardPageResult>
        <status>PASS or FAIL</status>
        <destPageId>string</destPageId>
        <destDashboardId>string</destDashboardId>
        <destDashboardPath>string</destDashboardPath>
        <errorList>
          <ErrorMessage>
            <description>string</description>
            <type>string</type>
            <name>string</name>
          </ErrorMessage>
          <ErrorMessage>
            <description>string</description>
            <type>string</type>
            <name>string</name>
          </ErrorMessage>
        </errorList>
      </cloneDashboardPageResult>
    </cloneDashboardPageResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <cloneDashboardPage xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <request>
        <srcDashboardLocation>PUBLIC or PRIVATE</srcDashboardLocation>
        <srcDashboardName>string</srcDashboardName>
        <srcPageName>string</srcPageName>
        <destDashboardLocation>PUBLIC or PRIVATE</destDashboardLocation>
        <destDashboardName>string</destDashboardName>
        <destPageName>string</destPageName>
        <mode>DEEP or SHALLOW</mode>
      </request>
    </cloneDashboardPage>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <cloneDashboardPageResponse xmlns="http://www.birst.com/">
      <cloneDashboardPageResult>
        <status>PASS or FAIL</status>
        <destPageId>string</destPageId>
        <destDashboardId>string</destDashboardId>
        <destDashboardPath>string</destDashboardPath>
        <errorList>
          <ErrorMessage>
            <description>string</description>
            <type>string</type>
            <name>string</name>
          </ErrorMessage>
          <ErrorMessage>
            <description>string</description>
            <type>string</type>
            <name>string</name>
          </ErrorMessage>
        </errorList>
      </cloneDashboardPageResult>
    </cloneDashboardPageResponse>
  </soap12:Body>
</soap12:Envelope>

cloneDashboardPageV2

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/cloneDashboardPageV2"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <cloneDashboardPageV2 xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <request>
        <srcPageId>string</srcPageId>
        <destDashboardId>string</destDashboardId>
        <destPageName>string</destPageName>
        <mode>DEEP or SHALLOW</mode>
        <destDashboardName>string</destDashboardName>
        <destDashboardLocation>PUBLIC or PRIVATE</destDashboardLocation>
      </request>
    </cloneDashboardPageV2>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <cloneDashboardPageV2Response xmlns="http://www.birst.com/">
      <cloneDashboardPageV2Result>
        <status>PASS or FAIL</status>
        <destPageId>string</destPageId>
        <destDashboardId>string</destDashboardId>
        <destDashboardPath>string</destDashboardPath>
        <errorList>
          <ErrorMessage>
            <description>string</description>
            <type>string</type>
            <name>string</name>
          </ErrorMessage>
          <ErrorMessage>
            <description>string</description>
            <type>string</type>
            <name>string</name>
          </ErrorMessage>
        </errorList>
      </cloneDashboardPageV2Result>
    </cloneDashboardPageV2Response>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <cloneDashboardPageV2 xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <request>
        <srcPageId>string</srcPageId>
        <destDashboardId>string</destDashboardId>
        <destPageName>string</destPageName>
        <mode>DEEP or SHALLOW</mode>
        <destDashboardName>string</destDashboardName>
        <destDashboardLocation>PUBLIC or PRIVATE</destDashboardLocation>
      </request>
    </cloneDashboardPageV2>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <cloneDashboardPageV2Response xmlns="http://www.birst.com/">
      <cloneDashboardPageV2Result>
        <status>PASS or FAIL</status>
        <destPageId>string</destPageId>
        <destDashboardId>string</destDashboardId>
        <destDashboardPath>string</destDashboardPath>
        <errorList>
          <ErrorMessage>
            <description>string</description>
            <type>string</type>
            <name>string</name>
          </ErrorMessage>
          <ErrorMessage>
            <description>string</description>
            <type>string</type>
            <name>string</name>
          </ErrorMessage>
        </errorList>
      </cloneDashboardPageV2Result>
    </cloneDashboardPageV2Response>
  </soap12:Body>
</soap12:Envelope>

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/copyAccountSettings"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <copyAccountSettings xmlns="http://www.birst.com/">
      <token>string</token>
      <accountFromID>string</accountFromID>
      <accountToID>string</accountToID>
      <options>string</options>
      <mode>string</mode>
      <themes>
        <string>string</string>
        <string>string</string>
      </themes>
      <colorPalettes>
        <string>string</string>
        <string>string</string>
      </colorPalettes>
    </copyAccountSettings>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <copyAccountSettingsResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <copyAccountSettings xmlns="http://www.birst.com/">
      <token>string</token>
      <accountFromID>string</accountFromID>
      <accountToID>string</accountToID>
      <options>string</options>
      <mode>string</mode>
      <themes>
        <string>string</string>
        <string>string</string>
      </themes>
      <colorPalettes>
        <string>string</string>
        <string>string</string>
      </colorPalettes>
    </copyAccountSettings>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <copyAccountSettingsResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/copyAccountSettingsV2"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <copyAccountSettingsV2 xmlns="http://www.birst.com/">
      <token>string</token>
      <accountFromID>string</accountFromID>
      <accountToID>string</accountToID>
      <ownerID>string</ownerID>
      <options>string</options>
      <mode>string</mode>
      <themes>
        <string>string</string>
        <string>string</string>
      </themes>
      <colorPalettes>
        <string>string</string>
        <string>string</string>
      </colorPalettes>
    </copyAccountSettingsV2>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <copyAccountSettingsV2Response xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <copyAccountSettingsV2 xmlns="http://www.birst.com/">
      <token>string</token>
      <accountFromID>string</accountFromID>
      <accountToID>string</accountToID>
      <ownerID>string</ownerID>
      <options>string</options>
      <mode>string</mode>
      <themes>
        <string>string</string>
        <string>string</string>
      </themes>
      <colorPalettes>
        <string>string</string>
        <string>string</string>
      </colorPalettes>
    </copyAccountSettingsV2>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <copyAccountSettingsV2Response xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/copyCatalogDirectory"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <copyCatalogDirectory xmlns="http://www.birst.com/">
      <token>string</token>
      <spFromID>string</spFromID>
      <spToID>string</spToID>
      <directoryName>string</directoryName>
    </copyCatalogDirectory>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <copyCatalogDirectoryResponse xmlns="http://www.birst.com/">
      <copyCatalogDirectoryResult>string</copyCatalogDirectoryResult>
    </copyCatalogDirectoryResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <copyCatalogDirectory xmlns="http://www.birst.com/">
      <token>string</token>
      <spFromID>string</spFromID>
      <spToID>string</spToID>
      <directoryName>string</directoryName>
    </copyCatalogDirectory>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <copyCatalogDirectoryResponse xmlns="http://www.birst.com/">
      <copyCatalogDirectoryResult>string</copyCatalogDirectoryResult>
    </copyCatalogDirectoryResponse>
  </soap12:Body>
</soap12:Envelope>

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.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/copyCustomSubjectArea"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <copyCustomSubjectArea xmlns="http://www.birst.com/">
      <token>string</token>
      <fromSpaceId>string</fromSpaceId>
      <customSubjectAreaName>string</customSubjectAreaName>
      <toSpaceId>string</toSpaceId>
    </copyCustomSubjectArea>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <copyCustomSubjectAreaResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <copyCustomSubjectArea xmlns="http://www.birst.com/">
      <token>string</token>
      <fromSpaceId>string</fromSpaceId>
      <customSubjectAreaName>string</customSubjectAreaName>
      <toSpaceId>string</toSpaceId>
    </copyCustomSubjectArea>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <copyCustomSubjectAreaResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/copyFile"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <copyFile xmlns="http://www.birst.com/">
      <token>string</token>
      <fromSpaceID>string</fromSpaceID>
      <fromFileOrDir>string</fromFileOrDir>
      <toSpaceID>string</toSpaceID>
      <toFileOrDir>string</toFileOrDir>
      <overwrite>boolean</overwrite>
    </copyFile>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <copyFileResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <copyFile xmlns="http://www.birst.com/">
      <token>string</token>
      <fromSpaceID>string</fromSpaceID>
      <fromFileOrDir>string</fromFileOrDir>
      <toSpaceID>string</toSpaceID>
      <toFileOrDir>string</toFileOrDir>
      <overwrite>boolean</overwrite>
    </copyFile>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <copyFileResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/copyFileOrDirectory"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <copyFileOrDirectory xmlns="http://www.birst.com/">
      <token>string</token>
      <fromSpaceID>string</fromSpaceID>
      <fileOrDir>string</fileOrDir>
      <toSpaceID>string</toSpaceID>
      <toDir>string</toDir>
    </copyFileOrDirectory>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <copyFileOrDirectoryResponse xmlns="http://www.birst.com/">
      <copyFileOrDirectoryResult>string</copyFileOrDirectoryResult>
    </copyFileOrDirectoryResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <copyFileOrDirectory xmlns="http://www.birst.com/">
      <token>string</token>
      <fromSpaceID>string</fromSpaceID>
      <fileOrDir>string</fileOrDir>
      <toSpaceID>string</toSpaceID>
      <toDir>string</toDir>
    </copyFileOrDirectory>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <copyFileOrDirectoryResponse xmlns="http://www.birst.com/">
      <copyFileOrDirectoryResult>string</copyFileOrDirectoryResult>
    </copyFileOrDirectoryResponse>
  </soap12:Body>
</soap12:Envelope>

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/copySpace"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <copySpace xmlns="http://www.birst.com/">
      <token>string</token>
      <spFromID>string</spFromID>
      <spToID>string</spToID>
      <mode>string</mode>
      <options>string</options>
    </copySpace>
  </soap:Body>
</soap:Envelope>

Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <copySpaceResponse xmlns="http://www.birst.com/">
      <copySpaceResult>string</copySpaceResult>
    </copySpaceResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <copySpace xmlns="http://www.birst.com/">
      <token>string</token>
      <spFromID>string</spFromID>
      <spToID>string</spToID>
      <mode>string</mode>
      <options>string</options>
    </copySpace>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <copySpaceResponse xmlns="http://www.birst.com/">
      <copySpaceResult>string</copySpaceResult>
    </copySpaceResponse>
  </soap12:Body>
</soap12:Envelope>

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/copySpaceContents"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <copySpaceContents xmlns="http://www.birst.com/">
      <token>string</token>
      <spFromID>string</spFromID>
      <spToID>string</spToID>
    </copySpaceContents>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <copySpaceContentsResponse xmlns="http://www.birst.com/">
      <copySpaceContentsResult>string</copySpaceContentsResult>
    </copySpaceContentsResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <copySpaceContents xmlns="http://www.birst.com/">
      <token>string</token>
      <spFromID>string</spFromID>
      <spToID>string</spToID>
    </copySpaceContents>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <copySpaceContentsResponse xmlns="http://www.birst.com/">
      <copySpaceContentsResult>string</copySpaceContentsResult>
    </copySpaceContentsResponse>
  </soap12:Body>
</soap12:Envelope>

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/copyWorkflow"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <copyWorkflow xmlns="http://www.birst.com/">
      <token>string</token>
      <fromAccountId>string</fromAccountId>
      <fromWorkflowId>string</fromWorkflowId>
      <toAccountId>string</toAccountId>
      <workflowOwnerId>string</workflowOwnerId>
      <restricted>boolean</restricted>
      <mode>string</mode>
      <toWorkflowName>string</toWorkflowName>
      <spaceIdMapping>
        <SpaceIdMapping>
          <fromSpaceId>string</fromSpaceId>
          <toSpaceId>string</toSpaceId>
        </SpaceIdMapping>
        <SpaceIdMapping>
          <fromSpaceId>string</fromSpaceId>
          <toSpaceId>string</toSpaceId>
        </SpaceIdMapping>
      </spaceIdMapping>
      <userIdMapping>
        <UserIdMapping>
          <fromUserId>string</fromUserId>
          <toUserId>string</toUserId>
        </UserIdMapping>
        <UserIdMapping>
          <fromUserId>string</fromUserId>
          <toUserId>string</toUserId>
        </UserIdMapping>
      </userIdMapping>
      <connectionIdMapping>
        <ConnectionIdMapping>
          <fromConnectionId>string</fromConnectionId>
          <toConnectionId>string</toConnectionId>
        </ConnectionIdMapping>
        <ConnectionIdMapping>
          <fromConnectionId>string</fromConnectionId>
          <toConnectionId>string</toConnectionId>
        </ConnectionIdMapping>
      </connectionIdMapping>
      <applicationLidMapping>
        <ApplicationLidMapping>
          <fromApplicationLId>string</fromApplicationLId>
          <toApplicationLId>string</toApplicationLId>
        </ApplicationLidMapping>
        <ApplicationLidMapping>
          <fromApplicationLId>string</fromApplicationLId>
          <toApplicationLId>string</toApplicationLId>
        </ApplicationLidMapping>
      </applicationLidMapping>
    </copyWorkflow>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <copyWorkflowResponse xmlns="http://www.birst.com/">
      <copyWorkflowResult>string</copyWorkflowResult>
    </copyWorkflowResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <copyWorkflow xmlns="http://www.birst.com/">
      <token>string</token>
      <fromAccountId>string</fromAccountId>
      <fromWorkflowId>string</fromWorkflowId>
      <toAccountId>string</toAccountId>
      <workflowOwnerId>string</workflowOwnerId>
      <restricted>boolean</restricted>
      <mode>string</mode>
      <toWorkflowName>string</toWorkflowName>
      <spaceIdMapping>
        <SpaceIdMapping>
          <fromSpaceId>string</fromSpaceId>
          <toSpaceId>string</toSpaceId>
        </SpaceIdMapping>
        <SpaceIdMapping>
          <fromSpaceId>string</fromSpaceId>
          <toSpaceId>string</toSpaceId>
        </SpaceIdMapping>
      </spaceIdMapping>
      <userIdMapping>
        <UserIdMapping>
          <fromUserId>string</fromUserId>
          <toUserId>string</toUserId>
        </UserIdMapping>
        <UserIdMapping>
          <fromUserId>string</fromUserId>
          <toUserId>string</toUserId>
        </UserIdMapping>
      </userIdMapping>
      <connectionIdMapping>
        <ConnectionIdMapping>
          <fromConnectionId>string</fromConnectionId>
          <toConnectionId>string</toConnectionId>
        </ConnectionIdMapping>
        <ConnectionIdMapping>
          <fromConnectionId>string</fromConnectionId>
          <toConnectionId>string</toConnectionId>
        </ConnectionIdMapping>
      </connectionIdMapping>
      <applicationLidMapping>
        <ApplicationLidMapping>
          <fromApplicationLId>string</fromApplicationLId>
          <toApplicationLId>string</toApplicationLId>
        </ApplicationLidMapping>
        <ApplicationLidMapping>
          <fromApplicationLId>string</fromApplicationLId>
          <toApplicationLId>string</toApplicationLId>
        </ApplicationLidMapping>
      </applicationLidMapping>
    </copyWorkflow>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <copyWorkflowResponse xmlns="http://www.birst.com/">
      <copyWorkflowResult>string</copyWorkflowResult>
    </copyWorkflowResponse>
  </soap12:Body>
</soap12:Envelope>

createDashboardCollection

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/createDashboardCollection"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <createDashboardCollection xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <collectionType>string</collectionType>
      <collectionName>string</collectionName>
    </createDashboardCollection>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <createDashboardCollectionResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <createDashboardCollection xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <collectionType>string</collectionType>
      <collectionName>string</collectionName>
    </createDashboardCollection>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <createDashboardCollectionResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

createExpression

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/createExpression"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <createExpression xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <expression>
        <Name>string</Name>
        <ColumnType>string</ColumnType>
        <Format>string</Format>
        <Expression>string</Expression>
      </expression>
    </createExpression>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <createExpressionResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <createExpression xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <expression>
        <Name>string</Name>
        <ColumnType>string</ColumnType>
        <Format>string</Format>
        <Expression>string</Expression>
      </expression>
    </createExpression>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <createExpressionResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

createHierarchy

Creates a new hierarchy in the space specified

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/createHierarchy"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <createHierarchy xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <hmd>
        <Name>string</Name>
        <Children>
          <LevelMetadata>
            <Name>string</Name>
            <Cardinality>string</Cardinality>
            <ColumnNames xsi:nil="true" />
            <Children xsi:nil="true" />
          </LevelMetadata>
          <LevelMetadata>
            <Name>string</Name>
            <Cardinality>string</Cardinality>
            <ColumnNames xsi:nil="true" />
            <Children xsi:nil="true" />
          </LevelMetadata>
        </Children>
      </hmd>
    </createHierarchy>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <createHierarchyResponse xmlns="http://www.birst.com/">
      <createHierarchyResult>boolean</createHierarchyResult>
    </createHierarchyResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <createHierarchy xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <hmd>
        <Name>string</Name>
        <Children>
          <LevelMetadata>
            <Name>string</Name>
            <Cardinality>string</Cardinality>
            <ColumnNames xsi:nil="true" />
            <Children xsi:nil="true" />
          </LevelMetadata>
          <LevelMetadata>
            <Name>string</Name>
            <Cardinality>string</Cardinality>
            <ColumnNames xsi:nil="true" />
            <Children xsi:nil="true" />
          </LevelMetadata>
        </Children>
      </hmd>
    </createHierarchy>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <createHierarchyResponse xmlns="http://www.birst.com/">
      <createHierarchyResult>boolean</createHierarchyResult>
    </createHierarchyResponse>
  </soap12:Body>
</soap12:Envelope>

createNewDirectory

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/createNewDirectory"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <createNewDirectory xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <parentDir>string</parentDir>
      <newDirectoryName>string</newDirectoryName>
    </createNewDirectory>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <createNewDirectoryResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <createNewDirectory xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <parentDir>string</parentDir>
      <newDirectoryName>string</newDirectoryName>
    </createNewDirectory>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <createNewDirectoryResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

createNewSpace

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/createNewSpace"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <createNewSpace xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceName>string</spaceName>
      <comments>string</comments>
      <automatic>boolean</automatic>
    </createNewSpace>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <createNewSpaceResponse xmlns="http://www.birst.com/">
      <createNewSpaceResult>string</createNewSpaceResult>
    </createNewSpaceResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <createNewSpace xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceName>string</spaceName>
      <comments>string</comments>
      <automatic>boolean</automatic>
    </createNewSpace>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <createNewSpaceResponse xmlns="http://www.birst.com/">
      <createNewSpaceResult>string</createNewSpaceResult>
    </createNewSpaceResponse>
  </soap12:Body>
</soap12:Envelope>

createNewSpaceUsingSchema

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/createNewSpaceUsingSchema"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <createNewSpaceUsingSchema xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceName>string</spaceName>
      <schemaName>string</schemaName>
      <comments>string</comments>
      <automatic>boolean</automatic>
    </createNewSpaceUsingSchema>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <createNewSpaceUsingSchemaResponse xmlns="http://www.birst.com/">
      <createNewSpaceUsingSchemaResult>string</createNewSpaceUsingSchemaResult>
    </createNewSpaceUsingSchemaResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <createNewSpaceUsingSchema xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceName>string</spaceName>
      <schemaName>string</schemaName>
      <comments>string</comments>
      <automatic>boolean</automatic>
    </createNewSpaceUsingSchema>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <createNewSpaceUsingSchemaResponse xmlns="http://www.birst.com/">
      <createNewSpaceUsingSchemaResult>string</createNewSpaceUsingSchemaResult>
    </createNewSpaceUsingSchemaResponse>
  </soap12:Body>
</soap12:Envelope>

createProfile

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/createProfile"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <createProfile xmlns="http://www.birst.com/">
      <token>string</token>
      <name>string</name>
      <description>string</description>
    </createProfile>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <createProfileResponse xmlns="http://www.birst.com/">
      <createProfileResult>
        <id>string</id>
        <name>string</name>
        <description>string</description>
        <isDefault>string</isDefault>
        <properties>
          <ProfileProperty>
            <name>string</name>
            <value>string</value>
            <locale>string</locale>
          </ProfileProperty>
          <ProfileProperty>
            <name>string</name>
            <value>string</value>
            <locale>string</locale>
          </ProfileProperty>
        </properties>
      </createProfileResult>
    </createProfileResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <createProfile xmlns="http://www.birst.com/">
      <token>string</token>
      <name>string</name>
      <description>string</description>
    </createProfile>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <createProfileResponse xmlns="http://www.birst.com/">
      <createProfileResult>
        <id>string</id>
        <name>string</name>
        <description>string</description>
        <isDefault>string</isDefault>
        <properties>
          <ProfileProperty>
            <name>string</name>
            <value>string</value>
            <locale>string</locale>
          </ProfileProperty>
          <ProfileProperty>
            <name>string</name>
            <value>string</value>
            <locale>string</locale>
          </ProfileProperty>
        </properties>
      </createProfileResult>
    </createProfileResponse>
  </soap12:Body>
</soap12:Envelope>

createSubjectArea

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/createSubjectArea"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <createSubjectArea xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <name>string</name>
      <description>string</description>
      <groups>
        <string>string</string>
        <string>string</string>
      </groups>
    </createSubjectArea>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <createSubjectAreaResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <createSubjectArea xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <name>string</name>
      <description>string</description>
      <groups>
        <string>string</string>
        <string>string</string>
      </groups>
    </createSubjectArea>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <createSubjectAreaResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

deleteAllDataFromSpace

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/deleteAllDataFromSpace"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <deleteAllDataFromSpace xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
    </deleteAllDataFromSpace>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <deleteAllDataFromSpaceResponse xmlns="http://www.birst.com/">
      <deleteAllDataFromSpaceResult>string</deleteAllDataFromSpaceResult>
    </deleteAllDataFromSpaceResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <deleteAllDataFromSpace xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
    </deleteAllDataFromSpace>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <deleteAllDataFromSpaceResponse xmlns="http://www.birst.com/">
      <deleteAllDataFromSpaceResult>string</deleteAllDataFromSpaceResult>
    </deleteAllDataFromSpaceResponse>
  </soap12:Body>
</soap12:Envelope>

deleteBirstConnectAgent

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/deleteBirstConnectAgent"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <deleteBirstConnectAgent xmlns="http://www.birst.com/">
      <token>string</token>
      <agentId>string</agentId>
    </deleteBirstConnectAgent>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <deleteBirstConnectAgentResponse xmlns="http://www.birst.com/">
      <deleteBirstConnectAgentResult>boolean</deleteBirstConnectAgentResult>
    </deleteBirstConnectAgentResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <deleteBirstConnectAgent xmlns="http://www.birst.com/">
      <token>string</token>
      <agentId>string</agentId>
    </deleteBirstConnectAgent>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <deleteBirstConnectAgentResponse xmlns="http://www.birst.com/">
      <deleteBirstConnectAgentResult>boolean</deleteBirstConnectAgentResult>
    </deleteBirstConnectAgentResponse>
  </soap12:Body>
</soap12:Envelope>

deleteCloudConnection

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/deleteCloudConnection"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <deleteCloudConnection xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <accountID>string</accountID>
      <connectionId>string</connectionId>
    </deleteCloudConnection>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <deleteCloudConnectionResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <deleteCloudConnection xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <accountID>string</accountID>
      <connectionId>string</connectionId>
    </deleteCloudConnection>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <deleteCloudConnectionResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

deleteExpression

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/deleteExpression"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <deleteExpression xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <expressionName>string</expressionName>
    </deleteExpression>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <deleteExpressionResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <deleteExpression xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <expressionName>string</expressionName>
    </deleteExpression>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <deleteExpressionResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

deleteFileOrDirectory

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/deleteFileOrDirectory"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <deleteFileOrDirectory xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <fileOrDir>string</fileOrDir>
    </deleteFileOrDirectory>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <deleteFileOrDirectoryResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <deleteFileOrDirectory xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <fileOrDir>string</fileOrDir>
    </deleteFileOrDirectory>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <deleteFileOrDirectoryResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

deleteHierarchy

Deletes a hierarchy from the space specified

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/deleteHierarchy"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <deleteHierarchy xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <hierarchyName>string</hierarchyName>
    </deleteHierarchy>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <deleteHierarchyResponse xmlns="http://www.birst.com/">
      <deleteHierarchyResult>boolean</deleteHierarchyResult>
    </deleteHierarchyResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <deleteHierarchy xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <hierarchyName>string</hierarchyName>
    </deleteHierarchy>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <deleteHierarchyResponse xmlns="http://www.birst.com/">
      <deleteHierarchyResult>boolean</deleteHierarchyResult>
    </deleteHierarchyResponse>
  </soap12:Body>
</soap12:Envelope>

deleteLastDataFromSpace

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/deleteLastDataFromSpace"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <deleteLastDataFromSpace xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
    </deleteLastDataFromSpace>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <deleteLastDataFromSpaceResponse xmlns="http://www.birst.com/">
      <deleteLastDataFromSpaceResult>string</deleteLastDataFromSpaceResult>
    </deleteLastDataFromSpaceResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <deleteLastDataFromSpace xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
    </deleteLastDataFromSpace>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <deleteLastDataFromSpaceResponse xmlns="http://www.birst.com/">
      <deleteLastDataFromSpaceResult>string</deleteLastDataFromSpaceResult>
    </deleteLastDataFromSpaceResponse>
  </soap12:Body>
</soap12:Envelope>

deleteLocaleValueInProfileProperty

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/deleteLocaleValueInProfileProperty"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <deleteLocaleValueInProfileProperty xmlns="http://www.birst.com/">
      <token>string</token>
      <profileID>string</profileID>
      <propertyName>string</propertyName>
      <locale>string</locale>
    </deleteLocaleValueInProfileProperty>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <deleteLocaleValueInProfilePropertyResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <deleteLocaleValueInProfileProperty xmlns="http://www.birst.com/">
      <token>string</token>
      <profileID>string</profileID>
      <propertyName>string</propertyName>
      <locale>string</locale>
    </deleteLocaleValueInProfileProperty>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <deleteLocaleValueInProfilePropertyResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

deleteProfile

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/deleteProfile"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <deleteProfile xmlns="http://www.birst.com/">
      <token>string</token>
      <profileID>string</profileID>
    </deleteProfile>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <deleteProfileResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <deleteProfile xmlns="http://www.birst.com/">
      <token>string</token>
      <profileID>string</profileID>
    </deleteProfile>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <deleteProfileResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

deleteSpace

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/deleteSpace"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <deleteSpace xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceId>string</spaceId>
    </deleteSpace>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <deleteSpaceResponse xmlns="http://www.birst.com/">
      <deleteSpaceResult>string</deleteSpaceResult>
    </deleteSpaceResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <deleteSpace xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceId>string</spaceId>
    </deleteSpace>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <deleteSpaceResponse xmlns="http://www.birst.com/">
      <deleteSpaceResult>string</deleteSpaceResult>
    </deleteSpaceResponse>
  </soap12:Body>
</soap12:Envelope>

deleteSubjectArea

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/deleteSubjectArea"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <deleteSubjectArea xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <name>string</name>
    </deleteSubjectArea>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <deleteSubjectAreaResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <deleteSubjectArea xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <name>string</name>
    </deleteSubjectArea>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <deleteSubjectAreaResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

deleteUser

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/deleteUser"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <deleteUser xmlns="http://www.birst.com/">
      <token>string</token>
      <userName>string</userName>
    </deleteUser>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <deleteUserResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <deleteUser xmlns="http://www.birst.com/">
      <token>string</token>
      <userName>string</userName>
    </deleteUser>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <deleteUserResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

enableAccount

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/enableAccount"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <enableAccount xmlns="http://www.birst.com/">
      <token>string</token>
      <accountID>string</accountID>
      <enable>boolean</enable>
    </enableAccount>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <enableAccountResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <enableAccount xmlns="http://www.birst.com/">
      <token>string</token>
      <accountID>string</accountID>
      <enable>boolean</enable>
    </enableAccount>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <enableAccountResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

enableSourceInSpace

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/enableSourceInSpace"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <enableSourceInSpace xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <dataSourceName>string</dataSourceName>
      <enabled>boolean</enabled>
    </enableSourceInSpace>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <enableSourceInSpaceResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <enableSourceInSpace xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <dataSourceName>string</dataSourceName>
      <enabled>boolean</enabled>
    </enableSourceInSpace>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <enableSourceInSpaceResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

enableUser

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/enableUser"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <enableUser xmlns="http://www.birst.com/">
      <token>string</token>
      <userName>string</userName>
      <enable>boolean</enable>
    </enableUser>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <enableUserResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <enableUser xmlns="http://www.birst.com/">
      <token>string</token>
      <userName>string</userName>
      <enable>boolean</enable>
    </enableUser>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <enableUserResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

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.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/executeQueryInSpace"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <executeQueryInSpace xmlns="http://www.birst.com/">
      <token>string</token>
      <query>string</query>
      <spaceID>string</spaceID>
    </executeQueryInSpace>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <executeQueryInSpaceResponse xmlns="http://www.birst.com/">
      <executeQueryInSpaceResult>
        <queryToken>string</queryToken>
        <numRowsReturned>int</numRowsReturned>
        <hasMoreRows>boolean</hasMoreRows>
      </executeQueryInSpaceResult>
    </executeQueryInSpaceResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <executeQueryInSpace xmlns="http://www.birst.com/">
      <token>string</token>
      <query>string</query>
      <spaceID>string</spaceID>
    </executeQueryInSpace>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <executeQueryInSpaceResponse xmlns="http://www.birst.com/">
      <executeQueryInSpaceResult>
        <queryToken>string</queryToken>
        <numRowsReturned>int</numRowsReturned>
        <hasMoreRows>boolean</hasMoreRows>
      </executeQueryInSpaceResult>
    </executeQueryInSpaceResponse>
  </soap12:Body>
</soap12:Envelope>

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.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/executeQueryInSpaceWithOptions"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <executeQueryInSpaceWithOptions xmlns="http://www.birst.com/">
      <token>string</token>
      <query>string</query>
      <spaceID>string</spaceID>
      <queryOptions>
        <QueryOptionOfStringString>
          <Key>string</Key>
          <Value>string</Value>
        </QueryOptionOfStringString>
        <QueryOptionOfStringString>
          <Key>string</Key>
          <Value>string</Value>
        </QueryOptionOfStringString>
      </queryOptions>
    </executeQueryInSpaceWithOptions>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <executeQueryInSpaceWithOptionsResponse xmlns="http://www.birst.com/">
      <executeQueryInSpaceWithOptionsResult>
        <queryToken>string</queryToken>
        <numRowsReturned>int</numRowsReturned>
        <hasMoreRows>boolean</hasMoreRows>
      </executeQueryInSpaceWithOptionsResult>
    </executeQueryInSpaceWithOptionsResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <executeQueryInSpaceWithOptions xmlns="http://www.birst.com/">
      <token>string</token>
      <query>string</query>
      <spaceID>string</spaceID>
      <queryOptions>
        <QueryOptionOfStringString>
          <Key>string</Key>
          <Value>string</Value>
        </QueryOptionOfStringString>
        <QueryOptionOfStringString>
          <Key>string</Key>
          <Value>string</Value>
        </QueryOptionOfStringString>
      </queryOptions>
    </executeQueryInSpaceWithOptions>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <executeQueryInSpaceWithOptionsResponse xmlns="http://www.birst.com/">
      <executeQueryInSpaceWithOptionsResult>
        <queryToken>string</queryToken>
        <numRowsReturned>int</numRowsReturned>
        <hasMoreRows>boolean</hasMoreRows>
      </executeQueryInSpaceWithOptionsResult>
    </executeQueryInSpaceWithOptionsResponse>
  </soap12:Body>
</soap12:Envelope>

executeScheduledReport

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/executeScheduledReport"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <executeScheduledReport xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceId>string</spaceId>
      <reportScheduleName>string</reportScheduleName>
    </executeScheduledReport>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <executeScheduledReportResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <executeScheduledReport xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceId>string</spaceId>
      <reportScheduleName>string</reportScheduleName>
    </executeScheduledReport>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <executeScheduledReportResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

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.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/executeWorkflow"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <executeWorkflow xmlns="http://www.birst.com/">
      <token>string</token>
      <workflowName>string</workflowName>
    </executeWorkflow>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <executeWorkflowResponse xmlns="http://www.birst.com/">
      <executeWorkflowResult>string</executeWorkflowResult>
    </executeWorkflowResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <executeWorkflow xmlns="http://www.birst.com/">
      <token>string</token>
      <workflowName>string</workflowName>
    </executeWorkflow>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <executeWorkflowResponse xmlns="http://www.birst.com/">
      <executeWorkflowResult>string</executeWorkflowResult>
    </executeWorkflowResponse>
  </soap12:Body>
</soap12:Envelope>

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.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/exportReportToCSV"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <exportReportToCSV xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceId>string</spaceId>
      <reportPath>string</reportPath>
      <reportFilters>
        <Filter>
          <Operator>string</Operator>
          <multiSelectType>string</multiSelectType>
          <FilterType>string</FilterType>
          <ParameterName>string</ParameterName>
          <selectedValues>
            <selectedValue>string</selectedValue>
            <selectedValue>string</selectedValue>
          </selectedValues>
        </Filter>
        <Filter>
          <Operator>string</Operator>
          <multiSelectType>string</multiSelectType>
          <FilterType>string</FilterType>
          <ParameterName>string</ParameterName>
          <selectedValues>
            <selectedValue>string</selectedValue>
            <selectedValue>string</selectedValue>
          </selectedValues>
        </Filter>
      </reportFilters>
    </exportReportToCSV>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <exportReportToCSVResponse xmlns="http://www.birst.com/">
      <exportReportToCSVResult>string</exportReportToCSVResult>
    </exportReportToCSVResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <exportReportToCSV xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceId>string</spaceId>
      <reportPath>string</reportPath>
      <reportFilters>
        <Filter>
          <Operator>string</Operator>
          <multiSelectType>string</multiSelectType>
          <FilterType>string</FilterType>
          <ParameterName>string</ParameterName>
          <selectedValues>
            <selectedValue>string</selectedValue>
            <selectedValue>string</selectedValue>
          </selectedValues>
        </Filter>
        <Filter>
          <Operator>string</Operator>
          <multiSelectType>string</multiSelectType>
          <FilterType>string</FilterType>
          <ParameterName>string</ParameterName>
          <selectedValues>
            <selectedValue>string</selectedValue>
            <selectedValue>string</selectedValue>
          </selectedValues>
        </Filter>
      </reportFilters>
    </exportReportToCSV>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <exportReportToCSVResponse xmlns="http://www.birst.com/">
      <exportReportToCSVResult>string</exportReportToCSVResult>
    </exportReportToCSVResponse>
  </soap12:Body>
</soap12:Envelope>

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.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/exportReportToPDF"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <exportReportToPDF xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceId>string</spaceId>
      <reportPath>string</reportPath>
      <reportFilters>
        <Filter>
          <Operator>string</Operator>
          <multiSelectType>string</multiSelectType>
          <FilterType>string</FilterType>
          <ParameterName>string</ParameterName>
          <selectedValues>
            <selectedValue>string</selectedValue>
            <selectedValue>string</selectedValue>
          </selectedValues>
        </Filter>
        <Filter>
          <Operator>string</Operator>
          <multiSelectType>string</multiSelectType>
          <FilterType>string</FilterType>
          <ParameterName>string</ParameterName>
          <selectedValues>
            <selectedValue>string</selectedValue>
            <selectedValue>string</selectedValue>
          </selectedValues>
        </Filter>
      </reportFilters>
    </exportReportToPDF>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <exportReportToPDFResponse xmlns="http://www.birst.com/">
      <exportReportToPDFResult>string</exportReportToPDFResult>
    </exportReportToPDFResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <exportReportToPDF xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceId>string</spaceId>
      <reportPath>string</reportPath>
      <reportFilters>
        <Filter>
          <Operator>string</Operator>
          <multiSelectType>string</multiSelectType>
          <FilterType>string</FilterType>
          <ParameterName>string</ParameterName>
          <selectedValues>
            <selectedValue>string</selectedValue>
            <selectedValue>string</selectedValue>
          </selectedValues>
        </Filter>
        <Filter>
          <Operator>string</Operator>
          <multiSelectType>string</multiSelectType>
          <FilterType>string</FilterType>
          <ParameterName>string</ParameterName>
          <selectedValues>
            <selectedValue>string</selectedValue>
            <selectedValue>string</selectedValue>
          </selectedValues>
        </Filter>
      </reportFilters>
    </exportReportToPDF>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <exportReportToPDFResponse xmlns="http://www.birst.com/">
      <exportReportToPDFResult>string</exportReportToPDFResult>
    </exportReportToPDFResponse>
  </soap12:Body>
</soap12:Envelope>

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.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/exportReportToPNG"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <exportReportToPNG xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceId>string</spaceId>
      <reportPath>string</reportPath>
      <reportFilters>
        <Filter>
          <Operator>string</Operator>
          <multiSelectType>string</multiSelectType>
          <FilterType>string</FilterType>
          <ParameterName>string</ParameterName>
          <selectedValues>
            <selectedValue>string</selectedValue>
            <selectedValue>string</selectedValue>
          </selectedValues>
        </Filter>
        <Filter>
          <Operator>string</Operator>
          <multiSelectType>string</multiSelectType>
          <FilterType>string</FilterType>
          <ParameterName>string</ParameterName>
          <selectedValues>
            <selectedValue>string</selectedValue>
            <selectedValue>string</selectedValue>
          </selectedValues>
        </Filter>
      </reportFilters>
      <zoomFactor>int</zoomFactor>
      <page>int</page>
    </exportReportToPNG>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <exportReportToPNGResponse xmlns="http://www.birst.com/">
      <exportReportToPNGResult>string</exportReportToPNGResult>
    </exportReportToPNGResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <exportReportToPNG xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceId>string</spaceId>
      <reportPath>string</reportPath>
      <reportFilters>
        <Filter>
          <Operator>string</Operator>
          <multiSelectType>string</multiSelectType>
          <FilterType>string</FilterType>
          <ParameterName>string</ParameterName>
          <selectedValues>
            <selectedValue>string</selectedValue>
            <selectedValue>string</selectedValue>
          </selectedValues>
        </Filter>
        <Filter>
          <Operator>string</Operator>
          <multiSelectType>string</multiSelectType>
          <FilterType>string</FilterType>
          <ParameterName>string</ParameterName>
          <selectedValues>
            <selectedValue>string</selectedValue>
            <selectedValue>string</selectedValue>
          </selectedValues>
        </Filter>
      </reportFilters>
      <zoomFactor>int</zoomFactor>
      <page>int</page>
    </exportReportToPNG>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <exportReportToPNGResponse xmlns="http://www.birst.com/">
      <exportReportToPNGResult>string</exportReportToPNGResult>
    </exportReportToPNGResponse>
  </soap12:Body>
</soap12:Envelope>

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.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/exportReportToPPT"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <exportReportToPPT xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceId>string</spaceId>
      <reportPath>string</reportPath>
      <reportFilters>
        <Filter>
          <Operator>string</Operator>
          <multiSelectType>string</multiSelectType>
          <FilterType>string</FilterType>
          <ParameterName>string</ParameterName>
          <selectedValues>
            <selectedValue>string</selectedValue>
            <selectedValue>string</selectedValue>
          </selectedValues>
        </Filter>
        <Filter>
          <Operator>string</Operator>
          <multiSelectType>string</multiSelectType>
          <FilterType>string</FilterType>
          <ParameterName>string</ParameterName>
          <selectedValues>
            <selectedValue>string</selectedValue>
            <selectedValue>string</selectedValue>
          </selectedValues>
        </Filter>
      </reportFilters>
      <sessionVariables>
        <KeyValue>
          <key>string</key>
          <value>string</value>
        </KeyValue>
        <KeyValue>
          <key>string</key>
          <value>string</value>
        </KeyValue>
      </sessionVariables>
    </exportReportToPPT>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <exportReportToPPTResponse xmlns="http://www.birst.com/">
      <exportReportToPPTResult>string</exportReportToPPTResult>
    </exportReportToPPTResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <exportReportToPPT xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceId>string</spaceId>
      <reportPath>string</reportPath>
      <reportFilters>
        <Filter>
          <Operator>string</Operator>
          <multiSelectType>string</multiSelectType>
          <FilterType>string</FilterType>
          <ParameterName>string</ParameterName>
          <selectedValues>
            <selectedValue>string</selectedValue>
            <selectedValue>string</selectedValue>
          </selectedValues>
        </Filter>
        <Filter>
          <Operator>string</Operator>
          <multiSelectType>string</multiSelectType>
          <FilterType>string</FilterType>
          <ParameterName>string</ParameterName>
          <selectedValues>
            <selectedValue>string</selectedValue>
            <selectedValue>string</selectedValue>
          </selectedValues>
        </Filter>
      </reportFilters>
      <sessionVariables>
        <KeyValue>
          <key>string</key>
          <value>string</value>
        </KeyValue>
        <KeyValue>
          <key>string</key>
          <value>string</value>
        </KeyValue>
      </sessionVariables>
    </exportReportToPPT>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <exportReportToPPTResponse xmlns="http://www.birst.com/">
      <exportReportToPPTResult>string</exportReportToPPTResult>
    </exportReportToPPTResponse>
  </soap12:Body>
</soap12:Envelope>

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.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/exportReportToRTF"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <exportReportToRTF xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceId>string</spaceId>
      <reportPath>string</reportPath>
      <reportFilters>
        <Filter>
          <Operator>string</Operator>
          <multiSelectType>string</multiSelectType>
          <FilterType>string</FilterType>
          <ParameterName>string</ParameterName>
          <selectedValues>
            <selectedValue>string</selectedValue>
            <selectedValue>string</selectedValue>
          </selectedValues>
        </Filter>
        <Filter>
          <Operator>string</Operator>
          <multiSelectType>string</multiSelectType>
          <FilterType>string</FilterType>
          <ParameterName>string</ParameterName>
          <selectedValues>
            <selectedValue>string</selectedValue>
            <selectedValue>string</selectedValue>
          </selectedValues>
        </Filter>
      </reportFilters>
    </exportReportToRTF>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <exportReportToRTFResponse xmlns="http://www.birst.com/">
      <exportReportToRTFResult>string</exportReportToRTFResult>
    </exportReportToRTFResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <exportReportToRTF xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceId>string</spaceId>
      <reportPath>string</reportPath>
      <reportFilters>
        <Filter>
          <Operator>string</Operator>
          <multiSelectType>string</multiSelectType>
          <FilterType>string</FilterType>
          <ParameterName>string</ParameterName>
          <selectedValues>
            <selectedValue>string</selectedValue>
            <selectedValue>string</selectedValue>
          </selectedValues>
        </Filter>
        <Filter>
          <Operator>string</Operator>
          <multiSelectType>string</multiSelectType>
          <FilterType>string</FilterType>
          <ParameterName>string</ParameterName>
          <selectedValues>
            <selectedValue>string</selectedValue>
            <selectedValue>string</selectedValue>
          </selectedValues>
        </Filter>
      </reportFilters>
    </exportReportToRTF>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <exportReportToRTFResponse xmlns="http://www.birst.com/">
      <exportReportToRTFResult>string</exportReportToRTFResult>
    </exportReportToRTFResponse>
  </soap12:Body>
</soap12:Envelope>

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.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/exportReportToXLS"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <exportReportToXLS xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceId>string</spaceId>
      <reportPath>string</reportPath>
      <reportFilters>
        <Filter>
          <Operator>string</Operator>
          <multiSelectType>string</multiSelectType>
          <FilterType>string</FilterType>
          <ParameterName>string</ParameterName>
          <selectedValues>
            <selectedValue>string</selectedValue>
            <selectedValue>string</selectedValue>
          </selectedValues>
        </Filter>
        <Filter>
          <Operator>string</Operator>
          <multiSelectType>string</multiSelectType>
          <FilterType>string</FilterType>
          <ParameterName>string</ParameterName>
          <selectedValues>
            <selectedValue>string</selectedValue>
            <selectedValue>string</selectedValue>
          </selectedValues>
        </Filter>
      </reportFilters>
    </exportReportToXLS>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <exportReportToXLSResponse xmlns="http://www.birst.com/">
      <exportReportToXLSResult>string</exportReportToXLSResult>
    </exportReportToXLSResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <exportReportToXLS xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceId>string</spaceId>
      <reportPath>string</reportPath>
      <reportFilters>
        <Filter>
          <Operator>string</Operator>
          <multiSelectType>string</multiSelectType>
          <FilterType>string</FilterType>
          <ParameterName>string</ParameterName>
          <selectedValues>
            <selectedValue>string</selectedValue>
            <selectedValue>string</selectedValue>
          </selectedValues>
        </Filter>
        <Filter>
          <Operator>string</Operator>
          <multiSelectType>string</multiSelectType>
          <FilterType>string</FilterType>
          <ParameterName>string</ParameterName>
          <selectedValues>
            <selectedValue>string</selectedValue>
            <selectedValue>string</selectedValue>
          </selectedValues>
        </Filter>
      </reportFilters>
    </exportReportToXLS>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <exportReportToXLSResponse xmlns="http://www.birst.com/">
      <exportReportToXLSResult>string</exportReportToXLSResult>
    </exportReportToXLSResponse>
  </soap12:Body>
</soap12:Envelope>

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.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/extractCloudConnectorData"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <extractCloudConnectorData xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <cloudConnections>
        <CloudConnection>
          <ConnectionName>string</ConnectionName>
          <ExtractionGroups>
            <string>string</string>
            <string>string</string>
          </ExtractionGroups>
        </CloudConnection>
        <CloudConnection>
          <ConnectionName>string</ConnectionName>
          <ExtractionGroups>
            <string>string</string>
            <string>string</string>
          </ExtractionGroups>
        </CloudConnection>
      </cloudConnections>
    </extractCloudConnectorData>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <extractCloudConnectorDataResponse xmlns="http://www.birst.com/">
      <extractCloudConnectorDataResult>string</extractCloudConnectorDataResult>
    </extractCloudConnectorDataResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <extractCloudConnectorData xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <cloudConnections>
        <CloudConnection>
          <ConnectionName>string</ConnectionName>
          <ExtractionGroups>
            <string>string</string>
            <string>string</string>
          </ExtractionGroups>
        </CloudConnection>
        <CloudConnection>
          <ConnectionName>string</ConnectionName>
          <ExtractionGroups>
            <string>string</string>
            <string>string</string>
          </ExtractionGroups>
        </CloudConnection>
      </cloudConnections>
    </extractCloudConnectorData>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <extractCloudConnectorDataResponse xmlns="http://www.birst.com/">
      <extractCloudConnectorDataResult>string</extractCloudConnectorDataResult>
    </extractCloudConnectorDataResponse>
  </soap12:Body>
</soap12:Envelope>

extractConnectorData

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/extractConnectorData"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <extractConnectorData xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <connectorName>string</connectorName>
      <extractGroups>
        <string>string</string>
        <string>string</string>
      </extractGroups>
    </extractConnectorData>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <extractConnectorDataResponse xmlns="http://www.birst.com/">
      <extractConnectorDataResult>string</extractConnectorDataResult>
    </extractConnectorDataResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <extractConnectorData xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <connectorName>string</connectorName>
      <extractGroups>
        <string>string</string>
        <string>string</string>
      </extractGroups>
    </extractConnectorData>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <extractConnectorDataResponse xmlns="http://www.birst.com/">
      <extractConnectorDataResult>string</extractConnectorDataResult>
    </extractConnectorDataResponse>
  </soap12:Body>
</soap12:Envelope>

extractSalesforceData

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/extractSalesforceData"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <extractSalesforceData xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
    </extractSalesforceData>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <extractSalesforceDataResponse xmlns="http://www.birst.com/">
      <extractSalesforceDataResult>string</extractSalesforceDataResult>
    </extractSalesforceDataResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <extractSalesforceData xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
    </extractSalesforceData>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <extractSalesforceDataResponse xmlns="http://www.birst.com/">
      <extractSalesforceDataResult>string</extractSalesforceDataResult>
    </extractSalesforceDataResponse>
  </soap12:Body>
</soap12:Envelope>

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.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/finishDataUpload"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <finishDataUpload xmlns="http://www.birst.com/">
      <token>string</token>
      <dataUploadToken>string</dataUploadToken>
    </finishDataUpload>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <finishDataUploadResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <finishDataUpload xmlns="http://www.birst.com/">
      <token>string</token>
      <dataUploadToken>string</dataUploadToken>
    </finishDataUpload>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <finishDataUploadResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

generateBirstConnectToken

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/generateBirstConnectToken"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <generateBirstConnectToken xmlns="http://www.birst.com/">
      <token>string</token>
    </generateBirstConnectToken>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <generateBirstConnectTokenResponse xmlns="http://www.birst.com/">
      <generateBirstConnectTokenResult>string</generateBirstConnectTokenResult>
    </generateBirstConnectTokenResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <generateBirstConnectToken xmlns="http://www.birst.com/">
      <token>string</token>
    </generateBirstConnectToken>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <generateBirstConnectTokenResponse xmlns="http://www.birst.com/">
      <generateBirstConnectTokenResult>string</generateBirstConnectTokenResult>
    </generateBirstConnectTokenResponse>
  </soap12:Body>
</soap12:Envelope>

getAgentHealth

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/getAgentHealth"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getAgentHealth xmlns="http://www.birst.com/">
      <token>string</token>
      <agentIds>
        <string>string</string>
        <string>string</string>
      </agentIds>
    </getAgentHealth>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getAgentHealthResponse xmlns="http://www.birst.com/">
      <getAgentHealthResult>
        <AgentStatus>
          <agentId>string</agentId>
          <status>string</status>
          <userId>string</userId>
          <activityStatus>string</activityStatus>
        </AgentStatus>
        <AgentStatus>
          <agentId>string</agentId>
          <status>string</status>
          <userId>string</userId>
          <activityStatus>string</activityStatus>
        </AgentStatus>
      </getAgentHealthResult>
    </getAgentHealthResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getAgentHealth xmlns="http://www.birst.com/">
      <token>string</token>
      <agentIds>
        <string>string</string>
        <string>string</string>
      </agentIds>
    </getAgentHealth>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getAgentHealthResponse xmlns="http://www.birst.com/">
      <getAgentHealthResult>
        <AgentStatus>
          <agentId>string</agentId>
          <status>string</status>
          <userId>string</userId>
          <activityStatus>string</activityStatus>
        </AgentStatus>
        <AgentStatus>
          <agentId>string</agentId>
          <status>string</status>
          <userId>string</userId>
          <activityStatus>string</activityStatus>
        </AgentStatus>
      </getAgentHealthResult>
    </getAgentHealthResponse>
  </soap12:Body>
</soap12:Envelope>

getAllHierarchies

Gets list of hierarchies in the space

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/getAllHierarchies"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getAllHierarchies xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
    </getAllHierarchies>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getAllHierarchiesResponse xmlns="http://www.birst.com/">
      <getAllHierarchiesResult>
        <string>string</string>
        <string>string</string>
      </getAllHierarchiesResult>
    </getAllHierarchiesResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getAllHierarchies xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
    </getAllHierarchies>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getAllHierarchiesResponse xmlns="http://www.birst.com/">
      <getAllHierarchiesResult>
        <string>string</string>
        <string>string</string>
      </getAllHierarchiesResult>
    </getAllHierarchiesResponse>
  </soap12:Body>
</soap12:Envelope>

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.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/getAvailableACLs"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getAvailableACLs xmlns="http://www.birst.com/">
      <token>string</token>
    </getAvailableACLs>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getAvailableACLsResponse xmlns="http://www.birst.com/">
      <getAvailableACLsResult>
        <string>string</string>
        <string>string</string>
      </getAvailableACLsResult>
    </getAvailableACLsResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getAvailableACLs xmlns="http://www.birst.com/">
      <token>string</token>
    </getAvailableACLs>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getAvailableACLsResponse xmlns="http://www.birst.com/">
      <getAvailableACLsResult>
        <string>string</string>
        <string>string</string>
      </getAvailableACLsResult>
    </getAvailableACLsResponse>
  </soap12:Body>
</soap12:Envelope>

getDashboardView

Gets the dashboard view that is set for the user

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/getDashboardView"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getDashboardView xmlns="http://www.birst.com/">
      <token>string</token>
      <userName>string</userName>
    </getDashboardView>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getDashboardViewResponse xmlns="http://www.birst.com/">xml</getDashboardViewResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getDashboardView xmlns="http://www.birst.com/">
      <token>string</token>
      <userName>string</userName>
    </getDashboardView>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getDashboardViewResponse xmlns="http://www.birst.com/">xml</getDashboardViewResponse>
  </soap12:Body>
</soap12:Envelope>

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.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/getDataCharacteristics"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getDataCharacteristics xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <sourceName>string</sourceName>
    </getDataCharacteristics>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getDataCharacteristicsResponse xmlns="http://www.birst.com/">
      <getDataCharacteristicsResult>
        <OnlyQuoteAfterSeparator>string</OnlyQuoteAfterSeparator>
        <DoNotTreatCarriageReturnAsNewline>string</DoNotTreatCarriageReturnAsNewline>
        <HasHeaders>string</HasHeaders>
        <ForceNumColumns>string</ForceNumColumns>
        <Separator>string</Separator>
        <IgnoredRows>string</IgnoredRows>
        <IgnoredLastRows>string</IgnoredLastRows>
        <Quote>string</Quote>
        <Encoding>string</Encoding>
      </getDataCharacteristicsResult>
    </getDataCharacteristicsResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getDataCharacteristics xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <sourceName>string</sourceName>
    </getDataCharacteristics>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getDataCharacteristicsResponse xmlns="http://www.birst.com/">
      <getDataCharacteristicsResult>
        <OnlyQuoteAfterSeparator>string</OnlyQuoteAfterSeparator>
        <DoNotTreatCarriageReturnAsNewline>string</DoNotTreatCarriageReturnAsNewline>
        <HasHeaders>string</HasHeaders>
        <ForceNumColumns>string</ForceNumColumns>
        <Separator>string</Separator>
        <IgnoredRows>string</IgnoredRows>
        <IgnoredLastRows>string</IgnoredLastRows>
        <Quote>string</Quote>
        <Encoding>string</Encoding>
      </getDataCharacteristicsResult>
    </getDataCharacteristicsResponse>
  </soap12:Body>
</soap12:Envelope>

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.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/getDataUploadStatus"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getDataUploadStatus xmlns="http://www.birst.com/">
      <token>string</token>
      <dataUploadToken>string</dataUploadToken>
    </getDataUploadStatus>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getDataUploadStatusResponse xmlns="http://www.birst.com/">
      <getDataUploadStatusResult>
        <string>string</string>
        <string>string</string>
      </getDataUploadStatusResult>
    </getDataUploadStatusResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getDataUploadStatus xmlns="http://www.birst.com/">
      <token>string</token>
      <dataUploadToken>string</dataUploadToken>
    </getDataUploadStatus>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getDataUploadStatusResponse xmlns="http://www.birst.com/">
      <getDataUploadStatusResult>
        <string>string</string>
        <string>string</string>
      </getDataUploadStatusResult>
    </getDataUploadStatusResponse>
  </soap12:Body>
</soap12:Envelope>

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.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/getDatabaseLinksStatus"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getDatabaseLinksStatus xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceIDs>
        <string>string</string>
        <string>string</string>
      </spaceIDs>
    </getDatabaseLinksStatus>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getDatabaseLinksStatusResponse xmlns="http://www.birst.com/">
      <getDatabaseLinksStatusResult>
        <databaseLinksStatusResult>
          <DatabaseLinksStatusResultForSpace>
            <spaceId>string</spaceId>
            <databaseLinksEnabledInSpace>boolean</databaseLinksEnabledInSpace>
            <databaseLinksNeededInSpace>boolean</databaseLinksNeededInSpace>
            <databaseLinksNeededReason>string</databaseLinksNeededReason>
            <errorMessage>string</errorMessage>
          </DatabaseLinksStatusResultForSpace>
          <DatabaseLinksStatusResultForSpace>
            <spaceId>string</spaceId>
            <databaseLinksEnabledInSpace>boolean</databaseLinksEnabledInSpace>
            <databaseLinksNeededInSpace>boolean</databaseLinksNeededInSpace>
            <databaseLinksNeededReason>string</databaseLinksNeededReason>
            <errorMessage>string</errorMessage>
          </DatabaseLinksStatusResultForSpace>
        </databaseLinksStatusResult>
      </getDatabaseLinksStatusResult>
    </getDatabaseLinksStatusResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getDatabaseLinksStatus xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceIDs>
        <string>string</string>
        <string>string</string>
      </spaceIDs>
    </getDatabaseLinksStatus>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getDatabaseLinksStatusResponse xmlns="http://www.birst.com/">
      <getDatabaseLinksStatusResult>
        <databaseLinksStatusResult>
          <DatabaseLinksStatusResultForSpace>
            <spaceId>string</spaceId>
            <databaseLinksEnabledInSpace>boolean</databaseLinksEnabledInSpace>
            <databaseLinksNeededInSpace>boolean</databaseLinksNeededInSpace>
            <databaseLinksNeededReason>string</databaseLinksNeededReason>
            <errorMessage>string</errorMessage>
          </DatabaseLinksStatusResultForSpace>
          <DatabaseLinksStatusResultForSpace>
            <spaceId>string</spaceId>
            <databaseLinksEnabledInSpace>boolean</databaseLinksEnabledInSpace>
            <databaseLinksNeededInSpace>boolean</databaseLinksNeededInSpace>
            <databaseLinksNeededReason>string</databaseLinksNeededReason>
            <errorMessage>string</errorMessage>
          </DatabaseLinksStatusResultForSpace>
        </databaseLinksStatusResult>
      </getDatabaseLinksStatusResult>
    </getDatabaseLinksStatusResponse>
  </soap12:Body>
</soap12:Envelope>

getDefaultProfile

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/getDefaultProfile"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getDefaultProfile xmlns="http://www.birst.com/">
      <token>string</token>
    </getDefaultProfile>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getDefaultProfileResponse xmlns="http://www.birst.com/">
      <getDefaultProfileResult>
        <id>string</id>
        <name>string</name>
        <description>string</description>
        <isDefault>string</isDefault>
        <properties>
          <ProfileProperty>
            <name>string</name>
            <value>string</value>
            <locale>string</locale>
          </ProfileProperty>
          <ProfileProperty>
            <name>string</name>
            <value>string</value>
            <locale>string</locale>
          </ProfileProperty>
        </properties>
      </getDefaultProfileResult>
    </getDefaultProfileResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getDefaultProfile xmlns="http://www.birst.com/">
      <token>string</token>
    </getDefaultProfile>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getDefaultProfileResponse xmlns="http://www.birst.com/">
      <getDefaultProfileResult>
        <id>string</id>
        <name>string</name>
        <description>string</description>
        <isDefault>string</isDefault>
        <properties>
          <ProfileProperty>
            <name>string</name>
            <value>string</value>
            <locale>string</locale>
          </ProfileProperty>
          <ProfileProperty>
            <name>string</name>
            <value>string</value>
            <locale>string</locale>
          </ProfileProperty>
        </properties>
      </getDefaultProfileResult>
    </getDefaultProfileResponse>
  </soap12:Body>
</soap12:Envelope>

getDefaultProfileDetails

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/getDefaultProfileDetails"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getDefaultProfileDetails xmlns="http://www.birst.com/">
      <token>string</token>
    </getDefaultProfileDetails>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getDefaultProfileDetailsResponse xmlns="http://www.birst.com/">
      <getDefaultProfileDetailsResult>
        <id>string</id>
        <name>string</name>
        <description>string</description>
        <isDefault>string</isDefault>
        <properties>
          <ProfileProperty>
            <name>string</name>
            <value>string</value>
            <locale>string</locale>
          </ProfileProperty>
          <ProfileProperty>
            <name>string</name>
            <value>string</value>
            <locale>string</locale>
          </ProfileProperty>
        </properties>
      </getDefaultProfileDetailsResult>
    </getDefaultProfileDetailsResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getDefaultProfileDetails xmlns="http://www.birst.com/">
      <token>string</token>
    </getDefaultProfileDetails>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getDefaultProfileDetailsResponse xmlns="http://www.birst.com/">
      <getDefaultProfileDetailsResult>
        <id>string</id>
        <name>string</name>
        <description>string</description>
        <isDefault>string</isDefault>
        <properties>
          <ProfileProperty>
            <name>string</name>
            <value>string</value>
            <locale>string</locale>
          </ProfileProperty>
          <ProfileProperty>
            <name>string</name>
            <value>string</value>
            <locale>string</locale>
          </ProfileProperty>
        </properties>
      </getDefaultProfileDetailsResult>
    </getDefaultProfileDetailsResponse>
  </soap12:Body>
</soap12:Envelope>

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.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/getDetailedJobStatus"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getDetailedJobStatus xmlns="http://www.birst.com/">
      <token>string</token>
      <jobToken>string</jobToken>
    </getDetailedJobStatus>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getDetailedJobStatusResponse xmlns="http://www.birst.com/">
      <getDetailedJobStatusResult>
        <processingGroup>string</processingGroup>
        <type>int</type>
        <loadid>int</loadid>
        <message>string</message>
        <statusCode>string</statusCode>
      </getDetailedJobStatusResult>
    </getDetailedJobStatusResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getDetailedJobStatus xmlns="http://www.birst.com/">
      <token>string</token>
      <jobToken>string</jobToken>
    </getDetailedJobStatus>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getDetailedJobStatusResponse xmlns="http://www.birst.com/">
      <getDetailedJobStatusResult>
        <processingGroup>string</processingGroup>
        <type>int</type>
        <loadid>int</loadid>
        <message>string</message>
        <statusCode>string</statusCode>
      </getDetailedJobStatusResult>
    </getDetailedJobStatusResponse>
  </soap12:Body>
</soap12:Envelope>

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.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/getDirectoryContents"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getDirectoryContents xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <dir>string</dir>
    </getDirectoryContents>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getDirectoryContentsResponse xmlns="http://www.birst.com/">
      <getDirectoryContentsResult>
        <name>string</name>
        <label>string</label>
        <isDirectory>boolean</isDirectory>
        <isWriteable>boolean</isWriteable>
        <lastModified>string</lastModified>
        <isDashboard>boolean</isDashboard>
        <createdBy>string</createdBy>
        <children>
          <FileNode>
            <name>string</name>
            <label>string</label>
            <isDirectory>boolean</isDirectory>
            <isWriteable>boolean</isWriteable>
            <lastModified>string</lastModified>
            <isDashboard>boolean</isDashboard>
            <createdBy>string</createdBy>
            <children xsi:nil="true" />
          </FileNode>
          <FileNode>
            <name>string</name>
            <label>string</label>
            <isDirectory>boolean</isDirectory>
            <isWriteable>boolean</isWriteable>
            <lastModified>string</lastModified>
            <isDashboard>boolean</isDashboard>
            <createdBy>string</createdBy>
            <children xsi:nil="true" />
          </FileNode>
        </children>
      </getDirectoryContentsResult>
    </getDirectoryContentsResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getDirectoryContents xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <dir>string</dir>
    </getDirectoryContents>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getDirectoryContentsResponse xmlns="http://www.birst.com/">
      <getDirectoryContentsResult>
        <name>string</name>
        <label>string</label>
        <isDirectory>boolean</isDirectory>
        <isWriteable>boolean</isWriteable>
        <lastModified>string</lastModified>
        <isDashboard>boolean</isDashboard>
        <createdBy>string</createdBy>
        <children>
          <FileNode>
            <name>string</name>
            <label>string</label>
            <isDirectory>boolean</isDirectory>
            <isWriteable>boolean</isWriteable>
            <lastModified>string</lastModified>
            <isDashboard>boolean</isDashboard>
            <createdBy>string</createdBy>
            <children xsi:nil="true" />
          </FileNode>
          <FileNode>
            <name>string</name>
            <label>string</label>
            <isDirectory>boolean</isDirectory>
            <isWriteable>boolean</isWriteable>
            <lastModified>string</lastModified>
            <isDashboard>boolean</isDashboard>
            <createdBy>string</createdBy>
            <children xsi:nil="true" />
          </FileNode>
        </children>
      </getDirectoryContentsResult>
    </getDirectoryContentsResponse>
  </soap12:Body>
</soap12:Envelope>

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.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/getDirectoryPermissions"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getDirectoryPermissions xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <dir>string</dir>
    </getDirectoryPermissions>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getDirectoryPermissionsResponse xmlns="http://www.birst.com/">
      <getDirectoryPermissionsResult>
        <GroupPermission>
          <groupName>string</groupName>
          <canView>boolean</canView>
          <canModify>boolean</canModify>
        </GroupPermission>
        <GroupPermission>
          <groupName>string</groupName>
          <canView>boolean</canView>
          <canModify>boolean</canModify>
        </GroupPermission>
      </getDirectoryPermissionsResult>
    </getDirectoryPermissionsResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getDirectoryPermissions xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <dir>string</dir>
    </getDirectoryPermissions>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getDirectoryPermissionsResponse xmlns="http://www.birst.com/">
      <getDirectoryPermissionsResult>
        <GroupPermission>
          <groupName>string</groupName>
          <canView>boolean</canView>
          <canModify>boolean</canModify>
        </GroupPermission>
        <GroupPermission>
          <groupName>string</groupName>
          <canView>boolean</canView>
          <canModify>boolean</canModify>
        </GroupPermission>
      </getDirectoryPermissionsResult>
    </getDirectoryPermissionsResponse>
  </soap12:Body>
</soap12:Envelope>

getExportData

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/getExportData"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getExportData xmlns="http://www.birst.com/">
      <token>string</token>
      <exportToken>string</exportToken>
    </getExportData>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getExportDataResponse xmlns="http://www.birst.com/">
      <getExportDataResult>string</getExportDataResult>
    </getExportDataResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getExportData xmlns="http://www.birst.com/">
      <token>string</token>
      <exportToken>string</exportToken>
    </getExportData>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getExportDataResponse xmlns="http://www.birst.com/">
      <getExportDataResult>string</getExportDataResult>
    </getExportDataResponse>
  </soap12:Body>
</soap12:Envelope>

getExportJobAsset

Gets asset of an export job

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/getExportJobAsset"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getExportJobAsset xmlns="http://www.birst.com/">
      <token>string</token>
      <jobId>string</jobId>
      <spaceId>string</spaceId>
    </getExportJobAsset>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getExportJobAssetResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getExportJobAsset xmlns="http://www.birst.com/">
      <token>string</token>
      <jobId>string</jobId>
      <spaceId>string</spaceId>
    </getExportJobAsset>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getExportJobAssetResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

getExportJobStatus

Gets status of an export job

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/getExportJobStatus"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getExportJobStatus xmlns="http://www.birst.com/">
      <token>string</token>
      <jobId>string</jobId>
      <spaceId>string</spaceId>
    </getExportJobStatus>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getExportJobStatusResponse xmlns="http://www.birst.com/">
      <getExportJobStatusResult>string</getExportJobStatusResult>
    </getExportJobStatusResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getExportJobStatus xmlns="http://www.birst.com/">
      <token>string</token>
      <jobId>string</jobId>
      <spaceId>string</spaceId>
    </getExportJobStatus>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getExportJobStatusResponse xmlns="http://www.birst.com/">
      <getExportJobStatusResult>string</getExportJobStatusResult>
    </getExportJobStatusResponse>
  </soap12:Body>
</soap12:Envelope>

getExportJobs

Gets the job ids of a user in a space

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/getExportJobs"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getExportJobs xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceId>string</spaceId>
    </getExportJobs>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getExportJobsResponse xmlns="http://www.birst.com/">
      <getExportJobsResult>
        <string>string</string>
        <string>string</string>
      </getExportJobsResult>
    </getExportJobsResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getExportJobs xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceId>string</spaceId>
    </getExportJobs>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getExportJobsResponse xmlns="http://www.birst.com/">
      <getExportJobsResult>
        <string>string</string>
        <string>string</string>
      </getExportJobsResult>
    </getExportJobsResponse>
  </soap12:Body>
</soap12:Envelope>

getExpression

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/getExpression"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getExpression xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <expressionName>string</expressionName>
    </getExpression>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getExpressionResponse xmlns="http://www.birst.com/">
      <getExpressionResult>
        <Name>string</Name>
        <ColumnType>string</ColumnType>
        <Format>string</Format>
        <Expression>string</Expression>
      </getExpressionResult>
    </getExpressionResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getExpression xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <expressionName>string</expressionName>
    </getExpression>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getExpressionResponse xmlns="http://www.birst.com/">
      <getExpressionResult>
        <Name>string</Name>
        <ColumnType>string</ColumnType>
        <Format>string</Format>
        <Expression>string</Expression>
      </getExpressionResult>
    </getExpressionResponse>
  </soap12:Body>
</soap12:Envelope>

getExtendedSubjectArea

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/getExtendedSubjectArea"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getExtendedSubjectArea xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <name>string</name>
    </getExtendedSubjectArea>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getExtendedSubjectAreaResponse xmlns="http://www.birst.com/">
      <getExtendedSubjectAreaResult>string</getExtendedSubjectAreaResult>
    </getExtendedSubjectAreaResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getExtendedSubjectArea xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <name>string</name>
    </getExtendedSubjectArea>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getExtendedSubjectAreaResponse xmlns="http://www.birst.com/">
      <getExtendedSubjectAreaResult>string</getExtendedSubjectAreaResult>
    </getExtendedSubjectAreaResponse>
  </soap12:Body>
</soap12:Envelope>

getHierarchy

Gets hierarchy information from the space specified

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/getHierarchy"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getHierarchy xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <hierarchyName>string</hierarchyName>
    </getHierarchy>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getHierarchyResponse xmlns="http://www.birst.com/">
      <getHierarchyResult>
        <Name>string</Name>
        <Children>
          <LevelMetadata>
            <Name>string</Name>
            <Cardinality>string</Cardinality>
            <ColumnNames xsi:nil="true" />
            <Children xsi:nil="true" />
          </LevelMetadata>
          <LevelMetadata>
            <Name>string</Name>
            <Cardinality>string</Cardinality>
            <ColumnNames xsi:nil="true" />
            <Children xsi:nil="true" />
          </LevelMetadata>
        </Children>
      </getHierarchyResult>
    </getHierarchyResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getHierarchy xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <hierarchyName>string</hierarchyName>
    </getHierarchy>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getHierarchyResponse xmlns="http://www.birst.com/">
      <getHierarchyResult>
        <Name>string</Name>
        <Children>
          <LevelMetadata>
            <Name>string</Name>
            <Cardinality>string</Cardinality>
            <ColumnNames xsi:nil="true" />
            <Children xsi:nil="true" />
          </LevelMetadata>
          <LevelMetadata>
            <Name>string</Name>
            <Cardinality>string</Cardinality>
            <ColumnNames xsi:nil="true" />
            <Children xsi:nil="true" />
          </LevelMetadata>
        </Children>
      </getHierarchyResult>
    </getHierarchyResponse>
  </soap12:Body>
</soap12:Envelope>

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.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/getJobStatus"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getJobStatus xmlns="http://www.birst.com/">
      <token>string</token>
      <jobToken>string</jobToken>
    </getJobStatus>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getJobStatusResponse xmlns="http://www.birst.com/">
      <getJobStatusResult>
        <processingGroup>string</processingGroup>
        <type>int</type>
        <loadid>int</loadid>
        <message>string</message>
        <statusCode>string</statusCode>
      </getJobStatusResult>
    </getJobStatusResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getJobStatus xmlns="http://www.birst.com/">
      <token>string</token>
      <jobToken>string</jobToken>
    </getJobStatus>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getJobStatusResponse xmlns="http://www.birst.com/">
      <getJobStatusResult>
        <processingGroup>string</processingGroup>
        <type>int</type>
        <loadid>int</loadid>
        <message>string</message>
        <statusCode>string</statusCode>
      </getJobStatusResult>
    </getJobStatusResponse>
  </soap12:Body>
</soap12:Envelope>

getLanguageForUser

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/getLanguageForUser"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getLanguageForUser xmlns="http://www.birst.com/">
      <token>string</token>
      <username>string</username>
    </getLanguageForUser>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getLanguageForUserResponse xmlns="http://www.birst.com/">
      <getLanguageForUserResult>string</getLanguageForUserResult>
    </getLanguageForUserResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getLanguageForUser xmlns="http://www.birst.com/">
      <token>string</token>
      <username>string</username>
    </getLanguageForUser>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getLanguageForUserResponse xmlns="http://www.birst.com/">
      <getLanguageForUserResult>string</getLanguageForUserResult>
    </getLanguageForUserResponse>
  </soap12:Body>
</soap12:Envelope>

getLatestWorkflowExecutionStatus

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/getLatestWorkflowExecutionStatus"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getLatestWorkflowExecutionStatus xmlns="http://www.birst.com/">
      <token>string</token>
      <workflowName>string</workflowName>
    </getLatestWorkflowExecutionStatus>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getLatestWorkflowExecutionStatusResponse xmlns="http://www.birst.com/">
      <getLatestWorkflowExecutionStatusResult>string</getLatestWorkflowExecutionStatusResult>
    </getLatestWorkflowExecutionStatusResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getLatestWorkflowExecutionStatus xmlns="http://www.birst.com/">
      <token>string</token>
      <workflowName>string</workflowName>
    </getLatestWorkflowExecutionStatus>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getLatestWorkflowExecutionStatusResponse xmlns="http://www.birst.com/">
      <getLatestWorkflowExecutionStatusResult>string</getLatestWorkflowExecutionStatusResult>
    </getLatestWorkflowExecutionStatusResponse>
  </soap12:Body>
</soap12:Envelope>

getLiveAccessColumnProperties

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/getLiveAccessColumnProperties"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getLiveAccessColumnProperties xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <sourceName>string</sourceName>
      <columnName>string</columnName>
    </getLiveAccessColumnProperties>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getLiveAccessColumnPropertiesResponse xmlns="http://www.birst.com/">
      <getLiveAccessColumnPropertiesResult>
        <SourceName>string</SourceName>
        <ColumnName>string</ColumnName>
        <Formula>string</Formula>
        <DataType>string</DataType>
        <Width>int</Width>
        <Attribute>boolean</Attribute>
        <Measure>boolean</Measure>
        <AnalyzeByDate>boolean</AnalyzeByDate>
      </getLiveAccessColumnPropertiesResult>
    </getLiveAccessColumnPropertiesResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getLiveAccessColumnProperties xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <sourceName>string</sourceName>
      <columnName>string</columnName>
    </getLiveAccessColumnProperties>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getLiveAccessColumnPropertiesResponse xmlns="http://www.birst.com/">
      <getLiveAccessColumnPropertiesResult>
        <SourceName>string</SourceName>
        <ColumnName>string</ColumnName>
        <Formula>string</Formula>
        <DataType>string</DataType>
        <Width>int</Width>
        <Attribute>boolean</Attribute>
        <Measure>boolean</Measure>
        <AnalyzeByDate>boolean</AnalyzeByDate>
      </getLiveAccessColumnPropertiesResult>
    </getLiveAccessColumnPropertiesResponse>
  </soap12:Body>
</soap12:Envelope>

getLiveAccessSourceDetails

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/getLiveAccessSourceDetails"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getLiveAccessSourceDetails xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <sourceName>string</sourceName>
    </getLiveAccessSourceDetails>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getLiveAccessSourceDetailsResponse xmlns="http://www.birst.com/">
      <getLiveAccessSourceDetailsResult>
        <Name>string</Name>
        <UnCached>boolean</UnCached>
        <TTL>int</TTL>
        <Cardinality>int</Cardinality>
        <SourceKeys>
          <string>string</string>
          <string>string</string>
        </SourceKeys>
        <ForeignKeys>
          <string>string</string>
          <string>string</string>
        </ForeignKeys>
        <SourceFilterCondition>string</SourceFilterCondition>
      </getLiveAccessSourceDetailsResult>
    </getLiveAccessSourceDetailsResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getLiveAccessSourceDetails xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <sourceName>string</sourceName>
    </getLiveAccessSourceDetails>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getLiveAccessSourceDetailsResponse xmlns="http://www.birst.com/">
      <getLiveAccessSourceDetailsResult>
        <Name>string</Name>
        <UnCached>boolean</UnCached>
        <TTL>int</TTL>
        <Cardinality>int</Cardinality>
        <SourceKeys>
          <string>string</string>
          <string>string</string>
        </SourceKeys>
        <ForeignKeys>
          <string>string</string>
          <string>string</string>
        </ForeignKeys>
        <SourceFilterCondition>string</SourceFilterCondition>
      </getLiveAccessSourceDetailsResult>
    </getLiveAccessSourceDetailsResponse>
  </soap12:Body>
</soap12:Envelope>

getLoadStatus

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/getLoadStatus"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getLoadStatus xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
    </getLoadStatus>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getLoadStatusResponse xmlns="http://www.birst.com/">
      <getLoadStatusResult>string</getLoadStatusResult>
    </getLoadStatusResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getLoadStatus xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
    </getLoadStatus>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getLoadStatusResponse xmlns="http://www.birst.com/">
      <getLoadStatusResult>string</getLoadStatusResult>
    </getLoadStatusResponse>
  </soap12:Body>
</soap12:Envelope>

getODBCMetaData

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/getODBCMetaData"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getODBCMetaData xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
    </getODBCMetaData>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getODBCMetaDataResponse xmlns="http://www.birst.com/">
      <getODBCMetaDataResult>
        <tables>
          <ODBCTableResult>
            <tableName>string</tableName>
            <isFact>boolean</isFact>
            <columns xsi:nil="true" />
          </ODBCTableResult>
          <ODBCTableResult>
            <tableName>string</tableName>
            <isFact>boolean</isFact>
            <columns xsi:nil="true" />
          </ODBCTableResult>
        </tables>
        <relationships>
          <ODBCRelationshipResult>
            <primaryTable>string</primaryTable>
            <foreignTable>string</foreignTable>
            <primaryTableColumn>string</primaryTableColumn>
            <foreignTableColumn>string</foreignTableColumn>
          </ODBCRelationshipResult>
          <ODBCRelationshipResult>
            <primaryTable>string</primaryTable>
            <foreignTable>string</foreignTable>
            <primaryTableColumn>string</primaryTableColumn>
            <foreignTableColumn>string</foreignTableColumn>
          </ODBCRelationshipResult>
        </relationships>
        <errorCode>int</errorCode>
        <errorMessage>string</errorMessage>
      </getODBCMetaDataResult>
    </getODBCMetaDataResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getODBCMetaData xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
    </getODBCMetaData>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getODBCMetaDataResponse xmlns="http://www.birst.com/">
      <getODBCMetaDataResult>
        <tables>
          <ODBCTableResult>
            <tableName>string</tableName>
            <isFact>boolean</isFact>
            <columns xsi:nil="true" />
          </ODBCTableResult>
          <ODBCTableResult>
            <tableName>string</tableName>
            <isFact>boolean</isFact>
            <columns xsi:nil="true" />
          </ODBCTableResult>
        </tables>
        <relationships>
          <ODBCRelationshipResult>
            <primaryTable>string</primaryTable>
            <foreignTable>string</foreignTable>
            <primaryTableColumn>string</primaryTableColumn>
            <foreignTableColumn>string</foreignTableColumn>
          </ODBCRelationshipResult>
          <ODBCRelationshipResult>
            <primaryTable>string</primaryTable>
            <foreignTable>string</foreignTable>
            <primaryTableColumn>string</primaryTableColumn>
            <foreignTableColumn>string</foreignTableColumn>
          </ODBCRelationshipResult>
        </relationships>
        <errorCode>int</errorCode>
        <errorMessage>string</errorMessage>
      </getODBCMetaDataResult>
    </getODBCMetaDataResponse>
  </soap12:Body>
</soap12:Envelope>

getODBCMetaDataSubjectAreas

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/getODBCMetaDataSubjectAreas"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getODBCMetaDataSubjectAreas xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
    </getODBCMetaDataSubjectAreas>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getODBCMetaDataSubjectAreasResponse xmlns="http://www.birst.com/">
      <getODBCMetaDataSubjectAreasResult>
        <tables>
          <ODBCTableResult>
            <tableName>string</tableName>
            <isFact>boolean</isFact>
            <columns xsi:nil="true" />
          </ODBCTableResult>
          <ODBCTableResult>
            <tableName>string</tableName>
            <isFact>boolean</isFact>
            <columns xsi:nil="true" />
          </ODBCTableResult>
        </tables>
        <relationships>
          <ODBCRelationshipResult>
            <primaryTable>string</primaryTable>
            <foreignTable>string</foreignTable>
            <primaryTableColumn>string</primaryTableColumn>
            <foreignTableColumn>string</foreignTableColumn>
          </ODBCRelationshipResult>
          <ODBCRelationshipResult>
            <primaryTable>string</primaryTable>
            <foreignTable>string</foreignTable>
            <primaryTableColumn>string</primaryTableColumn>
            <foreignTableColumn>string</foreignTableColumn>
          </ODBCRelationshipResult>
        </relationships>
        <errorCode>int</errorCode>
        <errorMessage>string</errorMessage>
      </getODBCMetaDataSubjectAreasResult>
    </getODBCMetaDataSubjectAreasResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getODBCMetaDataSubjectAreas xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
    </getODBCMetaDataSubjectAreas>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getODBCMetaDataSubjectAreasResponse xmlns="http://www.birst.com/">
      <getODBCMetaDataSubjectAreasResult>
        <tables>
          <ODBCTableResult>
            <tableName>string</tableName>
            <isFact>boolean</isFact>
            <columns xsi:nil="true" />
          </ODBCTableResult>
          <ODBCTableResult>
            <tableName>string</tableName>
            <isFact>boolean</isFact>
            <columns xsi:nil="true" />
          </ODBCTableResult>
        </tables>
        <relationships>
          <ODBCRelationshipResult>
            <primaryTable>string</primaryTable>
            <foreignTable>string</foreignTable>
            <primaryTableColumn>string</primaryTableColumn>
            <foreignTableColumn>string</foreignTableColumn>
          </ODBCRelationshipResult>
          <ODBCRelationshipResult>
            <primaryTable>string</primaryTable>
            <foreignTable>string</foreignTable>
            <primaryTableColumn>string</primaryTableColumn>
            <foreignTableColumn>string</foreignTableColumn>
          </ODBCRelationshipResult>
        </relationships>
        <errorCode>int</errorCode>
        <errorMessage>string</errorMessage>
      </getODBCMetaDataSubjectAreasResult>
    </getODBCMetaDataSubjectAreasResponse>
  </soap12:Body>
</soap12:Envelope>

getProfile

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/getProfile"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getProfile xmlns="http://www.birst.com/">
      <token>string</token>
      <profileID>string</profileID>
    </getProfile>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getProfileResponse xmlns="http://www.birst.com/">
      <getProfileResult>
        <id>string</id>
        <name>string</name>
        <description>string</description>
        <isDefault>string</isDefault>
        <properties>
          <ProfileProperty>
            <name>string</name>
            <value>string</value>
            <locale>string</locale>
          </ProfileProperty>
          <ProfileProperty>
            <name>string</name>
            <value>string</value>
            <locale>string</locale>
          </ProfileProperty>
        </properties>
      </getProfileResult>
    </getProfileResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getProfile xmlns="http://www.birst.com/">
      <token>string</token>
      <profileID>string</profileID>
    </getProfile>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getProfileResponse xmlns="http://www.birst.com/">
      <getProfileResult>
        <id>string</id>
        <name>string</name>
        <description>string</description>
        <isDefault>string</isDefault>
        <properties>
          <ProfileProperty>
            <name>string</name>
            <value>string</value>
            <locale>string</locale>
          </ProfileProperty>
          <ProfileProperty>
            <name>string</name>
            <value>string</value>
            <locale>string</locale>
          </ProfileProperty>
        </properties>
      </getProfileResult>
    </getProfileResponse>
  </soap12:Body>
</soap12:Envelope>

getProfileDetails

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/getProfileDetails"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getProfileDetails xmlns="http://www.birst.com/">
      <token>string</token>
      <profileID>string</profileID>
    </getProfileDetails>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getProfileDetailsResponse xmlns="http://www.birst.com/">
      <getProfileDetailsResult>
        <id>string</id>
        <name>string</name>
        <description>string</description>
        <isDefault>string</isDefault>
        <properties>
          <ProfileProperty>
            <name>string</name>
            <value>string</value>
            <locale>string</locale>
          </ProfileProperty>
          <ProfileProperty>
            <name>string</name>
            <value>string</value>
            <locale>string</locale>
          </ProfileProperty>
        </properties>
      </getProfileDetailsResult>
    </getProfileDetailsResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getProfileDetails xmlns="http://www.birst.com/">
      <token>string</token>
      <profileID>string</profileID>
    </getProfileDetails>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getProfileDetailsResponse xmlns="http://www.birst.com/">
      <getProfileDetailsResult>
        <id>string</id>
        <name>string</name>
        <description>string</description>
        <isDefault>string</isDefault>
        <properties>
          <ProfileProperty>
            <name>string</name>
            <value>string</value>
            <locale>string</locale>
          </ProfileProperty>
          <ProfileProperty>
            <name>string</name>
            <value>string</value>
            <locale>string</locale>
          </ProfileProperty>
        </properties>
      </getProfileDetailsResult>
    </getProfileDetailsResponse>
  </soap12:Body>
</soap12:Envelope>

getProfileForUser

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/getProfileForUser"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getProfileForUser xmlns="http://www.birst.com/">
      <token>string</token>
      <username>string</username>
    </getProfileForUser>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getProfileForUserResponse xmlns="http://www.birst.com/">
      <getProfileForUserResult>
        <id>string</id>
        <name>string</name>
        <description>string</description>
        <isDefault>string</isDefault>
        <properties>
          <ProfileProperty>
            <name>string</name>
            <value>string</value>
            <locale>string</locale>
          </ProfileProperty>
          <ProfileProperty>
            <name>string</name>
            <value>string</value>
            <locale>string</locale>
          </ProfileProperty>
        </properties>
      </getProfileForUserResult>
    </getProfileForUserResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getProfileForUser xmlns="http://www.birst.com/">
      <token>string</token>
      <username>string</username>
    </getProfileForUser>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getProfileForUserResponse xmlns="http://www.birst.com/">
      <getProfileForUserResult>
        <id>string</id>
        <name>string</name>
        <description>string</description>
        <isDefault>string</isDefault>
        <properties>
          <ProfileProperty>
            <name>string</name>
            <value>string</value>
            <locale>string</locale>
          </ProfileProperty>
          <ProfileProperty>
            <name>string</name>
            <value>string</value>
            <locale>string</locale>
          </ProfileProperty>
        </properties>
      </getProfileForUserResult>
    </getProfileForUserResponse>
  </soap12:Body>
</soap12:Envelope>

getProfileProperty

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/getProfileProperty"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getProfileProperty xmlns="http://www.birst.com/">
      <token>string</token>
      <profileID>string</profileID>
      <propertyName>string</propertyName>
    </getProfileProperty>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getProfilePropertyResponse xmlns="http://www.birst.com/">
      <getProfilePropertyResult>
        <ProfileProperty>
          <name>string</name>
          <value>string</value>
          <locale>string</locale>
        </ProfileProperty>
        <ProfileProperty>
          <name>string</name>
          <value>string</value>
          <locale>string</locale>
        </ProfileProperty>
      </getProfilePropertyResult>
    </getProfilePropertyResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getProfileProperty xmlns="http://www.birst.com/">
      <token>string</token>
      <profileID>string</profileID>
      <propertyName>string</propertyName>
    </getProfileProperty>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getProfilePropertyResponse xmlns="http://www.birst.com/">
      <getProfilePropertyResult>
        <ProfileProperty>
          <name>string</name>
          <value>string</value>
          <locale>string</locale>
        </ProfileProperty>
        <ProfileProperty>
          <name>string</name>
          <value>string</value>
          <locale>string</locale>
        </ProfileProperty>
      </getProfilePropertyResult>
    </getProfilePropertyResponse>
  </soap12:Body>
</soap12:Envelope>

getProfilePropertyWithLocale

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/getProfilePropertyWithLocale"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getProfilePropertyWithLocale xmlns="http://www.birst.com/">
      <token>string</token>
      <profileID>string</profileID>
      <propertyName>string</propertyName>
      <locale>string</locale>
    </getProfilePropertyWithLocale>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getProfilePropertyWithLocaleResponse xmlns="http://www.birst.com/">
      <getProfilePropertyWithLocaleResult>
        <name>string</name>
        <value>string</value>
        <locale>string</locale>
      </getProfilePropertyWithLocaleResult>
    </getProfilePropertyWithLocaleResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getProfilePropertyWithLocale xmlns="http://www.birst.com/">
      <token>string</token>
      <profileID>string</profileID>
      <propertyName>string</propertyName>
      <locale>string</locale>
    </getProfilePropertyWithLocale>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getProfilePropertyWithLocaleResponse xmlns="http://www.birst.com/">
      <getProfilePropertyWithLocaleResult>
        <name>string</name>
        <value>string</value>
        <locale>string</locale>
      </getProfilePropertyWithLocaleResult>
    </getProfilePropertyWithLocaleResponse>
  </soap12:Body>
</soap12:Envelope>

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.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/getPublishingStatus"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getPublishingStatus xmlns="http://www.birst.com/">
      <token>string</token>
      <publishingToken>string</publishingToken>
    </getPublishingStatus>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getPublishingStatusResponse xmlns="http://www.birst.com/">
      <getPublishingStatusResult>
        <string>string</string>
        <string>string</string>
      </getPublishingStatusResult>
    </getPublishingStatusResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getPublishingStatus xmlns="http://www.birst.com/">
      <token>string</token>
      <publishingToken>string</publishingToken>
    </getPublishingStatus>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getPublishingStatusResponse xmlns="http://www.birst.com/">
      <getPublishingStatusResult>
        <string>string</string>
        <string>string</string>
      </getPublishingStatusResult>
    </getPublishingStatusResponse>
  </soap12:Body>
</soap12:Envelope>

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.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/getReportData"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getReportData xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <reportName>string</reportName>
      <reportFilters>
        <Filter>
          <Operator>string</Operator>
          <multiSelectType>string</multiSelectType>
          <FilterType>string</FilterType>
          <ParameterName>string</ParameterName>
          <selectedValues>
            <selectedValue>string</selectedValue>
            <selectedValue>string</selectedValue>
          </selectedValues>
        </Filter>
        <Filter>
          <Operator>string</Operator>
          <multiSelectType>string</multiSelectType>
          <FilterType>string</FilterType>
          <ParameterName>string</ParameterName>
          <selectedValues>
            <selectedValue>string</selectedValue>
            <selectedValue>string</selectedValue>
          </selectedValues>
        </Filter>
      </reportFilters>
    </getReportData>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getReportDataResponse xmlns="http://www.birst.com/">
      <getReportDataResult>
        <queryToken>string</queryToken>
        <numRowsReturned>int</numRowsReturned>
        <hasMoreRows>boolean</hasMoreRows>
      </getReportDataResult>
    </getReportDataResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getReportData xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <reportName>string</reportName>
      <reportFilters>
        <Filter>
          <Operator>string</Operator>
          <multiSelectType>string</multiSelectType>
          <FilterType>string</FilterType>
          <ParameterName>string</ParameterName>
          <selectedValues>
            <selectedValue>string</selectedValue>
            <selectedValue>string</selectedValue>
          </selectedValues>
        </Filter>
        <Filter>
          <Operator>string</Operator>
          <multiSelectType>string</multiSelectType>
          <FilterType>string</FilterType>
          <ParameterName>string</ParameterName>
          <selectedValues>
            <selectedValue>string</selectedValue>
            <selectedValue>string</selectedValue>
          </selectedValues>
        </Filter>
      </reportFilters>
    </getReportData>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getReportDataResponse xmlns="http://www.birst.com/">
      <getReportDataResult>
        <queryToken>string</queryToken>
        <numRowsReturned>int</numRowsReturned>
        <hasMoreRows>boolean</hasMoreRows>
      </getReportDataResult>
    </getReportDataResponse>
  </soap12:Body>
</soap12:Envelope>

getSfdcAccountMapping

Gets mapping of SFDC account to Birst account

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/getSfdcAccountMapping"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getSfdcAccountMapping xmlns="http://www.birst.com/">
      <token>string</token>
    </getSfdcAccountMapping>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getSfdcAccountMappingResponse xmlns="http://www.birst.com/">
      <getSfdcAccountMappingResult>
        <string>string</string>
        <string>string</string>
      </getSfdcAccountMappingResult>
    </getSfdcAccountMappingResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getSfdcAccountMapping xmlns="http://www.birst.com/">
      <token>string</token>
    </getSfdcAccountMapping>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getSfdcAccountMappingResponse xmlns="http://www.birst.com/">
      <getSfdcAccountMappingResult>
        <string>string</string>
        <string>string</string>
      </getSfdcAccountMappingResult>
    </getSfdcAccountMappingResponse>
  </soap12:Body>
</soap12:Envelope>

getSourceDetails

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/getSourceDetails"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getSourceDetails xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <sourceName>string</sourceName>
    </getSourceDetails>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getSourceDetailsResponse xmlns="http://www.birst.com/">
      <getSourceDetailsResult>
        <Name>string</Name>
        <OriginalName>string</OriginalName>
        <Disabled>boolean</Disabled>
        <Script>
          <InputQuery>string</InputQuery>
          <Output>string</Output>
          <Script>string</Script>
        </Script>
        <LastModifiedDate>dateTime</LastModifiedDate>
        <SubGroups>
          <string>string</string>
          <string>string</string>
        </SubGroups>
        <Columns>
          <SourceColumnSubClass>
            <Name>string</Name>
            <OriginalName>string</OriginalName>
            <AnalyzeMeasure>boolean</AnalyzeMeasure>
            <DataType>string</DataType>
            <Format>string</Format>
            <EnableSecutityFilter>boolean</EnableSecutityFilter>
            <SourceFileColumn>string</SourceFileColumn>
            <TargetAggregations xsi:nil="true" />
            <TargetTypes xsi:nil="true" />
            <UnknownValue>string</UnknownValue>
            <Width>int</Width>
            <HierarchyName>string</HierarchyName>
            <LevelName>string</LevelName>
            <Levels xsi:nil="true" />
            <AnalyzeByDate>boolean</AnalyzeByDate>
            <Measure>boolean</Measure>
            <LockType>boolean</LockType>
          </SourceColumnSubClass>
          <SourceColumnSubClass>
            <Name>string</Name>
            <OriginalName>string</OriginalName>
            <AnalyzeMeasure>boolean</AnalyzeMeasure>
            <DataType>string</DataType>
            <Format>string</Format>
            <EnableSecutityFilter>boolean</EnableSecutityFilter>
            <SourceFileColumn>string</SourceFileColumn>
            <TargetAggregations xsi:nil="true" />
            <TargetTypes xsi:nil="true" />
            <UnknownValue>string</UnknownValue>
            <Width>int</Width>
            <HierarchyName>string</HierarchyName>
            <LevelName>string</LevelName>
            <Levels xsi:nil="true" />
            <AnalyzeByDate>boolean</AnalyzeByDate>
            <Measure>boolean</Measure>
            <LockType>boolean</LockType>
          </SourceColumnSubClass>
        </Columns>
      </getSourceDetailsResult>
    </getSourceDetailsResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getSourceDetails xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <sourceName>string</sourceName>
    </getSourceDetails>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getSourceDetailsResponse xmlns="http://www.birst.com/">
      <getSourceDetailsResult>
        <Name>string</Name>
        <OriginalName>string</OriginalName>
        <Disabled>boolean</Disabled>
        <Script>
          <InputQuery>string</InputQuery>
          <Output>string</Output>
          <Script>string</Script>
        </Script>
        <LastModifiedDate>dateTime</LastModifiedDate>
        <SubGroups>
          <string>string</string>
          <string>string</string>
        </SubGroups>
        <Columns>
          <SourceColumnSubClass>
            <Name>string</Name>
            <OriginalName>string</OriginalName>
            <AnalyzeMeasure>boolean</AnalyzeMeasure>
            <DataType>string</DataType>
            <Format>string</Format>
            <EnableSecutityFilter>boolean</EnableSecutityFilter>
            <SourceFileColumn>string</SourceFileColumn>
            <TargetAggregations xsi:nil="true" />
            <TargetTypes xsi:nil="true" />
            <UnknownValue>string</UnknownValue>
            <Width>int</Width>
            <HierarchyName>string</HierarchyName>
            <LevelName>string</LevelName>
            <Levels xsi:nil="true" />
            <AnalyzeByDate>boolean</AnalyzeByDate>
            <Measure>boolean</Measure>
            <LockType>boolean</LockType>
          </SourceColumnSubClass>
          <SourceColumnSubClass>
            <Name>string</Name>
            <OriginalName>string</OriginalName>
            <AnalyzeMeasure>boolean</AnalyzeMeasure>
            <DataType>string</DataType>
            <Format>string</Format>
            <EnableSecutityFilter>boolean</EnableSecutityFilter>
            <SourceFileColumn>string</SourceFileColumn>
            <TargetAggregations xsi:nil="true" />
            <TargetTypes xsi:nil="true" />
            <UnknownValue>string</UnknownValue>
            <Width>int</Width>
            <HierarchyName>string</HierarchyName>
            <LevelName>string</LevelName>
            <Levels xsi:nil="true" />
            <AnalyzeByDate>boolean</AnalyzeByDate>
            <Measure>boolean</Measure>
            <LockType>boolean</LockType>
          </SourceColumnSubClass>
        </Columns>
      </getSourceDetailsResult>
    </getSourceDetailsResponse>
  </soap12:Body>
</soap12:Envelope>

getSourcesList

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/getSourcesList"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getSourcesList xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
    </getSourcesList>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getSourcesListResponse xmlns="http://www.birst.com/">
      <getSourcesListResult>
        <string>string</string>
        <string>string</string>
      </getSourcesListResult>
    </getSourcesListResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getSourcesList xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
    </getSourcesList>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getSourcesListResponse xmlns="http://www.birst.com/">
      <getSourcesListResult>
        <string>string</string>
        <string>string</string>
      </getSourcesListResult>
    </getSourcesListResponse>
  </soap12:Body>
</soap12:Envelope>

getSpaceComments

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/getSpaceComments"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getSpaceComments xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
    </getSpaceComments>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getSpaceCommentsResponse xmlns="http://www.birst.com/">
      <getSpaceCommentsResult>string</getSpaceCommentsResult>
    </getSpaceCommentsResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getSpaceComments xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
    </getSpaceComments>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getSpaceCommentsResponse xmlns="http://www.birst.com/">
      <getSpaceCommentsResult>string</getSpaceCommentsResult>
    </getSpaceCommentsResponse>
  </soap12:Body>
</soap12:Envelope>

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).

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/getSpaceJNLPFile"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getSpaceJNLPFile xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <configfile>string</configfile>
    </getSpaceJNLPFile>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getSpaceJNLPFileResponse xmlns="http://www.birst.com/">
      <getSpaceJNLPFileResult>string</getSpaceJNLPFileResult>
    </getSpaceJNLPFileResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getSpaceJNLPFile xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <configfile>string</configfile>
    </getSpaceJNLPFile>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getSpaceJNLPFileResponse xmlns="http://www.birst.com/">
      <getSpaceJNLPFileResult>string</getSpaceJNLPFileResult>
    </getSpaceJNLPFileResponse>
  </soap12:Body>
</soap12:Envelope>

getSpaceProcessEngineVersion

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/getSpaceProcessEngineVersion"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getSpaceProcessEngineVersion xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
    </getSpaceProcessEngineVersion>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getSpaceProcessEngineVersionResponse xmlns="http://www.birst.com/">
      <getSpaceProcessEngineVersionResult>string</getSpaceProcessEngineVersionResult>
    </getSpaceProcessEngineVersionResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getSpaceProcessEngineVersion xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
    </getSpaceProcessEngineVersion>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getSpaceProcessEngineVersionResponse xmlns="http://www.birst.com/">
      <getSpaceProcessEngineVersionResult>string</getSpaceProcessEngineVersionResult>
    </getSpaceProcessEngineVersionResponse>
  </soap12:Body>
</soap12:Envelope>

getSpaceStatistics

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/getSpaceStatistics"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getSpaceStatistics xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
    </getSpaceStatistics>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getSpaceStatisticsResponse xmlns="http://www.birst.com/">
      <getSpaceStatisticsResult>
        <SpaceSize>string</SpaceSize>
        <UserCount>int</UserCount>
      </getSpaceStatisticsResult>
    </getSpaceStatisticsResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getSpaceStatistics xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
    </getSpaceStatistics>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getSpaceStatisticsResponse xmlns="http://www.birst.com/">
      <getSpaceStatisticsResult>
        <SpaceSize>string</SpaceSize>
        <UserCount>int</UserCount>
      </getSpaceStatisticsResult>
    </getSpaceStatisticsResponse>
  </soap12:Body>
</soap12:Envelope>

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.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/getSpaceStatus"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getSpaceStatus xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
    </getSpaceStatus>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getSpaceStatusResponse xmlns="http://www.birst.com/">
      <getSpaceStatusResult>string</getSpaceStatusResult>
    </getSpaceStatusResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getSpaceStatus xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
    </getSpaceStatus>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getSpaceStatusResponse xmlns="http://www.birst.com/">
      <getSpaceStatusResult>string</getSpaceStatusResult>
    </getSpaceStatusResponse>
  </soap12:Body>
</soap12:Envelope>

getSubjectAreaContent

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/getSubjectAreaContent"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getSubjectAreaContent xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <name>string</name>
    </getSubjectAreaContent>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getSubjectAreaContentResponse xmlns="http://www.birst.com/">
      <getSubjectAreaContentResult>string</getSubjectAreaContentResult>
    </getSubjectAreaContentResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getSubjectAreaContent xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <name>string</name>
    </getSubjectAreaContent>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getSubjectAreaContentResponse xmlns="http://www.birst.com/">
      <getSubjectAreaContentResult>string</getSubjectAreaContentResult>
    </getSubjectAreaContentResponse>
  </soap12:Body>
</soap12:Envelope>

getSubjectAreaDescription

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/getSubjectAreaDescription"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getSubjectAreaDescription xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <name>string</name>
    </getSubjectAreaDescription>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getSubjectAreaDescriptionResponse xmlns="http://www.birst.com/">
      <getSubjectAreaDescriptionResult>string</getSubjectAreaDescriptionResult>
    </getSubjectAreaDescriptionResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getSubjectAreaDescription xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <name>string</name>
    </getSubjectAreaDescription>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getSubjectAreaDescriptionResponse xmlns="http://www.birst.com/">
      <getSubjectAreaDescriptionResult>string</getSubjectAreaDescriptionResult>
    </getSubjectAreaDescriptionResponse>
  </soap12:Body>
</soap12:Envelope>

getSubjectAreaForLocalization

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/getSubjectAreaForLocalization"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getSubjectAreaForLocalization xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <name>string</name>
    </getSubjectAreaForLocalization>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getSubjectAreaForLocalizationResponse xmlns="http://www.birst.com/">
      <getSubjectAreaForLocalizationResult>string</getSubjectAreaForLocalizationResult>
    </getSubjectAreaForLocalizationResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getSubjectAreaForLocalization xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <name>string</name>
    </getSubjectAreaForLocalization>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getSubjectAreaForLocalizationResponse xmlns="http://www.birst.com/">
      <getSubjectAreaForLocalizationResult>string</getSubjectAreaForLocalizationResult>
    </getSubjectAreaForLocalizationResponse>
  </soap12:Body>
</soap12:Envelope>

getSubjectAreaPermissions

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/getSubjectAreaPermissions"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getSubjectAreaPermissions xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <name>string</name>
    </getSubjectAreaPermissions>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getSubjectAreaPermissionsResponse xmlns="http://www.birst.com/">
      <getSubjectAreaPermissionsResult>
        <string>string</string>
        <string>string</string>
      </getSubjectAreaPermissionsResult>
    </getSubjectAreaPermissionsResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getSubjectAreaPermissions xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <name>string</name>
    </getSubjectAreaPermissions>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getSubjectAreaPermissionsResponse xmlns="http://www.birst.com/">
      <getSubjectAreaPermissionsResult>
        <string>string</string>
        <string>string</string>
      </getSubjectAreaPermissionsResult>
    </getSubjectAreaPermissionsResponse>
  </soap12:Body>
</soap12:Envelope>

getUpdatedSubjectArea

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/getUpdatedSubjectArea"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getUpdatedSubjectArea xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <name>string</name>
      <query>string</query>
    </getUpdatedSubjectArea>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getUpdatedSubjectAreaResponse xmlns="http://www.birst.com/">
      <getUpdatedSubjectAreaResult>string</getUpdatedSubjectAreaResult>
    </getUpdatedSubjectAreaResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getUpdatedSubjectArea xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <name>string</name>
      <query>string</query>
    </getUpdatedSubjectArea>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getUpdatedSubjectAreaResponse xmlns="http://www.birst.com/">
      <getUpdatedSubjectAreaResult>string</getUpdatedSubjectAreaResult>
    </getUpdatedSubjectAreaResponse>
  </soap12:Body>
</soap12:Envelope>

getUserProfile

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/getUserProfile"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getUserProfile xmlns="http://www.birst.com/">
      <token>string</token>
    </getUserProfile>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getUserProfileResponse xmlns="http://www.birst.com/">
      <getUserProfileResult>
        <id>string</id>
        <name>string</name>
        <description>string</description>
        <isDefault>string</isDefault>
        <properties>
          <ProfileProperty>
            <name>string</name>
            <value>string</value>
            <locale>string</locale>
          </ProfileProperty>
          <ProfileProperty>
            <name>string</name>
            <value>string</value>
            <locale>string</locale>
          </ProfileProperty>
        </properties>
      </getUserProfileResult>
    </getUserProfileResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getUserProfile xmlns="http://www.birst.com/">
      <token>string</token>
    </getUserProfile>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getUserProfileResponse xmlns="http://www.birst.com/">
      <getUserProfileResult>
        <id>string</id>
        <name>string</name>
        <description>string</description>
        <isDefault>string</isDefault>
        <properties>
          <ProfileProperty>
            <name>string</name>
            <value>string</value>
            <locale>string</locale>
          </ProfileProperty>
          <ProfileProperty>
            <name>string</name>
            <value>string</value>
            <locale>string</locale>
          </ProfileProperty>
        </properties>
      </getUserProfileResult>
    </getUserProfileResponse>
  </soap12:Body>
</soap12:Envelope>

getUserProfileDetails

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/getUserProfileDetails"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getUserProfileDetails xmlns="http://www.birst.com/">
      <token>string</token>
    </getUserProfileDetails>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getUserProfileDetailsResponse xmlns="http://www.birst.com/">
      <getUserProfileDetailsResult>
        <id>string</id>
        <name>string</name>
        <description>string</description>
        <isDefault>string</isDefault>
        <properties>
          <ProfileProperty>
            <name>string</name>
            <value>string</value>
            <locale>string</locale>
          </ProfileProperty>
          <ProfileProperty>
            <name>string</name>
            <value>string</value>
            <locale>string</locale>
          </ProfileProperty>
        </properties>
      </getUserProfileDetailsResult>
    </getUserProfileDetailsResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getUserProfileDetails xmlns="http://www.birst.com/">
      <token>string</token>
    </getUserProfileDetails>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getUserProfileDetailsResponse xmlns="http://www.birst.com/">
      <getUserProfileDetailsResult>
        <id>string</id>
        <name>string</name>
        <description>string</description>
        <isDefault>string</isDefault>
        <properties>
          <ProfileProperty>
            <name>string</name>
            <value>string</value>
            <locale>string</locale>
          </ProfileProperty>
          <ProfileProperty>
            <name>string</name>
            <value>string</value>
            <locale>string</locale>
          </ProfileProperty>
        </properties>
      </getUserProfileDetailsResult>
    </getUserProfileDetailsResponse>
  </soap12:Body>
</soap12:Envelope>

getUserRelease

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/getUserRelease"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getUserRelease xmlns="http://www.birst.com/">
      <token>string</token>
      <userName>string</userName>
    </getUserRelease>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getUserReleaseResponse xmlns="http://www.birst.com/">
      <getUserReleaseResult>string</getUserReleaseResult>
    </getUserReleaseResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getUserRelease xmlns="http://www.birst.com/">
      <token>string</token>
      <userName>string</userName>
    </getUserRelease>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getUserReleaseResponse xmlns="http://www.birst.com/">
      <getUserReleaseResult>string</getUserReleaseResult>
    </getUserReleaseResponse>
  </soap12:Body>
</soap12:Envelope>

getUsersForProfile

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/getUsersForProfile"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getUsersForProfile xmlns="http://www.birst.com/">
      <token>string</token>
      <profileId>string</profileId>
    </getUsersForProfile>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getUsersForProfileResponse xmlns="http://www.birst.com/">
      <getUsersForProfileResult>
        <string>string</string>
        <string>string</string>
      </getUsersForProfileResult>
    </getUsersForProfileResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getUsersForProfile xmlns="http://www.birst.com/">
      <token>string</token>
      <profileId>string</profileId>
    </getUsersForProfile>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getUsersForProfileResponse xmlns="http://www.birst.com/">
      <getUsersForProfileResult>
        <string>string</string>
        <string>string</string>
      </getUsersForProfileResult>
    </getUsersForProfileResponse>
  </soap12:Body>
</soap12:Envelope>

getUsersInAccount

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/getUsersInAccount"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getUsersInAccount xmlns="http://www.birst.com/">
      <token>string</token>
      <offset>int</offset>
      <limit>int</limit>
      <search>string</search>
    </getUsersInAccount>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getUsersInAccountResponse xmlns="http://www.birst.com/">
      <getUsersInAccountResult>
        <UserObject>
          <username>string</username>
          <email>string</email>
        </UserObject>
        <UserObject>
          <username>string</username>
          <email>string</email>
        </UserObject>
      </getUsersInAccountResult>
    </getUsersInAccountResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getUsersInAccount xmlns="http://www.birst.com/">
      <token>string</token>
      <offset>int</offset>
      <limit>int</limit>
      <search>string</search>
    </getUsersInAccount>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getUsersInAccountResponse xmlns="http://www.birst.com/">
      <getUsersInAccountResult>
        <UserObject>
          <username>string</username>
          <email>string</email>
        </UserObject>
        <UserObject>
          <username>string</username>
          <email>string</email>
        </UserObject>
      </getUsersInAccountResult>
    </getUsersInAccountResponse>
  </soap12:Body>
</soap12:Envelope>

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/getVariablesForSpace"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getVariablesForSpace xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
    </getVariablesForSpace>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getVariablesForSpaceResponse xmlns="http://www.birst.com/">
      <getVariablesForSpaceResult>
        <ArrayOfString>
          <string>string</string>
          <string>string</string>
        </ArrayOfString>
        <ArrayOfString>
          <string>string</string>
          <string>string</string>
        </ArrayOfString>
      </getVariablesForSpaceResult>
    </getVariablesForSpaceResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getVariablesForSpace xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
    </getVariablesForSpace>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getVariablesForSpaceResponse xmlns="http://www.birst.com/">
      <getVariablesForSpaceResult>
        <ArrayOfString>
          <string>string</string>
          <string>string</string>
        </ArrayOfString>
        <ArrayOfString>
          <string>string</string>
          <string>string</string>
        </ArrayOfString>
      </getVariablesForSpaceResult>
    </getVariablesForSpaceResponse>
  </soap12:Body>
</soap12:Envelope>

getWorkflowById

This webservice fetches workflow for the given workflow Id.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/getWorkflowById"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getWorkflowById xmlns="http://www.birst.com/">
      <token>string</token>
      <workflowId>string</workflowId>
    </getWorkflowById>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getWorkflowByIdResponse xmlns="http://www.birst.com/">
      <getWorkflowByIdResult>
        <workflowId>string</workflowId>
        <name>string</name>
        <description>string</description>
        <createdByUserId>string</createdByUserId>
        <createdByUsername>string</createdByUsername>
        <modifiedByUserId>string</modifiedByUserId>
        <modifiedByUsername>string</modifiedByUsername>
        <restricted>boolean</restricted>
        <accountId>string</accountId>
        <schedulerName>string</schedulerName>
        <schedulerDisplayName>string</schedulerDisplayName>
        <enableUserSyncUp>boolean</enableUserSyncUp>
        <sourceAppLids>
          <string>string</string>
          <string>string</string>
        </sourceAppLids>
        <targetAppLids>
          <string>string</string>
          <string>string</string>
        </targetAppLids>
        <steps>
          <Step>
            <name>string</name>
            <description>string</description>
            <stepId>string</stepId>
            <parentStepId>string</parentStepId>
            <tasks xsi:nil="true" />
          </Step>
          <Step>
            <name>string</name>
            <description>string</description>
            <stepId>string</stepId>
            <parentStepId>string</parentStepId>
            <tasks xsi:nil="true" />
          </Step>
        </steps>
        <schedules>
          <Schedule>
            <scheduleId>string</scheduleId>
            <enabled>boolean</enabled>
            <timeZone>string</timeZone>
            <cronExpression>string</cronExpression>
          </Schedule>
          <Schedule>
            <scheduleId>string</scheduleId>
            <enabled>boolean</enabled>
            <timeZone>string</timeZone>
            <cronExpression>string</cronExpression>
          </Schedule>
        </schedules>
        <notificationEmailIds>
          <string>string</string>
          <string>string</string>
        </notificationEmailIds>
      </getWorkflowByIdResult>
    </getWorkflowByIdResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getWorkflowById xmlns="http://www.birst.com/">
      <token>string</token>
      <workflowId>string</workflowId>
    </getWorkflowById>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getWorkflowByIdResponse xmlns="http://www.birst.com/">
      <getWorkflowByIdResult>
        <workflowId>string</workflowId>
        <name>string</name>
        <description>string</description>
        <createdByUserId>string</createdByUserId>
        <createdByUsername>string</createdByUsername>
        <modifiedByUserId>string</modifiedByUserId>
        <modifiedByUsername>string</modifiedByUsername>
        <restricted>boolean</restricted>
        <accountId>string</accountId>
        <schedulerName>string</schedulerName>
        <schedulerDisplayName>string</schedulerDisplayName>
        <enableUserSyncUp>boolean</enableUserSyncUp>
        <sourceAppLids>
          <string>string</string>
          <string>string</string>
        </sourceAppLids>
        <targetAppLids>
          <string>string</string>
          <string>string</string>
        </targetAppLids>
        <steps>
          <Step>
            <name>string</name>
            <description>string</description>
            <stepId>string</stepId>
            <parentStepId>string</parentStepId>
            <tasks xsi:nil="true" />
          </Step>
          <Step>
            <name>string</name>
            <description>string</description>
            <stepId>string</stepId>
            <parentStepId>string</parentStepId>
            <tasks xsi:nil="true" />
          </Step>
        </steps>
        <schedules>
          <Schedule>
            <scheduleId>string</scheduleId>
            <enabled>boolean</enabled>
            <timeZone>string</timeZone>
            <cronExpression>string</cronExpression>
          </Schedule>
          <Schedule>
            <scheduleId>string</scheduleId>
            <enabled>boolean</enabled>
            <timeZone>string</timeZone>
            <cronExpression>string</cronExpression>
          </Schedule>
        </schedules>
        <notificationEmailIds>
          <string>string</string>
          <string>string</string>
        </notificationEmailIds>
      </getWorkflowByIdResult>
    </getWorkflowByIdResponse>
  </soap12:Body>
</soap12:Envelope>

importCubeMetaDataIntoSpace

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/importCubeMetaDataIntoSpace"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <importCubeMetaDataIntoSpace xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <connectionName>string</connectionName>
      <databaseType>string</databaseType>
      <cubeName>string</cubeName>
      <importType>int</importType>
      <cacheable>boolean</cacheable>
    </importCubeMetaDataIntoSpace>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <importCubeMetaDataIntoSpaceResponse xmlns="http://www.birst.com/">
      <importCubeMetaDataIntoSpaceResult>boolean</importCubeMetaDataIntoSpaceResult>
    </importCubeMetaDataIntoSpaceResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <importCubeMetaDataIntoSpace xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <connectionName>string</connectionName>
      <databaseType>string</databaseType>
      <cubeName>string</cubeName>
      <importType>int</importType>
      <cacheable>boolean</cacheable>
    </importCubeMetaDataIntoSpace>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <importCubeMetaDataIntoSpaceResponse xmlns="http://www.birst.com/">
      <importCubeMetaDataIntoSpaceResult>boolean</importCubeMetaDataIntoSpaceResult>
    </importCubeMetaDataIntoSpaceResponse>
  </soap12:Body>
</soap12:Envelope>

importPackage

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/importPackage"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <importPackage xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceFromID>string</spaceFromID>
      <packageName>string</packageName>
      <spaceToID>string</spaceToID>
    </importPackage>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <importPackageResponse xmlns="http://www.birst.com/">
      <importPackageResult>
        <string>string</string>
        <string>string</string>
      </importPackageResult>
    </importPackageResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <importPackage xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceFromID>string</spaceFromID>
      <packageName>string</packageName>
      <spaceToID>string</spaceToID>
    </importPackage>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <importPackageResponse xmlns="http://www.birst.com/">
      <importPackageResult>
        <string>string</string>
        <string>string</string>
      </importPackageResult>
    </importPackageResponse>
  </soap12:Body>
</soap12:Envelope>

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.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/isDataUploadComplete"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <isDataUploadComplete xmlns="http://www.birst.com/">
      <token>string</token>
      <dataUploadToken>string</dataUploadToken>
    </isDataUploadComplete>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <isDataUploadCompleteResponse xmlns="http://www.birst.com/">
      <isDataUploadCompleteResult>boolean</isDataUploadCompleteResult>
    </isDataUploadCompleteResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <isDataUploadComplete xmlns="http://www.birst.com/">
      <token>string</token>
      <dataUploadToken>string</dataUploadToken>
    </isDataUploadComplete>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <isDataUploadCompleteResponse xmlns="http://www.birst.com/">
      <isDataUploadCompleteResult>boolean</isDataUploadCompleteResult>
    </isDataUploadCompleteResponse>
  </soap12:Body>
</soap12:Envelope>

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.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/isJobComplete"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <isJobComplete xmlns="http://www.birst.com/">
      <token>string</token>
      <jobToken>string</jobToken>
    </isJobComplete>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <isJobCompleteResponse xmlns="http://www.birst.com/">
      <isJobCompleteResult>boolean</isJobCompleteResult>
    </isJobCompleteResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <isJobComplete xmlns="http://www.birst.com/">
      <token>string</token>
      <jobToken>string</jobToken>
    </isJobComplete>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <isJobCompleteResponse xmlns="http://www.birst.com/">
      <isJobCompleteResult>boolean</isJobCompleteResult>
    </isJobCompleteResponse>
  </soap12:Body>
</soap12:Envelope>

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.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/isPublishingComplete"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <isPublishingComplete xmlns="http://www.birst.com/">
      <token>string</token>
      <publishingToken>string</publishingToken>
    </isPublishingComplete>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <isPublishingCompleteResponse xmlns="http://www.birst.com/">
      <isPublishingCompleteResult>boolean</isPublishingCompleteResult>
    </isPublishingCompleteResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <isPublishingComplete xmlns="http://www.birst.com/">
      <token>string</token>
      <publishingToken>string</publishingToken>
    </isPublishingComplete>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <isPublishingCompleteResponse xmlns="http://www.birst.com/">
      <isPublishingCompleteResult>boolean</isPublishingCompleteResult>
    </isPublishingCompleteResponse>
  </soap12:Body>
</soap12:Envelope>

isWdcAvailable

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/isWdcAvailable"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <isWdcAvailable xmlns="http://www.birst.com/">
      <token>string</token>
    </isWdcAvailable>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <isWdcAvailableResponse xmlns="http://www.birst.com/">
      <isWdcAvailableResult>boolean</isWdcAvailableResult>
    </isWdcAvailableResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <isWdcAvailable xmlns="http://www.birst.com/">
      <token>string</token>
    </isWdcAvailable>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <isWdcAvailableResponse xmlns="http://www.birst.com/">
      <isWdcAvailableResult>boolean</isWdcAvailableResult>
    </isWdcAvailableResponse>
  </soap12:Body>
</soap12:Envelope>

linkProfileToAccount

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/linkProfileToAccount"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <linkProfileToAccount xmlns="http://www.birst.com/">
      <token>string</token>
      <profileID>string</profileID>
    </linkProfileToAccount>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <linkProfileToAccountResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <linkProfileToAccount xmlns="http://www.birst.com/">
      <token>string</token>
      <profileID>string</profileID>
    </linkProfileToAccount>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <linkProfileToAccountResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

linkProfileToUsers

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/linkProfileToUsers"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <linkProfileToUsers xmlns="http://www.birst.com/">
      <token>string</token>
      <userProfileList>
        <UserProfileMapping>
          <userName>string</userName>
          <profileId>string</profileId>
        </UserProfileMapping>
        <UserProfileMapping>
          <userName>string</userName>
          <profileId>string</profileId>
        </UserProfileMapping>
      </userProfileList>
    </linkProfileToUsers>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <linkProfileToUsersResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <linkProfileToUsers xmlns="http://www.birst.com/">
      <token>string</token>
      <userProfileList>
        <UserProfileMapping>
          <userName>string</userName>
          <profileId>string</profileId>
        </UserProfileMapping>
        <UserProfileMapping>
          <userName>string</userName>
          <profileId>string</profileId>
        </UserProfileMapping>
      </userProfileList>
    </linkProfileToUsers>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <linkProfileToUsersResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

listAllManagedUsers

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/listAllManagedUsers"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <listAllManagedUsers xmlns="http://www.birst.com/">
      <token>string</token>
    </listAllManagedUsers>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <listAllManagedUsersResponse xmlns="http://www.birst.com/">
      <listAllManagedUsersResult>
        <ArrayOfString>
          <string>string</string>
          <string>string</string>
        </ArrayOfString>
        <ArrayOfString>
          <string>string</string>
          <string>string</string>
        </ArrayOfString>
      </listAllManagedUsersResult>
    </listAllManagedUsersResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <listAllManagedUsers xmlns="http://www.birst.com/">
      <token>string</token>
    </listAllManagedUsers>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <listAllManagedUsersResponse xmlns="http://www.birst.com/">
      <listAllManagedUsersResult>
        <ArrayOfString>
          <string>string</string>
          <string>string</string>
        </ArrayOfString>
        <ArrayOfString>
          <string>string</string>
          <string>string</string>
        </ArrayOfString>
      </listAllManagedUsersResult>
    </listAllManagedUsersResponse>
  </soap12:Body>
</soap12:Envelope>

listAllSpaces

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/listAllSpaces"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <listAllSpaces xmlns="http://www.birst.com/">
      <token>string</token>
    </listAllSpaces>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <listAllSpacesResponse xmlns="http://www.birst.com/">
      <listAllSpacesResult>
        <UserSpace>
          <name>string</name>
          <owner>string</owner>
          <id>string</id>
        </UserSpace>
        <UserSpace>
          <name>string</name>
          <owner>string</owner>
          <id>string</id>
        </UserSpace>
      </listAllSpacesResult>
    </listAllSpacesResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <listAllSpaces xmlns="http://www.birst.com/">
      <token>string</token>
    </listAllSpaces>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <listAllSpacesResponse xmlns="http://www.birst.com/">
      <listAllSpacesResult>
        <UserSpace>
          <name>string</name>
          <owner>string</owner>
          <id>string</id>
        </UserSpace>
        <UserSpace>
          <name>string</name>
          <owner>string</owner>
          <id>string</id>
        </UserSpace>
      </listAllSpacesResult>
    </listAllSpacesResponse>
  </soap12:Body>
</soap12:Envelope>

listAllowedIPAddrsForAccount

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/listAllowedIPAddrsForAccount"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <listAllowedIPAddrsForAccount xmlns="http://www.birst.com/">
      <token>string</token>
    </listAllowedIPAddrsForAccount>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <listAllowedIPAddrsForAccountResponse xmlns="http://www.birst.com/">
      <listAllowedIPAddrsForAccountResult>
        <string>string</string>
        <string>string</string>
      </listAllowedIPAddrsForAccountResult>
    </listAllowedIPAddrsForAccountResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <listAllowedIPAddrsForAccount xmlns="http://www.birst.com/">
      <token>string</token>
    </listAllowedIPAddrsForAccount>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <listAllowedIPAddrsForAccountResponse xmlns="http://www.birst.com/">
      <listAllowedIPAddrsForAccountResult>
        <string>string</string>
        <string>string</string>
      </listAllowedIPAddrsForAccountResult>
    </listAllowedIPAddrsForAccountResponse>
  </soap12:Body>
</soap12:Envelope>

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.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/listAllowedIps"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <listAllowedIps xmlns="http://www.birst.com/">
      <token>string</token>
      <userName>string</userName>
    </listAllowedIps>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <listAllowedIpsResponse xmlns="http://www.birst.com/">
      <listAllowedIpsResult>
        <string>string</string>
        <string>string</string>
      </listAllowedIpsResult>
    </listAllowedIpsResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <listAllowedIps xmlns="http://www.birst.com/">
      <token>string</token>
      <userName>string</userName>
    </listAllowedIps>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <listAllowedIpsResponse xmlns="http://www.birst.com/">
      <listAllowedIpsResult>
        <string>string</string>
        <string>string</string>
      </listAllowedIpsResult>
    </listAllowedIpsResponse>
  </soap12:Body>
</soap12:Envelope>

listCloudConnections

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/listCloudConnections"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <listCloudConnections xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <accountID>string</accountID>
    </listCloudConnections>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <listCloudConnectionsResponse xmlns="http://www.birst.com/">
      <listCloudConnectionsResult>
        <CloudCon>
          <name>string</name>
          <guid>string</guid>
          <connectorType>string</connectorType>
          <connectorAPIVersion>string</connectorAPIVersion>
          <connectionProperties>
            <ConnectionProperty xsi:nil="true" />
            <ConnectionProperty xsi:nil="true" />
          </connectionProperties>
          <dateCreated>long</dateCreated>
          <dateModified>long</dateModified>
          <createdBy>string</createdBy>
          <modifiedBy>string</modifiedBy>
          <startExtractionTime>long</startExtractionTime>
          <endExtractionTime>long</endExtractionTime>
          <migratedConnection>string</migratedConnection>
          <objectsConfigured>boolean</objectsConfigured>
          <onPremise>boolean</onPremise>
          <liveAccess>boolean</liveAccess>
          <restricted>boolean</restricted>
          <shared>boolean</shared>
          <datasourceId>string</datasourceId>
          <agentIDs>
            <string>string</string>
            <string>string</string>
          </agentIDs>
          <agentGroup>string</agentGroup>
        </CloudCon>
        <CloudCon>
          <name>string</name>
          <guid>string</guid>
          <connectorType>string</connectorType>
          <connectorAPIVersion>string</connectorAPIVersion>
          <connectionProperties>
            <ConnectionProperty xsi:nil="true" />
            <ConnectionProperty xsi:nil="true" />
          </connectionProperties>
          <dateCreated>long</dateCreated>
          <dateModified>long</dateModified>
          <createdBy>string</createdBy>
          <modifiedBy>string</modifiedBy>
          <startExtractionTime>long</startExtractionTime>
          <endExtractionTime>long</endExtractionTime>
          <migratedConnection>string</migratedConnection>
          <objectsConfigured>boolean</objectsConfigured>
          <onPremise>boolean</onPremise>
          <liveAccess>boolean</liveAccess>
          <restricted>boolean</restricted>
          <shared>boolean</shared>
          <datasourceId>string</datasourceId>
          <agentIDs>
            <string>string</string>
            <string>string</string>
          </agentIDs>
          <agentGroup>string</agentGroup>
        </CloudCon>
      </listCloudConnectionsResult>
    </listCloudConnectionsResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <listCloudConnections xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <accountID>string</accountID>
    </listCloudConnections>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <listCloudConnectionsResponse xmlns="http://www.birst.com/">
      <listCloudConnectionsResult>
        <CloudCon>
          <name>string</name>
          <guid>string</guid>
          <connectorType>string</connectorType>
          <connectorAPIVersion>string</connectorAPIVersion>
          <connectionProperties>
            <ConnectionProperty xsi:nil="true" />
            <ConnectionProperty xsi:nil="true" />
          </connectionProperties>
          <dateCreated>long</dateCreated>
          <dateModified>long</dateModified>
          <createdBy>string</createdBy>
          <modifiedBy>string</modifiedBy>
          <startExtractionTime>long</startExtractionTime>
          <endExtractionTime>long</endExtractionTime>
          <migratedConnection>string</migratedConnection>
          <objectsConfigured>boolean</objectsConfigured>
          <onPremise>boolean</onPremise>
          <liveAccess>boolean</liveAccess>
          <restricted>boolean</restricted>
          <shared>boolean</shared>
          <datasourceId>string</datasourceId>
          <agentIDs>
            <string>string</string>
            <string>string</string>
          </agentIDs>
          <agentGroup>string</agentGroup>
        </CloudCon>
        <CloudCon>
          <name>string</name>
          <guid>string</guid>
          <connectorType>string</connectorType>
          <connectorAPIVersion>string</connectorAPIVersion>
          <connectionProperties>
            <ConnectionProperty xsi:nil="true" />
            <ConnectionProperty xsi:nil="true" />
          </connectionProperties>
          <dateCreated>long</dateCreated>
          <dateModified>long</dateModified>
          <createdBy>string</createdBy>
          <modifiedBy>string</modifiedBy>
          <startExtractionTime>long</startExtractionTime>
          <endExtractionTime>long</endExtractionTime>
          <migratedConnection>string</migratedConnection>
          <objectsConfigured>boolean</objectsConfigured>
          <onPremise>boolean</onPremise>
          <liveAccess>boolean</liveAccess>
          <restricted>boolean</restricted>
          <shared>boolean</shared>
          <datasourceId>string</datasourceId>
          <agentIDs>
            <string>string</string>
            <string>string</string>
          </agentIDs>
          <agentGroup>string</agentGroup>
        </CloudCon>
      </listCloudConnectionsResult>
    </listCloudConnectionsResponse>
  </soap12:Body>
</soap12:Envelope>

listCreatedUsers

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/listCreatedUsers"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <listCreatedUsers xmlns="http://www.birst.com/">
      <token>string</token>
    </listCreatedUsers>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <listCreatedUsersResponse xmlns="http://www.birst.com/">
      <listCreatedUsersResult>
        <string>string</string>
        <string>string</string>
      </listCreatedUsersResult>
    </listCreatedUsersResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <listCreatedUsers xmlns="http://www.birst.com/">
      <token>string</token>
    </listCreatedUsers>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <listCreatedUsersResponse xmlns="http://www.birst.com/">
      <listCreatedUsersResult>
        <string>string</string>
        <string>string</string>
      </listCreatedUsersResult>
    </listCreatedUsersResponse>
  </soap12:Body>
</soap12:Envelope>

listCustomSubjectAreas

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/listCustomSubjectAreas"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <listCustomSubjectAreas xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
    </listCustomSubjectAreas>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <listCustomSubjectAreasResponse xmlns="http://www.birst.com/">
      <listCustomSubjectAreasResult>
        <string>string</string>
        <string>string</string>
      </listCustomSubjectAreasResult>
    </listCustomSubjectAreasResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <listCustomSubjectAreas xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
    </listCustomSubjectAreas>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <listCustomSubjectAreasResponse xmlns="http://www.birst.com/">
      <listCustomSubjectAreasResult>
        <string>string</string>
        <string>string</string>
      </listCustomSubjectAreasResult>
    </listCustomSubjectAreasResponse>
  </soap12:Body>
</soap12:Envelope>

listEmailDomains

Lists email domains

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/listEmailDomains"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <listEmailDomains xmlns="http://www.birst.com/">
      <token>string</token>
    </listEmailDomains>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <listEmailDomainsResponse xmlns="http://www.birst.com/">
      <listEmailDomainsResult>
        <EmailDomain>
          <id>string</id>
          <accountId>string</accountId>
          <domain>string</domain>
          <createdDate>dateTime</createdDate>
          <modifiedDate>dateTime</modifiedDate>
        </EmailDomain>
        <EmailDomain>
          <id>string</id>
          <accountId>string</accountId>
          <domain>string</domain>
          <createdDate>dateTime</createdDate>
          <modifiedDate>dateTime</modifiedDate>
        </EmailDomain>
      </listEmailDomainsResult>
    </listEmailDomainsResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <listEmailDomains xmlns="http://www.birst.com/">
      <token>string</token>
    </listEmailDomains>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <listEmailDomainsResponse xmlns="http://www.birst.com/">
      <listEmailDomainsResult>
        <EmailDomain>
          <id>string</id>
          <accountId>string</accountId>
          <domain>string</domain>
          <createdDate>dateTime</createdDate>
          <modifiedDate>dateTime</modifiedDate>
        </EmailDomain>
        <EmailDomain>
          <id>string</id>
          <accountId>string</accountId>
          <domain>string</domain>
          <createdDate>dateTime</createdDate>
          <modifiedDate>dateTime</modifiedDate>
        </EmailDomain>
      </listEmailDomainsResult>
    </listEmailDomainsResponse>
  </soap12:Body>
</soap12:Envelope>

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.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/listGroupAclsInSpace"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <listGroupAclsInSpace xmlns="http://www.birst.com/">
      <token>string</token>
      <groupName>string</groupName>
      <spaceID>string</spaceID>
    </listGroupAclsInSpace>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <listGroupAclsInSpaceResponse xmlns="http://www.birst.com/">
      <listGroupAclsInSpaceResult>
        <string>string</string>
        <string>string</string>
      </listGroupAclsInSpaceResult>
    </listGroupAclsInSpaceResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <listGroupAclsInSpace xmlns="http://www.birst.com/">
      <token>string</token>
      <groupName>string</groupName>
      <spaceID>string</spaceID>
    </listGroupAclsInSpace>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <listGroupAclsInSpaceResponse xmlns="http://www.birst.com/">
      <listGroupAclsInSpaceResult>
        <string>string</string>
        <string>string</string>
      </listGroupAclsInSpaceResult>
    </listGroupAclsInSpaceResponse>
  </soap12:Body>
</soap12:Envelope>

listGroupsInSpace

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/listGroupsInSpace"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <listGroupsInSpace xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
    </listGroupsInSpace>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <listGroupsInSpaceResponse xmlns="http://www.birst.com/">
      <listGroupsInSpaceResult>
        <string>string</string>
        <string>string</string>
      </listGroupsInSpaceResult>
    </listGroupsInSpaceResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <listGroupsInSpace xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
    </listGroupsInSpace>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <listGroupsInSpaceResponse xmlns="http://www.birst.com/">
      <listGroupsInSpaceResult>
        <string>string</string>
        <string>string</string>
      </listGroupsInSpaceResult>
    </listGroupsInSpaceResponse>
  </soap12:Body>
</soap12:Envelope>

listLanguages

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/listLanguages"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <listLanguages xmlns="http://www.birst.com/">
      <token>string</token>
    </listLanguages>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <listLanguagesResponse xmlns="http://www.birst.com/">
      <listLanguagesResult>
        <Language>
          <code>string</code>
          <description>string</description>
        </Language>
        <Language>
          <code>string</code>
          <description>string</description>
        </Language>
      </listLanguagesResult>
    </listLanguagesResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <listLanguages xmlns="http://www.birst.com/">
      <token>string</token>
    </listLanguages>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <listLanguagesResponse xmlns="http://www.birst.com/">
      <listLanguagesResult>
        <Language>
          <code>string</code>
          <description>string</description>
        </Language>
        <Language>
          <code>string</code>
          <description>string</description>
        </Language>
      </listLanguagesResult>
    </listLanguagesResponse>
  </soap12:Body>
</soap12:Envelope>

listManagedUsers

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/listManagedUsers"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <listManagedUsers xmlns="http://www.birst.com/">
      <token>string</token>
    </listManagedUsers>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <listManagedUsersResponse xmlns="http://www.birst.com/">
      <listManagedUsersResult>
        <string>string</string>
        <string>string</string>
      </listManagedUsersResult>
    </listManagedUsersResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <listManagedUsers xmlns="http://www.birst.com/">
      <token>string</token>
    </listManagedUsers>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <listManagedUsersResponse xmlns="http://www.birst.com/">
      <listManagedUsersResult>
        <string>string</string>
        <string>string</string>
      </listManagedUsersResult>
    </listManagedUsersResponse>
  </soap12:Body>
</soap12:Envelope>

listOpenIDs

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/listOpenIDs"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <listOpenIDs xmlns="http://www.birst.com/">
      <token>string</token>
      <userName>string</userName>
    </listOpenIDs>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <listOpenIDsResponse xmlns="http://www.birst.com/">
      <listOpenIDsResult>
        <string>string</string>
        <string>string</string>
      </listOpenIDsResult>
    </listOpenIDsResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <listOpenIDs xmlns="http://www.birst.com/">
      <token>string</token>
      <userName>string</userName>
    </listOpenIDs>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <listOpenIDsResponse xmlns="http://www.birst.com/">
      <listOpenIDsResult>
        <string>string</string>
        <string>string</string>
      </listOpenIDsResult>
    </listOpenIDsResponse>
  </soap12:Body>
</soap12:Envelope>

listProfiles

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/listProfiles"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <listProfiles xmlns="http://www.birst.com/">
      <token>string</token>
    </listProfiles>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <listProfilesResponse xmlns="http://www.birst.com/">
      <listProfilesResult>
        <Profile>
          <id>string</id>
          <name>string</name>
          <description>string</description>
          <isDefault>string</isDefault>
          <properties>
            <ProfileProperty xsi:nil="true" />
            <ProfileProperty xsi:nil="true" />
          </properties>
        </Profile>
        <Profile>
          <id>string</id>
          <name>string</name>
          <description>string</description>
          <isDefault>string</isDefault>
          <properties>
            <ProfileProperty xsi:nil="true" />
            <ProfileProperty xsi:nil="true" />
          </properties>
        </Profile>
      </listProfilesResult>
    </listProfilesResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <listProfiles xmlns="http://www.birst.com/">
      <token>string</token>
    </listProfiles>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <listProfilesResponse xmlns="http://www.birst.com/">
      <listProfilesResult>
        <Profile>
          <id>string</id>
          <name>string</name>
          <description>string</description>
          <isDefault>string</isDefault>
          <properties>
            <ProfileProperty xsi:nil="true" />
            <ProfileProperty xsi:nil="true" />
          </properties>
        </Profile>
        <Profile>
          <id>string</id>
          <name>string</name>
          <description>string</description>
          <isDefault>string</isDefault>
          <properties>
            <ProfileProperty xsi:nil="true" />
            <ProfileProperty xsi:nil="true" />
          </properties>
        </Profile>
      </listProfilesResult>
    </listProfilesResponse>
  </soap12:Body>
</soap12:Envelope>

listProxyUsers

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/listProxyUsers"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <listProxyUsers xmlns="http://www.birst.com/">
      <token>string</token>
      <userName>string</userName>
    </listProxyUsers>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <listProxyUsersResponse xmlns="http://www.birst.com/">
      <listProxyUsersResult>
        <string>string</string>
        <string>string</string>
      </listProxyUsersResult>
    </listProxyUsersResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <listProxyUsers xmlns="http://www.birst.com/">
      <token>string</token>
      <userName>string</userName>
    </listProxyUsers>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <listProxyUsersResponse xmlns="http://www.birst.com/">
      <listProxyUsersResult>
        <string>string</string>
        <string>string</string>
      </listProxyUsersResult>
    </listProxyUsersResponse>
  </soap12:Body>
</soap12:Envelope>

listReleases

Lists all releases. Argument is the Login token.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/listReleases"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <listReleases xmlns="http://www.birst.com/">
      <token>string</token>
    </listReleases>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <listReleasesResponse xmlns="http://www.birst.com/">
      <listReleasesResult>
        <string>string</string>
        <string>string</string>
      </listReleasesResult>
    </listReleasesResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <listReleases xmlns="http://www.birst.com/">
      <token>string</token>
    </listReleases>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <listReleasesResponse xmlns="http://www.birst.com/">
      <listReleasesResult>
        <string>string</string>
        <string>string</string>
      </listReleasesResult>
    </listReleasesResponse>
  </soap12:Body>
</soap12:Envelope>

listSpaces

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/listSpaces"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <listSpaces xmlns="http://www.birst.com/">
      <token>string</token>
    </listSpaces>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <listSpacesResponse xmlns="http://www.birst.com/">
      <listSpacesResult>
        <UserSpace>
          <name>string</name>
          <owner>string</owner>
          <id>string</id>
        </UserSpace>
        <UserSpace>
          <name>string</name>
          <owner>string</owner>
          <id>string</id>
        </UserSpace>
      </listSpacesResult>
    </listSpacesResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <listSpaces xmlns="http://www.birst.com/">
      <token>string</token>
    </listSpaces>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <listSpacesResponse xmlns="http://www.birst.com/">
      <listSpacesResult>
        <UserSpace>
          <name>string</name>
          <owner>string</owner>
          <id>string</id>
        </UserSpace>
        <UserSpace>
          <name>string</name>
          <owner>string</owner>
          <id>string</id>
        </UserSpace>
      </listSpacesResult>
    </listSpacesResponse>
  </soap12:Body>
</soap12:Envelope>

listUserGroupMembership

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/listUserGroupMembership"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <listUserGroupMembership xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <userName>string</userName>
      <includeInternalGroups>boolean</includeInternalGroups>
    </listUserGroupMembership>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <listUserGroupMembershipResponse xmlns="http://www.birst.com/">
      <listUserGroupMembershipResult>
        <string>string</string>
        <string>string</string>
      </listUserGroupMembershipResult>
    </listUserGroupMembershipResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <listUserGroupMembership xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <userName>string</userName>
      <includeInternalGroups>boolean</includeInternalGroups>
    </listUserGroupMembership>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <listUserGroupMembershipResponse xmlns="http://www.birst.com/">
      <listUserGroupMembershipResult>
        <string>string</string>
        <string>string</string>
      </listUserGroupMembershipResult>
    </listUserGroupMembershipResponse>
  </soap12:Body>
</soap12:Envelope>

listUsersInGroupInSpace

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/listUsersInGroupInSpace"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <listUsersInGroupInSpace xmlns="http://www.birst.com/">
      <token>string</token>
      <groupName>string</groupName>
      <spaceID>string</spaceID>
    </listUsersInGroupInSpace>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <listUsersInGroupInSpaceResponse xmlns="http://www.birst.com/">
      <listUsersInGroupInSpaceResult>
        <string>string</string>
        <string>string</string>
      </listUsersInGroupInSpaceResult>
    </listUsersInGroupInSpaceResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <listUsersInGroupInSpace xmlns="http://www.birst.com/">
      <token>string</token>
      <groupName>string</groupName>
      <spaceID>string</spaceID>
    </listUsersInGroupInSpace>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <listUsersInGroupInSpaceResponse xmlns="http://www.birst.com/">
      <listUsersInGroupInSpaceResult>
        <string>string</string>
        <string>string</string>
      </listUsersInGroupInSpaceResult>
    </listUsersInGroupInSpaceResponse>
  </soap12:Body>
</soap12:Envelope>

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.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/listUsersInSpace"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <listUsersInSpace xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
    </listUsersInSpace>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <listUsersInSpaceResponse xmlns="http://www.birst.com/">
      <listUsersInSpaceResult>
        <string>string</string>
        <string>string</string>
      </listUsersInSpaceResult>
    </listUsersInSpaceResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <listUsersInSpace xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
    </listUsersInSpace>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <listUsersInSpaceResponse xmlns="http://www.birst.com/">
      <listUsersInSpaceResult>
        <string>string</string>
        <string>string</string>
      </listUsersInSpaceResult>
    </listUsersInSpaceResponse>
  </soap12:Body>
</soap12:Envelope>

loadStagingtableFromS3Bucket

Direct Loads Stagingtable from S3 bucket

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/loadStagingtableFromS3Bucket"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <loadStagingtableFromS3Bucket xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <stagingDetails>
        <stagingTableName>string</stagingTableName>
        <sourceS3Path>string</sourceS3Path>
        <delimiter>string</delimiter>
        <columnNames>
          <string>string</string>
          <string>string</string>
        </columnNames>
        <awsKeyID>string</awsKeyID>
        <awsSecretKey>string</awsSecretKey>
        <awsTempToken>string</awsTempToken>
        <encryptionKey>string</encryptionKey>
        <dateFormat>string</dateFormat>
        <compressionFormat>string</compressionFormat>
        <ignoreHeaders>int</ignoreHeaders>
        <keepQuotes>boolean</keepQuotes>
        <skipEscape>boolean</skipEscape>
      </stagingDetails>
    </loadStagingtableFromS3Bucket>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <loadStagingtableFromS3BucketResponse xmlns="http://www.birst.com/">
      <loadStagingtableFromS3BucketResult>string</loadStagingtableFromS3BucketResult>
    </loadStagingtableFromS3BucketResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <loadStagingtableFromS3Bucket xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <stagingDetails>
        <stagingTableName>string</stagingTableName>
        <sourceS3Path>string</sourceS3Path>
        <delimiter>string</delimiter>
        <columnNames>
          <string>string</string>
          <string>string</string>
        </columnNames>
        <awsKeyID>string</awsKeyID>
        <awsSecretKey>string</awsSecretKey>
        <awsTempToken>string</awsTempToken>
        <encryptionKey>string</encryptionKey>
        <dateFormat>string</dateFormat>
        <compressionFormat>string</compressionFormat>
        <ignoreHeaders>int</ignoreHeaders>
        <keepQuotes>boolean</keepQuotes>
        <skipEscape>boolean</skipEscape>
      </stagingDetails>
    </loadStagingtableFromS3Bucket>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <loadStagingtableFromS3BucketResponse xmlns="http://www.birst.com/">
      <loadStagingtableFromS3BucketResult>string</loadStagingtableFromS3BucketResult>
    </loadStagingtableFromS3BucketResponse>
  </soap12:Body>
</soap12:Envelope>

mapAgentsToConnections

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/mapAgentsToConnections"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <mapAgentsToConnections xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <connectionAgentsMappings>
        <ConnectionAgentsMapping>
          <connectionId>string</connectionId>
          <agentIds>
            <string>string</string>
            <string>string</string>
          </agentIds>
          <spaceId>string</spaceId>
        </ConnectionAgentsMapping>
        <ConnectionAgentsMapping>
          <connectionId>string</connectionId>
          <agentIds>
            <string>string</string>
            <string>string</string>
          </agentIds>
          <spaceId>string</spaceId>
        </ConnectionAgentsMapping>
      </connectionAgentsMappings>
    </mapAgentsToConnections>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <mapAgentsToConnectionsResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <mapAgentsToConnections xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <connectionAgentsMappings>
        <ConnectionAgentsMapping>
          <connectionId>string</connectionId>
          <agentIds>
            <string>string</string>
            <string>string</string>
          </agentIds>
          <spaceId>string</spaceId>
        </ConnectionAgentsMapping>
        <ConnectionAgentsMapping>
          <connectionId>string</connectionId>
          <agentIds>
            <string>string</string>
            <string>string</string>
          </agentIds>
          <spaceId>string</spaceId>
        </ConnectionAgentsMapping>
      </connectionAgentsMappings>
    </mapAgentsToConnections>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <mapAgentsToConnectionsResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

mapLiveAccessSource

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/mapLiveAccessSource"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <mapLiveAccessSource xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <sourceMetadata>
        <Connection>string</Connection>
        <SourceName>string</SourceName>
        <IsQuerySource>boolean</IsQuerySource>
        <PhysicalTableName>string</PhysicalTableName>
        <Query>string</Query>
        <SchemaName>string</SchemaName>
      </sourceMetadata>
    </mapLiveAccessSource>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <mapLiveAccessSourceResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <mapLiveAccessSource xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <sourceMetadata>
        <Connection>string</Connection>
        <SourceName>string</SourceName>
        <IsQuerySource>boolean</IsQuerySource>
        <PhysicalTableName>string</PhysicalTableName>
        <Query>string</Query>
        <SchemaName>string</SchemaName>
      </sourceMetadata>
    </mapLiveAccessSource>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <mapLiveAccessSourceResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

migrateLAConnectionToBC2

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/migrateLAConnectionToBC2"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <migrateLAConnectionToBC2 xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceId>string</spaceId>
      <connectionName>string</connectionName>
      <agentName>string</agentName>
    </migrateLAConnectionToBC2>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <migrateLAConnectionToBC2Response xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <migrateLAConnectionToBC2 xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceId>string</spaceId>
      <connectionName>string</connectionName>
      <agentName>string</agentName>
    </migrateLAConnectionToBC2>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <migrateLAConnectionToBC2Response xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

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.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/migrateSpace"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <migrateSpace xmlns="http://www.birst.com/">
      <token>string</token>
      <spFromID>string</spFromID>
      <spToID>string</spToID>
    </migrateSpace>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <migrateSpaceResponse xmlns="http://www.birst.com/">
      <migrateSpaceResult>string</migrateSpaceResult>
    </migrateSpaceResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <migrateSpace xmlns="http://www.birst.com/">
      <token>string</token>
      <spFromID>string</spFromID>
      <spToID>string</spToID>
    </migrateSpace>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <migrateSpaceResponse xmlns="http://www.birst.com/">
      <migrateSpaceResult>string</migrateSpaceResult>
    </migrateSpaceResponse>
  </soap12:Body>
</soap12:Envelope>

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.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/modifyRealTimeConnectionInformation"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <modifyRealTimeConnectionInformation xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <configFileName>string</configFileName>
      <connectionName>string</connectionName>
      <host>string</host>
      <port>int</port>
      <databaseName>string</databaseName>
      <userName>string</userName>
      <password>string</password>
      <timeout>int</timeout>
    </modifyRealTimeConnectionInformation>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <modifyRealTimeConnectionInformationResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <modifyRealTimeConnectionInformation xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <configFileName>string</configFileName>
      <connectionName>string</connectionName>
      <host>string</host>
      <port>int</port>
      <databaseName>string</databaseName>
      <userName>string</userName>
      <password>string</password>
      <timeout>int</timeout>
    </modifyRealTimeConnectionInformation>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <modifyRealTimeConnectionInformationResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

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.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/publishData"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <publishData xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <subgroups>
        <string>string</string>
        <string>string</string>
      </subgroups>
      <date>dateTime</date>
    </publishData>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <publishDataResponse xmlns="http://www.birst.com/">
      <publishDataResult>string</publishDataResult>
    </publishDataResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <publishData xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <subgroups>
        <string>string</string>
        <string>string</string>
      </subgroups>
      <date>dateTime</date>
    </publishData>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <publishDataResponse xmlns="http://www.birst.com/">
      <publishDataResult>string</publishDataResult>
    </publishDataResponse>
  </soap12:Body>
</soap12:Envelope>

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.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/queryMore"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <queryMore xmlns="http://www.birst.com/">
      <token>string</token>
      <queryToken>string</queryToken>
    </queryMore>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <queryMoreResponse xmlns="http://www.birst.com/">
      <queryMoreResult>
        <queryToken>string</queryToken>
        <numRowsReturned>int</numRowsReturned>
        <hasMoreRows>boolean</hasMoreRows>
      </queryMoreResult>
    </queryMoreResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <queryMore xmlns="http://www.birst.com/">
      <token>string</token>
      <queryToken>string</queryToken>
    </queryMore>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <queryMoreResponse xmlns="http://www.birst.com/">
      <queryMoreResult>
        <queryToken>string</queryToken>
        <numRowsReturned>int</numRowsReturned>
        <hasMoreRows>boolean</hasMoreRows>
      </queryMoreResult>
    </queryMoreResponse>
  </soap12:Body>
</soap12:Envelope>

rebuildIndices

Rebuilds Indices on the database.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/rebuildIndices"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <rebuildIndices xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
    </rebuildIndices>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <rebuildIndicesResponse xmlns="http://www.birst.com/">
      <rebuildIndicesResult>string</rebuildIndicesResult>
    </rebuildIndicesResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <rebuildIndices xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
    </rebuildIndices>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <rebuildIndicesResponse xmlns="http://www.birst.com/">
      <rebuildIndicesResult>string</rebuildIndicesResult>
    </rebuildIndicesResponse>
  </soap12:Body>
</soap12:Envelope>

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.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/registerBirstConnectAgent"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <registerBirstConnectAgent xmlns="http://www.birst.com/">
      <token>string</token>
      <name>string</name>
      <description>string</description>
      <userId>string</userId>
      <restricted>boolean</restricted>
      <agentGroup>string</agentGroup>
    </registerBirstConnectAgent>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <registerBirstConnectAgentResponse xmlns="http://www.birst.com/">
      <registerBirstConnectAgentResult>string</registerBirstConnectAgentResult>
    </registerBirstConnectAgentResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <registerBirstConnectAgent xmlns="http://www.birst.com/">
      <token>string</token>
      <name>string</name>
      <description>string</description>
      <userId>string</userId>
      <restricted>boolean</restricted>
      <agentGroup>string</agentGroup>
    </registerBirstConnectAgent>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <registerBirstConnectAgentResponse xmlns="http://www.birst.com/">
      <registerBirstConnectAgentResult>string</registerBirstConnectAgentResult>
    </registerBirstConnectAgentResponse>
  </soap12:Body>
</soap12:Envelope>

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.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/removeAclFromGroupInSpace"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <removeAclFromGroupInSpace xmlns="http://www.birst.com/">
      <token>string</token>
      <groupName>string</groupName>
      <aclTag>string</aclTag>
      <spaceID>string</spaceID>
    </removeAclFromGroupInSpace>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <removeAclFromGroupInSpaceResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <removeAclFromGroupInSpace xmlns="http://www.birst.com/">
      <token>string</token>
      <groupName>string</groupName>
      <aclTag>string</aclTag>
      <spaceID>string</spaceID>
    </removeAclFromGroupInSpace>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <removeAclFromGroupInSpaceResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

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.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/removeAllowedIPAddrForAccount"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <removeAllowedIPAddrForAccount xmlns="http://www.birst.com/">
      <token>string</token>
      <ip>string</ip>
    </removeAllowedIPAddrForAccount>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <removeAllowedIPAddrForAccountResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <removeAllowedIPAddrForAccount xmlns="http://www.birst.com/">
      <token>string</token>
      <ip>string</ip>
    </removeAllowedIPAddrForAccount>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <removeAllowedIPAddrForAccountResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

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.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/removeAllowedIp"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <removeAllowedIp xmlns="http://www.birst.com/">
      <token>string</token>
      <userName>string</userName>
      <ip>string</ip>
    </removeAllowedIp>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <removeAllowedIpResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <removeAllowedIp xmlns="http://www.birst.com/">
      <token>string</token>
      <userName>string</userName>
      <ip>string</ip>
    </removeAllowedIp>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <removeAllowedIpResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

removeEmailDomains

Removes email domains

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/removeEmailDomains"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <removeEmailDomains xmlns="http://www.birst.com/">
      <token>string</token>
    </removeEmailDomains>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <removeEmailDomainsResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <removeEmailDomains xmlns="http://www.birst.com/">
      <token>string</token>
    </removeEmailDomains>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <removeEmailDomainsResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

removeExpressionFromSubjectArea

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/removeExpressionFromSubjectArea"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <removeExpressionFromSubjectArea xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <expressionName>string</expressionName>
      <csaName>string</csaName>
      <location>string</location>
    </removeExpressionFromSubjectArea>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <removeExpressionFromSubjectAreaResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <removeExpressionFromSubjectArea xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <expressionName>string</expressionName>
      <csaName>string</csaName>
      <location>string</location>
    </removeExpressionFromSubjectArea>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <removeExpressionFromSubjectAreaResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

removeGroupFromSpace

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/removeGroupFromSpace"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <removeGroupFromSpace xmlns="http://www.birst.com/">
      <token>string</token>
      <groupName>string</groupName>
      <spaceID>string</spaceID>
    </removeGroupFromSpace>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <removeGroupFromSpaceResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <removeGroupFromSpace xmlns="http://www.birst.com/">
      <token>string</token>
      <groupName>string</groupName>
      <spaceID>string</spaceID>
    </removeGroupFromSpace>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <removeGroupFromSpaceResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

removeOpenID

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/removeOpenID"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <removeOpenID xmlns="http://www.birst.com/">
      <token>string</token>
      <userName>string</userName>
      <openID>string</openID>
    </removeOpenID>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <removeOpenIDResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <removeOpenID xmlns="http://www.birst.com/">
      <token>string</token>
      <userName>string</userName>
      <openID>string</openID>
    </removeOpenID>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <removeOpenIDResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

removeProductFromUser

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/removeProductFromUser"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <removeProductFromUser xmlns="http://www.birst.com/">
      <token>string</token>
      <userName>string</userName>
      <productId>int</productId>
    </removeProductFromUser>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <removeProductFromUserResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <removeProductFromUser xmlns="http://www.birst.com/">
      <token>string</token>
      <userName>string</userName>
      <productId>int</productId>
    </removeProductFromUser>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <removeProductFromUserResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

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.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/removeProxyUser"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <removeProxyUser xmlns="http://www.birst.com/">
      <token>string</token>
      <userName>string</userName>
      <proxyUserName>string</proxyUserName>
    </removeProxyUser>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <removeProxyUserResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <removeProxyUser xmlns="http://www.birst.com/">
      <token>string</token>
      <userName>string</userName>
      <proxyUserName>string</proxyUserName>
    </removeProxyUser>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <removeProxyUserResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

removeSfdcAccountMapping

Removes mapping of SFDC account to Birst account

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/removeSfdcAccountMapping"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <removeSfdcAccountMapping xmlns="http://www.birst.com/">
      <token>string</token>
      <sfdcOrgID>string</sfdcOrgID>
    </removeSfdcAccountMapping>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <removeSfdcAccountMappingResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <removeSfdcAccountMapping xmlns="http://www.birst.com/">
      <token>string</token>
      <sfdcOrgID>string</sfdcOrgID>
    </removeSfdcAccountMapping>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <removeSfdcAccountMappingResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

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.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/removeUserFromGroupInSpace"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <removeUserFromGroupInSpace xmlns="http://www.birst.com/">
      <token>string</token>
      <userName>string</userName>
      <groupName>string</groupName>
      <spaceID>string</spaceID>
    </removeUserFromGroupInSpace>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <removeUserFromGroupInSpaceResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <removeUserFromGroupInSpace xmlns="http://www.birst.com/">
      <token>string</token>
      <userName>string</userName>
      <groupName>string</groupName>
      <spaceID>string</spaceID>
    </removeUserFromGroupInSpace>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <removeUserFromGroupInSpaceResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

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.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/removeUserFromSpace"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <removeUserFromSpace xmlns="http://www.birst.com/">
      <token>string</token>
      <userName>string</userName>
      <spaceID>string</spaceID>
    </removeUserFromSpace>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <removeUserFromSpaceResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <removeUserFromSpace xmlns="http://www.birst.com/">
      <token>string</token>
      <userName>string</userName>
      <spaceID>string</spaceID>
    </removeUserFromSpace>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <removeUserFromSpaceResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

renameDashboard

Renames a dashboard. Arguments are the Login token, the space id, the old dashboard name and the new dashboard name

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/renameDashboard"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <renameDashboard xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <dashName>string</dashName>
      <newDashName>string</newDashName>
    </renameDashboard>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <renameDashboardResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <renameDashboard xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <dashName>string</dashName>
      <newDashName>string</newDashName>
    </renameDashboard>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <renameDashboardResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

renameDashboardPage

Renames a dashboard page. Arguments are the Login token, the space id, the dashboard name, the old page name and the new page name

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/renameDashboardPage"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <renameDashboardPage xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <dashName>string</dashName>
      <pageName>string</pageName>
      <newPageName>string</newPageName>
    </renameDashboardPage>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <renameDashboardPageResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <renameDashboardPage xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <dashName>string</dashName>
      <pageName>string</pageName>
      <newPageName>string</newPageName>
    </renameDashboardPage>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <renameDashboardPageResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

renameFileOrDirectory

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/renameFileOrDirectory"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <renameFileOrDirectory xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <fileOrDir>string</fileOrDir>
      <newName>string</newName>
    </renameFileOrDirectory>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <renameFileOrDirectoryResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <renameFileOrDirectory xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <fileOrDir>string</fileOrDir>
      <newName>string</newName>
    </renameFileOrDirectory>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <renameFileOrDirectoryResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

renameSubjectArea

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/renameSubjectArea"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <renameSubjectArea xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <name>string</name>
      <newName>string</newName>
    </renameSubjectArea>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <renameSubjectAreaResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <renameSubjectArea xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <name>string</name>
      <newName>string</newName>
    </renameSubjectArea>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <renameSubjectAreaResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

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.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/replaceExpressionInReport"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <replaceExpressionInReport xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <reportPath>string</reportPath>
      <reportName>string</reportName>
      <existingGlobalExpressionName>string</existingGlobalExpressionName>
      <newGlobalExpressionName>string</newGlobalExpressionName>
    </replaceExpressionInReport>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <replaceExpressionInReportResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <replaceExpressionInReport xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <reportPath>string</reportPath>
      <reportName>string</reportName>
      <existingGlobalExpressionName>string</existingGlobalExpressionName>
      <newGlobalExpressionName>string</newGlobalExpressionName>
    </replaceExpressionInReport>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <replaceExpressionInReportResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

repointConnection

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/repointConnection"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <repointConnection xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <fromConnectionId>string</fromConnectionId>
      <toConnectionId>string</toConnectionId>
    </repointConnection>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <repointConnectionResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <repointConnection xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <fromConnectionId>string</fromConnectionId>
      <toConnectionId>string</toConnectionId>
    </repointConnection>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <repointConnectionResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

repointNetworks

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/repointNetworks"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <repointNetworks xmlns="http://www.birst.com/">
      <token>string</token>
      <childSpaceId>string</childSpaceId>
      <existingParentSpaceId>string</existingParentSpaceId>
      <newParentSpaceId>string</newParentSpaceId>
    </repointNetworks>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <repointNetworksResponse xmlns="http://www.birst.com/">
      <repointNetworksResult>string</repointNetworksResult>
    </repointNetworksResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <repointNetworks xmlns="http://www.birst.com/">
      <token>string</token>
      <childSpaceId>string</childSpaceId>
      <existingParentSpaceId>string</existingParentSpaceId>
      <newParentSpaceId>string</newParentSpaceId>
    </repointNetworks>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <repointNetworksResponse xmlns="http://www.birst.com/">
      <repointNetworksResult>string</repointNetworksResult>
    </repointNetworksResponse>
  </soap12:Body>
</soap12:Envelope>

repointPackages

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/repointPackages"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <repointPackages xmlns="http://www.birst.com/">
      <token>string</token>
      <childSpaceId>string</childSpaceId>
      <existingParentSpaceId>string</existingParentSpaceId>
      <newParentSpaceId>string</newParentSpaceId>
    </repointPackages>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <repointPackagesResponse xmlns="http://www.birst.com/">
      <repointPackagesResult>string</repointPackagesResult>
    </repointPackagesResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <repointPackages xmlns="http://www.birst.com/">
      <token>string</token>
      <childSpaceId>string</childSpaceId>
      <existingParentSpaceId>string</existingParentSpaceId>
      <newParentSpaceId>string</newParentSpaceId>
    </repointPackages>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <repointPackagesResponse xmlns="http://www.birst.com/">
      <repointPackagesResult>string</repointPackagesResult>
    </repointPackagesResponse>
  </soap12:Body>
</soap12:Envelope>

resetPassword

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/resetPassword"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <resetPassword xmlns="http://www.birst.com/">
      <token>string</token>
      <username>string</username>
    </resetPassword>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <resetPasswordResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <resetPassword xmlns="http://www.birst.com/">
      <token>string</token>
      <username>string</username>
    </resetPassword>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <resetPasswordResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

resynchronizeSubjectAreas

Updates/Creates indexing data for subject areas

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/resynchronizeSubjectAreas"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <resynchronizeSubjectAreas xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
    </resynchronizeSubjectAreas>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <resynchronizeSubjectAreasResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <resynchronizeSubjectAreas xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
    </resynchronizeSubjectAreas>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <resynchronizeSubjectAreasResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

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.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/saveQueryReport"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <saveQueryReport xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <reportPath>string</reportPath>
      <reportName>string</reportName>
      <query>string</query>
    </saveQueryReport>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <saveQueryReportResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <saveQueryReport xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <reportPath>string</reportPath>
      <reportName>string</reportName>
      <query>string</query>
    </saveQueryReport>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <saveQueryReportResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

scheduleExportReport

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/scheduleExportReport"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <scheduleExportReport xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceId>string</spaceId>
      <reportPath>string</reportPath>
      <prompts>
        <applyAllPrompts>string</applyAllPrompts>
        <promptsArray>
          <Prompt>
            <ParameterName>string</ParameterName>
            <Operator>string</Operator>
            <IsExpression>string</IsExpression>
            <multiSelectType>string</multiSelectType>
            <selectedValues xsi:nil="true" />
          </Prompt>
          <Prompt>
            <ParameterName>string</ParameterName>
            <Operator>string</Operator>
            <IsExpression>string</IsExpression>
            <multiSelectType>string</multiSelectType>
            <selectedValues xsi:nil="true" />
          </Prompt>
        </promptsArray>
      </prompts>
      <toList>
        <string>string</string>
        <string>string</string>
      </toList>
      <emailBody>string</emailBody>
      <sessionVariables>
        <KeyValue>
          <key>string</key>
          <value>string</value>
        </KeyValue>
        <KeyValue>
          <key>string</key>
          <value>string</value>
        </KeyValue>
      </sessionVariables>
    </scheduleExportReport>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <scheduleExportReportResponse xmlns="http://www.birst.com/">
      <scheduleExportReportResult>string</scheduleExportReportResult>
    </scheduleExportReportResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <scheduleExportReport xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceId>string</spaceId>
      <reportPath>string</reportPath>
      <prompts>
        <applyAllPrompts>string</applyAllPrompts>
        <promptsArray>
          <Prompt>
            <ParameterName>string</ParameterName>
            <Operator>string</Operator>
            <IsExpression>string</IsExpression>
            <multiSelectType>string</multiSelectType>
            <selectedValues xsi:nil="true" />
          </Prompt>
          <Prompt>
            <ParameterName>string</ParameterName>
            <Operator>string</Operator>
            <IsExpression>string</IsExpression>
            <multiSelectType>string</multiSelectType>
            <selectedValues xsi:nil="true" />
          </Prompt>
        </promptsArray>
      </prompts>
      <toList>
        <string>string</string>
        <string>string</string>
      </toList>
      <emailBody>string</emailBody>
      <sessionVariables>
        <KeyValue>
          <key>string</key>
          <value>string</value>
        </KeyValue>
        <KeyValue>
          <key>string</key>
          <value>string</value>
        </KeyValue>
      </sessionVariables>
    </scheduleExportReport>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <scheduleExportReportResponse xmlns="http://www.birst.com/">
      <scheduleExportReportResult>string</scheduleExportReportResult>
    </scheduleExportReportResponse>
  </soap12:Body>
</soap12:Envelope>

setAgentsToConnectionMapping

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/setAgentsToConnectionMapping"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <setAgentsToConnectionMapping xmlns="http://www.birst.com/">
      <token>string</token>
      <connectionAgentsMappings>
        <ConnectionAgentsMapping>
          <connectionId>string</connectionId>
          <agentIds>
            <string>string</string>
            <string>string</string>
          </agentIds>
          <spaceId>string</spaceId>
        </ConnectionAgentsMapping>
        <ConnectionAgentsMapping>
          <connectionId>string</connectionId>
          <agentIds>
            <string>string</string>
            <string>string</string>
          </agentIds>
          <spaceId>string</spaceId>
        </ConnectionAgentsMapping>
      </connectionAgentsMappings>
    </setAgentsToConnectionMapping>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <setAgentsToConnectionMappingResponse xmlns="http://www.birst.com/">
      <setAgentsToConnectionMappingResult>
        <ConnectionAgentsMappingResult>
          <connectionId>string</connectionId>
          <successful>boolean</successful>
          <errorMessage>string</errorMessage>
        </ConnectionAgentsMappingResult>
        <ConnectionAgentsMappingResult>
          <connectionId>string</connectionId>
          <successful>boolean</successful>
          <errorMessage>string</errorMessage>
        </ConnectionAgentsMappingResult>
      </setAgentsToConnectionMappingResult>
    </setAgentsToConnectionMappingResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <setAgentsToConnectionMapping xmlns="http://www.birst.com/">
      <token>string</token>
      <connectionAgentsMappings>
        <ConnectionAgentsMapping>
          <connectionId>string</connectionId>
          <agentIds>
            <string>string</string>
            <string>string</string>
          </agentIds>
          <spaceId>string</spaceId>
        </ConnectionAgentsMapping>
        <ConnectionAgentsMapping>
          <connectionId>string</connectionId>
          <agentIds>
            <string>string</string>
            <string>string</string>
          </agentIds>
          <spaceId>string</spaceId>
        </ConnectionAgentsMapping>
      </connectionAgentsMappings>
    </setAgentsToConnectionMapping>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <setAgentsToConnectionMappingResponse xmlns="http://www.birst.com/">
      <setAgentsToConnectionMappingResult>
        <ConnectionAgentsMappingResult>
          <connectionId>string</connectionId>
          <successful>boolean</successful>
          <errorMessage>string</errorMessage>
        </ConnectionAgentsMappingResult>
        <ConnectionAgentsMappingResult>
          <connectionId>string</connectionId>
          <successful>boolean</successful>
          <errorMessage>string</errorMessage>
        </ConnectionAgentsMappingResult>
      </setAgentsToConnectionMappingResult>
    </setAgentsToConnectionMappingResponse>
  </soap12:Body>
</soap12:Envelope>

setBackgroundColorForSpace

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/setBackgroundColorForSpace"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <setBackgroundColorForSpace xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <bgcolor>string</bgcolor>
    </setBackgroundColorForSpace>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <setBackgroundColorForSpaceResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <setBackgroundColorForSpace xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <bgcolor>string</bgcolor>
    </setBackgroundColorForSpace>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <setBackgroundColorForSpaceResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

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.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/setCatalogPermissions"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <setCatalogPermissions xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <CatalogPermission>
        <directory>string</directory>
        <GroupPermission>
          <groupName>string</groupName>
          <canView>boolean</canView>
          <canModify>boolean</canModify>
          <recursive>boolean</recursive>
        </GroupPermission>
        <GroupPermission>
          <groupName>string</groupName>
          <canView>boolean</canView>
          <canModify>boolean</canModify>
          <recursive>boolean</recursive>
        </GroupPermission>
      </CatalogPermission>
      <CatalogPermission>
        <directory>string</directory>
        <GroupPermission>
          <groupName>string</groupName>
          <canView>boolean</canView>
          <canModify>boolean</canModify>
          <recursive>boolean</recursive>
        </GroupPermission>
        <GroupPermission>
          <groupName>string</groupName>
          <canView>boolean</canView>
          <canModify>boolean</canModify>
          <recursive>boolean</recursive>
        </GroupPermission>
      </CatalogPermission>
    </setCatalogPermissions>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <setCatalogPermissionsResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <setCatalogPermissions xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <CatalogPermission>
        <directory>string</directory>
        <GroupPermission>
          <groupName>string</groupName>
          <canView>boolean</canView>
          <canModify>boolean</canModify>
          <recursive>boolean</recursive>
        </GroupPermission>
        <GroupPermission>
          <groupName>string</groupName>
          <canView>boolean</canView>
          <canModify>boolean</canModify>
          <recursive>boolean</recursive>
        </GroupPermission>
      </CatalogPermission>
      <CatalogPermission>
        <directory>string</directory>
        <GroupPermission>
          <groupName>string</groupName>
          <canView>boolean</canView>
          <canModify>boolean</canModify>
          <recursive>boolean</recursive>
        </GroupPermission>
        <GroupPermission>
          <groupName>string</groupName>
          <canView>boolean</canView>
          <canModify>boolean</canModify>
          <recursive>boolean</recursive>
        </GroupPermission>
      </CatalogPermission>
    </setCatalogPermissions>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <setCatalogPermissionsResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

setDashboardView

Sets the dashboard view for the user with input username

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/setDashboardView"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <setDashboardView xmlns="http://www.birst.com/">
      <token>string</token>
      <userName>string</userName>
      <dashboardView>string</dashboardView>
    </setDashboardView>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <setDashboardViewResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <setDashboardView xmlns="http://www.birst.com/">
      <token>string</token>
      <userName>string</userName>
      <dashboardView>string</dashboardView>
    </setDashboardView>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <setDashboardViewResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

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.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/setDataCharacteristics"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <setDataCharacteristics xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <sourceName>string</sourceName>
      <dataCharacteristics>
        <OnlyQuoteAfterSeparator>string</OnlyQuoteAfterSeparator>
        <DoNotTreatCarriageReturnAsNewline>string</DoNotTreatCarriageReturnAsNewline>
        <HasHeaders>string</HasHeaders>
        <ForceNumColumns>string</ForceNumColumns>
        <Separator>string</Separator>
        <IgnoredRows>string</IgnoredRows>
        <IgnoredLastRows>string</IgnoredLastRows>
        <Quote>string</Quote>
        <Encoding>string</Encoding>
      </dataCharacteristics>
    </setDataCharacteristics>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <setDataCharacteristicsResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <setDataCharacteristics xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <sourceName>string</sourceName>
      <dataCharacteristics>
        <OnlyQuoteAfterSeparator>string</OnlyQuoteAfterSeparator>
        <DoNotTreatCarriageReturnAsNewline>string</DoNotTreatCarriageReturnAsNewline>
        <HasHeaders>string</HasHeaders>
        <ForceNumColumns>string</ForceNumColumns>
        <Separator>string</Separator>
        <IgnoredRows>string</IgnoredRows>
        <IgnoredLastRows>string</IgnoredLastRows>
        <Quote>string</Quote>
        <Encoding>string</Encoding>
      </dataCharacteristics>
    </setDataCharacteristics>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <setDataCharacteristicsResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

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=

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/setDataUploadOptions"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <setDataUploadOptions xmlns="http://www.birst.com/">
      <token>string</token>
      <dataUploadToken>string</dataUploadToken>
      <options>
        <string>string</string>
        <string>string</string>
      </options>
    </setDataUploadOptions>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <setDataUploadOptionsResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <setDataUploadOptions xmlns="http://www.birst.com/">
      <token>string</token>
      <dataUploadToken>string</dataUploadToken>
      <options>
        <string>string</string>
        <string>string</string>
      </options>
    </setDataUploadOptions>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <setDataUploadOptionsResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

setDefaultLogoForSpace

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/setDefaultLogoForSpace"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <setDefaultLogoForSpace xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
    </setDefaultLogoForSpace>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <setDefaultLogoForSpaceResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <setDefaultLogoForSpace xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
    </setDefaultLogoForSpace>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <setDefaultLogoForSpaceResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

setDenyAddSpace

Sets the flag to deny user to create new space

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/setDenyAddSpace"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body />
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body />
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body />
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body />
</soap12:Envelope>

setDirectoryPermission

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/setDirectoryPermission"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <setDirectoryPermission xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <dir>string</dir>
      <groupName>string</groupName>
      <permissionName>string</permissionName>
      <permission>boolean</permission>
    </setDirectoryPermission>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <setDirectoryPermissionResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <setDirectoryPermission xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <dir>string</dir>
      <groupName>string</groupName>
      <permissionName>string</permissionName>
      <permission>boolean</permission>
    </setDirectoryPermission>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <setDirectoryPermissionResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

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.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/setDirectoryPermissions"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body />
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body />
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body />
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body />
</soap12:Envelope>

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.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/setEmailFromForSpace"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body />
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body />
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body />
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body />
</soap12:Envelope>

setEmailSubjectForSpace

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/setEmailSubjectForSpace"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <setEmailSubjectForSpace xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <subject>string</subject>
    </setEmailSubjectForSpace>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <setEmailSubjectForSpaceResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <setEmailSubjectForSpace xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <subject>string</subject>
    </setEmailSubjectForSpace>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <setEmailSubjectForSpaceResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

setForegroundColorForSpace

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/setForegroundColorForSpace"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <setForegroundColorForSpace xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <fgcolor>string</fgcolor>
    </setForegroundColorForSpace>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <setForegroundColorForSpaceResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <setForegroundColorForSpace xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <fgcolor>string</fgcolor>
    </setForegroundColorForSpace>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <setForegroundColorForSpaceResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

setLanguageForUser

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/setLanguageForUser"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <setLanguageForUser xmlns="http://www.birst.com/">
      <token>string</token>
      <username>string</username>
      <localeId>string</localeId>
    </setLanguageForUser>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <setLanguageForUserResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <setLanguageForUser xmlns="http://www.birst.com/">
      <token>string</token>
      <username>string</username>
      <localeId>string</localeId>
    </setLanguageForUser>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <setLanguageForUserResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

setLiveAccessColumnProperties

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/setLiveAccessColumnProperties"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <setLiveAccessColumnProperties xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <columnsData>
        <SourceName>string</SourceName>
        <ColumnName>string</ColumnName>
        <Formula>string</Formula>
        <DataType>string</DataType>
        <Width>int</Width>
        <Attribute>boolean</Attribute>
        <Measure>boolean</Measure>
        <AnalyzeByDate>boolean</AnalyzeByDate>
      </columnsData>
    </setLiveAccessColumnProperties>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <setLiveAccessColumnPropertiesResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <setLiveAccessColumnProperties xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <columnsData>
        <SourceName>string</SourceName>
        <ColumnName>string</ColumnName>
        <Formula>string</Formula>
        <DataType>string</DataType>
        <Width>int</Width>
        <Attribute>boolean</Attribute>
        <Measure>boolean</Measure>
        <AnalyzeByDate>boolean</AnalyzeByDate>
      </columnsData>
    </setLiveAccessColumnProperties>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <setLiveAccessColumnPropertiesResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

setLiveAccessSourceDetails

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/setLiveAccessSourceDetails"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <setLiveAccessSourceDetails xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <data>
        <Name>string</Name>
        <UnCached>boolean</UnCached>
        <TTL>int</TTL>
        <Cardinality>int</Cardinality>
        <SourceKeys>
          <string>string</string>
          <string>string</string>
        </SourceKeys>
        <ForeignKeys>
          <string>string</string>
          <string>string</string>
        </ForeignKeys>
        <SourceFilterCondition>string</SourceFilterCondition>
      </data>
    </setLiveAccessSourceDetails>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <setLiveAccessSourceDetailsResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <setLiveAccessSourceDetails xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <data>
        <Name>string</Name>
        <UnCached>boolean</UnCached>
        <TTL>int</TTL>
        <Cardinality>int</Cardinality>
        <SourceKeys>
          <string>string</string>
          <string>string</string>
        </SourceKeys>
        <ForeignKeys>
          <string>string</string>
          <string>string</string>
        </ForeignKeys>
        <SourceFilterCondition>string</SourceFilterCondition>
      </data>
    </setLiveAccessSourceDetails>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <setLiveAccessSourceDetailsResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

setLogoForSpace

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/setLogoForSpace"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <setLogoForSpace xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <image>base64Binary</image>
    </setLogoForSpace>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <setLogoForSpaceResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <setLogoForSpace xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <image>base64Binary</image>
    </setLogoForSpace>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <setLogoForSpaceResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

setProfileProperty

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/setProfileProperty"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <setProfileProperty xmlns="http://www.birst.com/">
      <token>string</token>
      <profileID>string</profileID>
      <property>
        <name>string</name>
        <value>string</value>
        <locale>string</locale>
      </property>
    </setProfileProperty>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <setProfilePropertyResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <setProfileProperty xmlns="http://www.birst.com/">
      <token>string</token>
      <profileID>string</profileID>
      <property>
        <name>string</name>
        <value>string</value>
        <locale>string</locale>
      </property>
    </setProfileProperty>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <setProfilePropertyResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

setSourceDetails

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/setSourceDetails"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <setSourceDetails xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <data>
        <Name>string</Name>
        <OriginalName>string</OriginalName>
        <Disabled>boolean</Disabled>
        <Script>
          <InputQuery>string</InputQuery>
          <Output>string</Output>
          <Script>string</Script>
        </Script>
        <LastModifiedDate>dateTime</LastModifiedDate>
        <SubGroups>
          <string>string</string>
          <string>string</string>
        </SubGroups>
        <Columns>
          <SourceColumnSubClass>
            <Name>string</Name>
            <OriginalName>string</OriginalName>
            <AnalyzeMeasure>boolean</AnalyzeMeasure>
            <DataType>string</DataType>
            <Format>string</Format>
            <EnableSecutityFilter>boolean</EnableSecutityFilter>
            <SourceFileColumn>string</SourceFileColumn>
            <TargetAggregations xsi:nil="true" />
            <TargetTypes xsi:nil="true" />
            <UnknownValue>string</UnknownValue>
            <Width>int</Width>
            <HierarchyName>string</HierarchyName>
            <LevelName>string</LevelName>
            <Levels xsi:nil="true" />
            <AnalyzeByDate>boolean</AnalyzeByDate>
            <Measure>boolean</Measure>
            <LockType>boolean</LockType>
          </SourceColumnSubClass>
          <SourceColumnSubClass>
            <Name>string</Name>
            <OriginalName>string</OriginalName>
            <AnalyzeMeasure>boolean</AnalyzeMeasure>
            <DataType>string</DataType>
            <Format>string</Format>
            <EnableSecutityFilter>boolean</EnableSecutityFilter>
            <SourceFileColumn>string</SourceFileColumn>
            <TargetAggregations xsi:nil="true" />
            <TargetTypes xsi:nil="true" />
            <UnknownValue>string</UnknownValue>
            <Width>int</Width>
            <HierarchyName>string</HierarchyName>
            <LevelName>string</LevelName>
            <Levels xsi:nil="true" />
            <AnalyzeByDate>boolean</AnalyzeByDate>
            <Measure>boolean</Measure>
            <LockType>boolean</LockType>
          </SourceColumnSubClass>
        </Columns>
      </data>
    </setSourceDetails>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <setSourceDetailsResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <setSourceDetails xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <data>
        <Name>string</Name>
        <OriginalName>string</OriginalName>
        <Disabled>boolean</Disabled>
        <Script>
          <InputQuery>string</InputQuery>
          <Output>string</Output>
          <Script>string</Script>
        </Script>
        <LastModifiedDate>dateTime</LastModifiedDate>
        <SubGroups>
          <string>string</string>
          <string>string</string>
        </SubGroups>
        <Columns>
          <SourceColumnSubClass>
            <Name>string</Name>
            <OriginalName>string</OriginalName>
            <AnalyzeMeasure>boolean</AnalyzeMeasure>
            <DataType>string</DataType>
            <Format>string</Format>
            <EnableSecutityFilter>boolean</EnableSecutityFilter>
            <SourceFileColumn>string</SourceFileColumn>
            <TargetAggregations xsi:nil="true" />
            <TargetTypes xsi:nil="true" />
            <UnknownValue>string</UnknownValue>
            <Width>int</Width>
            <HierarchyName>string</HierarchyName>
            <LevelName>string</LevelName>
            <Levels xsi:nil="true" />
            <AnalyzeByDate>boolean</AnalyzeByDate>
            <Measure>boolean</Measure>
            <LockType>boolean</LockType>
          </SourceColumnSubClass>
          <SourceColumnSubClass>
            <Name>string</Name>
            <OriginalName>string</OriginalName>
            <AnalyzeMeasure>boolean</AnalyzeMeasure>
            <DataType>string</DataType>
            <Format>string</Format>
            <EnableSecutityFilter>boolean</EnableSecutityFilter>
            <SourceFileColumn>string</SourceFileColumn>
            <TargetAggregations xsi:nil="true" />
            <TargetTypes xsi:nil="true" />
            <UnknownValue>string</UnknownValue>
            <Width>int</Width>
            <HierarchyName>string</HierarchyName>
            <LevelName>string</LevelName>
            <Levels xsi:nil="true" />
            <AnalyzeByDate>boolean</AnalyzeByDate>
            <Measure>boolean</Measure>
            <LockType>boolean</LockType>
          </SourceColumnSubClass>
        </Columns>
      </data>
    </setSourceDetails>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <setSourceDetailsResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

setSpaceComments

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/setSpaceComments"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <setSpaceComments xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <spaceComments>string</spaceComments>
    </setSpaceComments>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <setSpaceCommentsResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <setSpaceComments xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <spaceComments>string</spaceComments>
    </setSpaceComments>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <setSpaceCommentsResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

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.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/setSpaceName"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <setSpaceName xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <spaceName>string</spaceName>
    </setSpaceName>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <setSpaceNameResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <setSpaceName xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <spaceName>string</spaceName>
    </setSpaceName>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <setSpaceNameResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

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.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/setSpaceProcessEngineVersion"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <setSpaceProcessEngineVersion xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <processingVersionName>string</processingVersionName>
    </setSpaceProcessEngineVersion>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <setSpaceProcessEngineVersionResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <setSpaceProcessEngineVersion xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <processingVersionName>string</processingVersionName>
    </setSpaceProcessEngineVersion>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <setSpaceProcessEngineVersionResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

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.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/setSpaceSSOPassword"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <setSpaceSSOPassword xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <password>string</password>
    </setSpaceSSOPassword>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <setSpaceSSOPasswordResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <setSpaceSSOPassword xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <password>string</password>
    </setSpaceSSOPassword>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <setSpaceSSOPasswordResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

setSubjectArea

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/setSubjectArea"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <setSubjectArea xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <saContent>string</saContent>
    </setSubjectArea>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <setSubjectAreaResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <setSubjectArea xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <saContent>string</saContent>
    </setSubjectArea>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <setSubjectAreaResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

setSubjectAreaDescription

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/setSubjectAreaDescription"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <setSubjectAreaDescription xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <name>string</name>
      <description>string</description>
    </setSubjectAreaDescription>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <setSubjectAreaDescriptionResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <setSubjectAreaDescription xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <name>string</name>
      <description>string</description>
    </setSubjectAreaDescription>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <setSubjectAreaDescriptionResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

setSubjectAreaPermissions

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/setSubjectAreaPermissions"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <setSubjectAreaPermissions xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <name>string</name>
      <groups>
        <string>string</string>
        <string>string</string>
      </groups>
    </setSubjectAreaPermissions>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <setSubjectAreaPermissionsResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <setSubjectAreaPermissions xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <name>string</name>
      <groups>
        <string>string</string>
        <string>string</string>
      </groups>
    </setSubjectAreaPermissions>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <setSubjectAreaPermissionsResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

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.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/setUpGenericJDBCRealTimeConnectionForSpace"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <setUpGenericJDBCRealTimeConnectionForSpace xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <configFileName>string</configFileName>
      <connectionName>string</connectionName>
      <useDirectConnection>boolean</useDirectConnection>
      <sqlType>string</sqlType>
      <driverName>string</driverName>
      <connectionString>string</connectionString>
      <filter>string</filter>
      <userName>string</userName>
      <password>string</password>
      <timeout>int</timeout>
    </setUpGenericJDBCRealTimeConnectionForSpace>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <setUpGenericJDBCRealTimeConnectionForSpaceResponse xmlns="http://www.birst.com/">
      <setUpGenericJDBCRealTimeConnectionForSpaceResult>boolean</setUpGenericJDBCRealTimeConnectionForSpaceResult>
    </setUpGenericJDBCRealTimeConnectionForSpaceResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <setUpGenericJDBCRealTimeConnectionForSpace xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <configFileName>string</configFileName>
      <connectionName>string</connectionName>
      <useDirectConnection>boolean</useDirectConnection>
      <sqlType>string</sqlType>
      <driverName>string</driverName>
      <connectionString>string</connectionString>
      <filter>string</filter>
      <userName>string</userName>
      <password>string</password>
      <timeout>int</timeout>
    </setUpGenericJDBCRealTimeConnectionForSpace>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <setUpGenericJDBCRealTimeConnectionForSpaceResponse xmlns="http://www.birst.com/">
      <setUpGenericJDBCRealTimeConnectionForSpaceResult>boolean</setUpGenericJDBCRealTimeConnectionForSpaceResult>
    </setUpGenericJDBCRealTimeConnectionForSpaceResponse>
  </soap12:Body>
</soap12:Envelope>

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.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/setUpRealTimeConnectionForSpace"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <setUpRealTimeConnectionForSpace xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <configFileName>string</configFileName>
      <connectionName>string</connectionName>
      <databaseType>string</databaseType>
      <useDirectConnection>boolean</useDirectConnection>
      <host>string</host>
      <port>int</port>
      <databaseName>string</databaseName>
      <userName>string</userName>
      <password>string</password>
      <timeout>int</timeout>
    </setUpRealTimeConnectionForSpace>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <setUpRealTimeConnectionForSpaceResponse xmlns="http://www.birst.com/">
      <setUpRealTimeConnectionForSpaceResult>boolean</setUpRealTimeConnectionForSpaceResult>
    </setUpRealTimeConnectionForSpaceResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <setUpRealTimeConnectionForSpace xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <configFileName>string</configFileName>
      <connectionName>string</connectionName>
      <databaseType>string</databaseType>
      <useDirectConnection>boolean</useDirectConnection>
      <host>string</host>
      <port>int</port>
      <databaseName>string</databaseName>
      <userName>string</userName>
      <password>string</password>
      <timeout>int</timeout>
    </setUpRealTimeConnectionForSpace>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <setUpRealTimeConnectionForSpaceResponse xmlns="http://www.birst.com/">
      <setUpRealTimeConnectionForSpaceResult>boolean</setUpRealTimeConnectionForSpaceResult>
    </setUpRealTimeConnectionForSpaceResponse>
  </soap12:Body>
</soap12:Envelope>

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.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/setUserDefaultSpace"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <setUserDefaultSpace xmlns="http://www.birst.com/">
      <token>string</token>
      <userName>string</userName>
      <spaceID>string</spaceID>
      <dashboards>boolean</dashboards>
    </setUserDefaultSpace>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <setUserDefaultSpaceResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <setUserDefaultSpace xmlns="http://www.birst.com/">
      <token>string</token>
      <userName>string</userName>
      <spaceID>string</spaceID>
      <dashboards>boolean</dashboards>
    </setUserDefaultSpace>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <setUserDefaultSpaceResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

setUserPassword

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/setUserPassword"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <setUserPassword xmlns="http://www.birst.com/">
      <token>string</token>
      <userName>string</userName>
      <password>string</password>
    </setUserPassword>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <setUserPasswordResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <setUserPassword xmlns="http://www.birst.com/">
      <token>string</token>
      <userName>string</userName>
      <password>string</password>
    </setUserPassword>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <setUserPasswordResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

setUserRelease

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/setUserRelease"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <setUserRelease xmlns="http://www.birst.com/">
      <token>string</token>
      <userName>string</userName>
      <release>string</release>
    </setUserRelease>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <setUserReleaseResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <setUserRelease xmlns="http://www.birst.com/">
      <token>string</token>
      <userName>string</userName>
      <release>string</release>
    </setUserRelease>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <setUserReleaseResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

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.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/setVariableInSpace"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <setVariableInSpace xmlns="http://www.birst.com/">
      <token>string</token>
      <varName>string</varName>
      <query>string</query>
      <spaceID>string</spaceID>
    </setVariableInSpace>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <setVariableInSpaceResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <setVariableInSpace xmlns="http://www.birst.com/">
      <token>string</token>
      <varName>string</varName>
      <query>string</query>
      <spaceID>string</spaceID>
    </setVariableInSpace>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <setVariableInSpaceResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

submitExportJob

Kicks off an export job.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/submitExportJob"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <submitExportJob xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceId>string</spaceId>
      <jobRequest>
        <exportData>
          <ExportData>
            <name>string</name>
            <collection>string</collection>
            <bookmark>string</bookmark>
            <filters xsi:nil="true" />
          </ExportData>
          <ExportData>
            <name>string</name>
            <collection>string</collection>
            <bookmark>string</bookmark>
            <filters xsi:nil="true" />
          </ExportData>
        </exportData>
        <sessionVars>
          <SessionVar>
            <key>string</key>
            <value>string</value>
            <label>string</label>
          </SessionVar>
          <SessionVar>
            <key>string</key>
            <value>string</value>
            <label>string</label>
          </SessionVar>
        </sessionVars>
        <deliveryMethod>EMAIL or URL</deliveryMethod>
        <viewPortOptions>
          <height>int</height>
          <width>int</width>
        </viewPortOptions>
        <printOptions>
          <marginLeft>
            <value>float</value>
            <type>px or in or cm or mm</type>
          </marginLeft>
          <marginRight>
            <value>float</value>
            <type>px or in or cm or mm</type>
          </marginRight>
          <marginBottom>
            <value>float</value>
            <type>px or in or cm or mm</type>
          </marginBottom>
          <marginTop>
            <value>float</value>
            <type>px or in or cm or mm</type>
          </marginTop>
          <orientation>PORTRAIT or LANDSCAPE</orientation>
          <paperHeight>
            <value>float</value>
            <type>px or in or cm or mm</type>
          </paperHeight>
          <paperWidth>
            <value>float</value>
            <type>px or in or cm or mm</type>
          </paperWidth>
          <paperFormat>LEGAL or LETTER or A4</paperFormat>
          <dashletOnWholePage>boolean</dashletOnWholePage>
          <printAllDashlets>boolean</printAllDashlets>
        </printOptions>
        <format>PDF or EXCEL or PPT</format>
        <printSessionVars>boolean</printSessionVars>
      </jobRequest>
    </submitExportJob>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <submitExportJobResponse xmlns="http://www.birst.com/">
      <submitExportJobResult>string</submitExportJobResult>
    </submitExportJobResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <submitExportJob xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceId>string</spaceId>
      <jobRequest>
        <exportData>
          <ExportData>
            <name>string</name>
            <collection>string</collection>
            <bookmark>string</bookmark>
            <filters xsi:nil="true" />
          </ExportData>
          <ExportData>
            <name>string</name>
            <collection>string</collection>
            <bookmark>string</bookmark>
            <filters xsi:nil="true" />
          </ExportData>
        </exportData>
        <sessionVars>
          <SessionVar>
            <key>string</key>
            <value>string</value>
            <label>string</label>
          </SessionVar>
          <SessionVar>
            <key>string</key>
            <value>string</value>
            <label>string</label>
          </SessionVar>
        </sessionVars>
        <deliveryMethod>EMAIL or URL</deliveryMethod>
        <viewPortOptions>
          <height>int</height>
          <width>int</width>
        </viewPortOptions>
        <printOptions>
          <marginLeft>
            <value>float</value>
            <type>px or in or cm or mm</type>
          </marginLeft>
          <marginRight>
            <value>float</value>
            <type>px or in or cm or mm</type>
          </marginRight>
          <marginBottom>
            <value>float</value>
            <type>px or in or cm or mm</type>
          </marginBottom>
          <marginTop>
            <value>float</value>
            <type>px or in or cm or mm</type>
          </marginTop>
          <orientation>PORTRAIT or LANDSCAPE</orientation>
          <paperHeight>
            <value>float</value>
            <type>px or in or cm or mm</type>
          </paperHeight>
          <paperWidth>
            <value>float</value>
            <type>px or in or cm or mm</type>
          </paperWidth>
          <paperFormat>LEGAL or LETTER or A4</paperFormat>
          <dashletOnWholePage>boolean</dashletOnWholePage>
          <printAllDashlets>boolean</printAllDashlets>
        </printOptions>
        <format>PDF or EXCEL or PPT</format>
        <printSessionVars>boolean</printSessionVars>
      </jobRequest>
    </submitExportJob>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <submitExportJobResponse xmlns="http://www.birst.com/">
      <submitExportJobResult>string</submitExportJobResult>
    </submitExportJobResponse>
  </soap12:Body>
</soap12:Envelope>

swapSpaceContents

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/swapSpaceContents"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <swapSpaceContents xmlns="http://www.birst.com/">
      <token>string</token>
      <sp1ID>string</sp1ID>
      <sp2ID>string</sp2ID>
    </swapSpaceContents>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <swapSpaceContentsResponse xmlns="http://www.birst.com/">
      <swapSpaceContentsResult>string</swapSpaceContentsResult>
    </swapSpaceContentsResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <swapSpaceContents xmlns="http://www.birst.com/">
      <token>string</token>
      <sp1ID>string</sp1ID>
      <sp2ID>string</sp2ID>
    </swapSpaceContents>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <swapSpaceContentsResponse xmlns="http://www.birst.com/">
      <swapSpaceContentsResult>string</swapSpaceContentsResult>
    </swapSpaceContentsResponse>
  </soap12:Body>
</soap12:Envelope>

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/swapSpaceForPackages"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <swapSpaceForPackages xmlns="http://www.birst.com/">
      <token>string</token>
      <sp1Name>string</sp1Name>
      <sp2Name>string</sp2Name>
      <syncImportedPackages>boolean</syncImportedPackages>
    </swapSpaceForPackages>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <swapSpaceForPackagesResponse xmlns="http://www.birst.com/">
      <swapSpaceForPackagesResult>string</swapSpaceForPackagesResult>
    </swapSpaceForPackagesResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <swapSpaceForPackages xmlns="http://www.birst.com/">
      <token>string</token>
      <sp1Name>string</sp1Name>
      <sp2Name>string</sp2Name>
      <syncImportedPackages>boolean</syncImportedPackages>
    </swapSpaceForPackages>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <swapSpaceForPackagesResponse xmlns="http://www.birst.com/">
      <swapSpaceForPackagesResult>string</swapSpaceForPackagesResult>
    </swapSpaceForPackagesResponse>
  </soap12:Body>
</soap12:Envelope>

toggleWhiteSpaceEnablement

Toggles white space patch enablement for designer reports.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/toggleWhiteSpaceEnablement"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <toggleWhiteSpaceEnablement xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceId>string</spaceId>
    </toggleWhiteSpaceEnablement>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <toggleWhiteSpaceEnablementResponse xmlns="http://www.birst.com/">
      <toggleWhiteSpaceEnablementResult>string</toggleWhiteSpaceEnablementResult>
    </toggleWhiteSpaceEnablementResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <toggleWhiteSpaceEnablement xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceId>string</spaceId>
    </toggleWhiteSpaceEnablement>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <toggleWhiteSpaceEnablementResponse xmlns="http://www.birst.com/">
      <toggleWhiteSpaceEnablementResult>string</toggleWhiteSpaceEnablementResult>
    </toggleWhiteSpaceEnablementResponse>
  </soap12:Body>
</soap12:Envelope>

unlinkProfileFromAccount

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/unlinkProfileFromAccount"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <unlinkProfileFromAccount xmlns="http://www.birst.com/">
      <token>string</token>
    </unlinkProfileFromAccount>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <unlinkProfileFromAccountResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <unlinkProfileFromAccount xmlns="http://www.birst.com/">
      <token>string</token>
    </unlinkProfileFromAccount>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <unlinkProfileFromAccountResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

unlinkProfileFromUsers

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/unlinkProfileFromUsers"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <unlinkProfileFromUsers xmlns="http://www.birst.com/">
      <token>string</token>
      <userList>
        <string>string</string>
        <string>string</string>
      </userList>
    </unlinkProfileFromUsers>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <unlinkProfileFromUsersResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <unlinkProfileFromUsers xmlns="http://www.birst.com/">
      <token>string</token>
      <userList>
        <string>string</string>
        <string>string</string>
      </userList>
    </unlinkProfileFromUsers>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <unlinkProfileFromUsersResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

unlockUser

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/unlockUser"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <unlockUser xmlns="http://www.birst.com/">
      <token>string</token>
      <userName>string</userName>
    </unlockUser>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <unlockUserResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <unlockUser xmlns="http://www.birst.com/">
      <token>string</token>
      <userName>string</userName>
    </unlockUser>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <unlockUserResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

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.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/updateBirstConnectAgent"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <updateBirstConnectAgent xmlns="http://www.birst.com/">
      <token>string</token>
      <agentId>string</agentId>
      <name>string</name>
      <description>string</description>
    </updateBirstConnectAgent>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <updateBirstConnectAgentResponse xmlns="http://www.birst.com/">
      <updateBirstConnectAgentResult>boolean</updateBirstConnectAgentResult>
    </updateBirstConnectAgentResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <updateBirstConnectAgent xmlns="http://www.birst.com/">
      <token>string</token>
      <agentId>string</agentId>
      <name>string</name>
      <description>string</description>
    </updateBirstConnectAgent>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <updateBirstConnectAgentResponse xmlns="http://www.birst.com/">
      <updateBirstConnectAgentResult>boolean</updateBirstConnectAgentResult>
    </updateBirstConnectAgentResponse>
  </soap12:Body>
</soap12:Envelope>

updateCloudConnection

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/updateCloudConnection"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <updateCloudConnection xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <accountID>string</accountID>
      <connectionId>string</connectionId>
      <cloudConnection>
        <name>string</name>
        <guid>string</guid>
        <connectorType>string</connectorType>
        <connectorAPIVersion>string</connectorAPIVersion>
        <connectionProperties>
          <ConnectionProperty>
            <name>string</name>
            <value>string</value>
            <saveToConfig>boolean</saveToConfig>
            <isSecret>boolean</isSecret>
            <isRequired>boolean</isRequired>
            <isEncrypted>boolean</isEncrypted>
            <displayIndex>int</displayIndex>
            <displayLabel>string</displayLabel>
            <displayType>string</displayType>
            <tooltip>string</tooltip>
          </ConnectionProperty>
          <ConnectionProperty>
            <name>string</name>
            <value>string</value>
            <saveToConfig>boolean</saveToConfig>
            <isSecret>boolean</isSecret>
            <isRequired>boolean</isRequired>
            <isEncrypted>boolean</isEncrypted>
            <displayIndex>int</displayIndex>
            <displayLabel>string</displayLabel>
            <displayType>string</displayType>
            <tooltip>string</tooltip>
          </ConnectionProperty>
        </connectionProperties>
        <dateCreated>long</dateCreated>
        <dateModified>long</dateModified>
        <createdBy>string</createdBy>
        <modifiedBy>string</modifiedBy>
        <startExtractionTime>long</startExtractionTime>
        <endExtractionTime>long</endExtractionTime>
        <migratedConnection>string</migratedConnection>
        <objectsConfigured>boolean</objectsConfigured>
        <onPremise>boolean</onPremise>
        <liveAccess>boolean</liveAccess>
        <restricted>boolean</restricted>
        <shared>boolean</shared>
        <datasourceId>string</datasourceId>
        <agentIDs>
          <string>string</string>
          <string>string</string>
        </agentIDs>
        <agentGroup>string</agentGroup>
      </cloudConnection>
    </updateCloudConnection>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <updateCloudConnectionResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <updateCloudConnection xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <accountID>string</accountID>
      <connectionId>string</connectionId>
      <cloudConnection>
        <name>string</name>
        <guid>string</guid>
        <connectorType>string</connectorType>
        <connectorAPIVersion>string</connectorAPIVersion>
        <connectionProperties>
          <ConnectionProperty>
            <name>string</name>
            <value>string</value>
            <saveToConfig>boolean</saveToConfig>
            <isSecret>boolean</isSecret>
            <isRequired>boolean</isRequired>
            <isEncrypted>boolean</isEncrypted>
            <displayIndex>int</displayIndex>
            <displayLabel>string</displayLabel>
            <displayType>string</displayType>
            <tooltip>string</tooltip>
          </ConnectionProperty>
          <ConnectionProperty>
            <name>string</name>
            <value>string</value>
            <saveToConfig>boolean</saveToConfig>
            <isSecret>boolean</isSecret>
            <isRequired>boolean</isRequired>
            <isEncrypted>boolean</isEncrypted>
            <displayIndex>int</displayIndex>
            <displayLabel>string</displayLabel>
            <displayType>string</displayType>
            <tooltip>string</tooltip>
          </ConnectionProperty>
        </connectionProperties>
        <dateCreated>long</dateCreated>
        <dateModified>long</dateModified>
        <createdBy>string</createdBy>
        <modifiedBy>string</modifiedBy>
        <startExtractionTime>long</startExtractionTime>
        <endExtractionTime>long</endExtractionTime>
        <migratedConnection>string</migratedConnection>
        <objectsConfigured>boolean</objectsConfigured>
        <onPremise>boolean</onPremise>
        <liveAccess>boolean</liveAccess>
        <restricted>boolean</restricted>
        <shared>boolean</shared>
        <datasourceId>string</datasourceId>
        <agentIDs>
          <string>string</string>
          <string>string</string>
        </agentIDs>
        <agentGroup>string</agentGroup>
      </cloudConnection>
    </updateCloudConnection>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <updateCloudConnectionResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

updateExpression

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/updateExpression"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <updateExpression xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <expression>
        <Name>string</Name>
        <ColumnType>string</ColumnType>
        <Format>string</Format>
        <Expression>string</Expression>
      </expression>
    </updateExpression>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <updateExpressionResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <updateExpression xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <expression>
        <Name>string</Name>
        <ColumnType>string</ColumnType>
        <Format>string</Format>
        <Expression>string</Expression>
      </expression>
    </updateExpression>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <updateExpressionResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

updateHierarchy

Updates hierarchy information for the space specified.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/updateHierarchy"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <updateHierarchy xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <hierarchyName>string</hierarchyName>
      <hmd>
        <Name>string</Name>
        <Children>
          <LevelMetadata>
            <Name>string</Name>
            <Cardinality>string</Cardinality>
            <ColumnNames xsi:nil="true" />
            <Children xsi:nil="true" />
          </LevelMetadata>
          <LevelMetadata>
            <Name>string</Name>
            <Cardinality>string</Cardinality>
            <ColumnNames xsi:nil="true" />
            <Children xsi:nil="true" />
          </LevelMetadata>
        </Children>
      </hmd>
    </updateHierarchy>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <updateHierarchyResponse xmlns="http://www.birst.com/">
      <updateHierarchyResult>boolean</updateHierarchyResult>
    </updateHierarchyResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <updateHierarchy xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <hierarchyName>string</hierarchyName>
      <hmd>
        <Name>string</Name>
        <Children>
          <LevelMetadata>
            <Name>string</Name>
            <Cardinality>string</Cardinality>
            <ColumnNames xsi:nil="true" />
            <Children xsi:nil="true" />
          </LevelMetadata>
          <LevelMetadata>
            <Name>string</Name>
            <Cardinality>string</Cardinality>
            <ColumnNames xsi:nil="true" />
            <Children xsi:nil="true" />
          </LevelMetadata>
        </Children>
      </hmd>
    </updateHierarchy>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <updateHierarchyResponse xmlns="http://www.birst.com/">
      <updateHierarchyResult>boolean</updateHierarchyResult>
    </updateHierarchyResponse>
  </soap12:Body>
</soap12:Envelope>

updateProfile

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/updateProfile"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <updateProfile xmlns="http://www.birst.com/">
      <token>string</token>
      <profileID>string</profileID>
      <name>string</name>
      <description>string</description>
    </updateProfile>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <updateProfileResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <updateProfile xmlns="http://www.birst.com/">
      <token>string</token>
      <profileID>string</profileID>
      <name>string</name>
      <description>string</description>
    </updateProfile>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <updateProfileResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

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'.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/updateUser"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <updateUser xmlns="http://www.birst.com/">
      <token>string</token>
      <userName>string</userName>
      <additionalParams>string</additionalParams>
    </updateUser>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <updateUserResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <updateUser xmlns="http://www.birst.com/">
      <token>string</token>
      <userName>string</userName>
      <additionalParams>string</additionalParams>
    </updateUser>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <updateUserResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

upgradeAgent

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/upgradeAgent"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <upgradeAgent xmlns="http://www.birst.com/">
      <token>string</token>
      <agentIds>
        <string>string</string>
        <string>string</string>
      </agentIds>
    </upgradeAgent>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <upgradeAgentResponse xmlns="http://www.birst.com/">
      <upgradeAgentResult>boolean</upgradeAgentResult>
    </upgradeAgentResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <upgradeAgent xmlns="http://www.birst.com/">
      <token>string</token>
      <agentIds>
        <string>string</string>
        <string>string</string>
      </agentIds>
    </upgradeAgent>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <upgradeAgentResponse xmlns="http://www.birst.com/">
      <upgradeAgentResult>boolean</upgradeAgentResult>
    </upgradeAgentResponse>
  </soap12:Body>
</soap12:Envelope>

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.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/uploadData"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <uploadData xmlns="http://www.birst.com/">
      <token>string</token>
      <dataUploadToken>string</dataUploadToken>
      <numBytes>int</numBytes>
      <data>base64Binary</data>
    </uploadData>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <uploadDataResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <uploadData xmlns="http://www.birst.com/">
      <token>string</token>
      <dataUploadToken>string</dataUploadToken>
      <numBytes>int</numBytes>
      <data>base64Binary</data>
    </uploadData>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <uploadDataResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>

uploadImageToReportCatalog

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

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/uploadImageToReportCatalog"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <uploadImageToReportCatalog xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <dir>string</dir>
      <reportFileName>string</reportFileName>
      <image>base64Binary</image>
    </uploadImageToReportCatalog>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <uploadImageToReportCatalogResponse xmlns="http://www.birst.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CommandWebService.asmx HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <uploadImageToReportCatalog xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <dir>string</dir>
      <reportFileName>string</reportFileName>
      <image>base64Binary</image>
    </uploadImageToReportCatalog>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <uploadImageToReportCatalogResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>