CommandWebService Web Service

CommandWebService

Click here for a complete list of operations.

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.

Test

The test form is only available for requests from the local machine.

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>