CommandWebService

Click here for a complete list of operations.

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

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

<?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>
    <getDatabaseLinksStatus xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceIDs>
        <string>string</string>
      </spaceIDs>
    </getDatabaseLinksStatus>
  </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">
    <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>
        </databaseLinksStatusResult>
      </getDatabaseLinksStatusResult>
    </getDatabaseLinksStatusResponse>
  </s:Body>
</s:Envelope>