SOAP

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

Request

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"?>
<s:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s: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>
        </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>
        </agentIDs>
        <agentGroup>string</agentGroup>
      </cloudConnection>
    </updateCloudConnection>
  </s:Body>
</s:Envelope>

Response

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

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <updateCloudConnectionResponse xmlns="http://www.birst.com/">
    </updateCloudConnectionResponse>
  </s:Body>
</s:Envelope>