CommandWebService Web Service

CommandWebService

Click here for a complete list of operations.

exportReportToPPT

Executes a report to be exported to PPT. Arguments are the login token, the space id, the report name, a list of filters and whether to turn off pagination or not.

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

<?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>
    <exportReportToPPT xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceId>string</spaceId>
      <reportPath>string</reportPath>
      <reportFilters>
        <Filter>
          <Operator>string</Operator>
          <multiSelectType>string</multiSelectType>
          <FilterType>string</FilterType>
          <ParameterName>string</ParameterName>
          <selectedValues>
            <selectedValue>string</selectedValue>
            <selectedValue>string</selectedValue>
          </selectedValues>
        </Filter>
        <Filter>
          <Operator>string</Operator>
          <multiSelectType>string</multiSelectType>
          <FilterType>string</FilterType>
          <ParameterName>string</ParameterName>
          <selectedValues>
            <selectedValue>string</selectedValue>
            <selectedValue>string</selectedValue>
          </selectedValues>
        </Filter>
      </reportFilters>
      <sessionVariables>
        <KeyValue>
          <key>string</key>
          <value>string</value>
        </KeyValue>
        <KeyValue>
          <key>string</key>
          <value>string</value>
        </KeyValue>
      </sessionVariables>
    </exportReportToPPT>
  </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>
    <exportReportToPPTResponse xmlns="http://www.birst.com/">
      <exportReportToPPTResult>string</exportReportToPPTResult>
    </exportReportToPPTResponse>
  </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>
    <exportReportToPPT xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceId>string</spaceId>
      <reportPath>string</reportPath>
      <reportFilters>
        <Filter>
          <Operator>string</Operator>
          <multiSelectType>string</multiSelectType>
          <FilterType>string</FilterType>
          <ParameterName>string</ParameterName>
          <selectedValues>
            <selectedValue>string</selectedValue>
            <selectedValue>string</selectedValue>
          </selectedValues>
        </Filter>
        <Filter>
          <Operator>string</Operator>
          <multiSelectType>string</multiSelectType>
          <FilterType>string</FilterType>
          <ParameterName>string</ParameterName>
          <selectedValues>
            <selectedValue>string</selectedValue>
            <selectedValue>string</selectedValue>
          </selectedValues>
        </Filter>
      </reportFilters>
      <sessionVariables>
        <KeyValue>
          <key>string</key>
          <value>string</value>
        </KeyValue>
        <KeyValue>
          <key>string</key>
          <value>string</value>
        </KeyValue>
      </sessionVariables>
    </exportReportToPPT>
  </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>
    <exportReportToPPTResponse xmlns="http://www.birst.com/">
      <exportReportToPPTResult>string</exportReportToPPTResult>
    </exportReportToPPTResponse>
  </soap12:Body>
</soap12:Envelope>