CommandWebService Web Service

CommandWebService

Click here for a complete list of operations.

listCloudConnections

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

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/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>