CommandWebService Web Service

CommandWebService

Click here for a complete list of operations.

addCloudConnection

Add cloud connection. Arguments are Login token, space id, and cloud 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/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>