CommandWebService

Click here for a complete list of operations.

executeQueryInSpace

Execute a Birst Logical Query. Arguments are the Login token, the Birst logical query, and the space Id. Returns the first 1000 results. See queryMore for retrieving the remainder.

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

<?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>
    <executeQueryInSpace xmlns="http://www.birst.com/">
      <token>string</token>
      <query>string</query>
      <spaceID>string</spaceID>
    </executeQueryInSpace>
  </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">
    <executeQueryInSpaceResponse xmlns="http://www.birst.com/">
      <executeQueryInSpaceResult>
        <rows>
          <ArrayOfString>
            <string>string</string>
          </ArrayOfString>
        </rows>
        <columnNames>
          <string>string</string>
        </columnNames>
        <displayNames>
          <string>string</string>
        </displayNames>
        <dataTypes>
          <int>int</int>
        </dataTypes>
        <errorMessage>string</errorMessage>
        <errorCode>int</errorCode>
        <queryToken>string</queryToken>
        <numRowsReturned>int</numRowsReturned>
        <hasMoreRows>boolean</hasMoreRows>
      </executeQueryInSpaceResult>
    </executeQueryInSpaceResponse>
  </s:Body>
</s:Envelope>