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.

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

<?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>
    <executeQueryInSpace xmlns="http://www.birst.com/">
      <token>string</token>
      <query>string</query>
      <spaceID>string</spaceID>
    </executeQueryInSpace>
  </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>
    <executeQueryInSpaceResponse xmlns="http://www.birst.com/">
      <executeQueryInSpaceResult>
        <queryToken>string</queryToken>
        <numRowsReturned>int</numRowsReturned>
        <hasMoreRows>boolean</hasMoreRows>
      </executeQueryInSpaceResult>
    </executeQueryInSpaceResponse>
  </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>
    <executeQueryInSpace xmlns="http://www.birst.com/">
      <token>string</token>
      <query>string</query>
      <spaceID>string</spaceID>
    </executeQueryInSpace>
  </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>
    <executeQueryInSpaceResponse xmlns="http://www.birst.com/">
      <executeQueryInSpaceResult>
        <queryToken>string</queryToken>
        <numRowsReturned>int</numRowsReturned>
        <hasMoreRows>boolean</hasMoreRows>
      </executeQueryInSpaceResult>
    </executeQueryInSpaceResponse>
  </soap12:Body>
</soap12:Envelope>