CommandWebService Web Service

CommandWebService

Click here for a complete list of operations.

scheduleExportReport

Schedules a report to be exported and sent to given email addresses

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

<?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>
    <scheduleExportReport xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceId>string</spaceId>
      <reportPath>string</reportPath>
      <prompts>
        <applyAllPrompts>string</applyAllPrompts>
        <promptsArray>
          <Prompt>
            <ParameterName>string</ParameterName>
            <Operator>string</Operator>
            <IsExpression>string</IsExpression>
            <multiSelectType>string</multiSelectType>
            <selectedValues xsi:nil="true" />
          </Prompt>
          <Prompt>
            <ParameterName>string</ParameterName>
            <Operator>string</Operator>
            <IsExpression>string</IsExpression>
            <multiSelectType>string</multiSelectType>
            <selectedValues xsi:nil="true" />
          </Prompt>
        </promptsArray>
      </prompts>
      <toList>
        <string>string</string>
        <string>string</string>
      </toList>
      <emailBody>string</emailBody>
      <sessionVariables>
        <KeyValue>
          <key>string</key>
          <value>string</value>
        </KeyValue>
        <KeyValue>
          <key>string</key>
          <value>string</value>
        </KeyValue>
      </sessionVariables>
    </scheduleExportReport>
  </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>
    <scheduleExportReportResponse xmlns="http://www.birst.com/">
      <scheduleExportReportResult>string</scheduleExportReportResult>
    </scheduleExportReportResponse>
  </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>
    <scheduleExportReport xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceId>string</spaceId>
      <reportPath>string</reportPath>
      <prompts>
        <applyAllPrompts>string</applyAllPrompts>
        <promptsArray>
          <Prompt>
            <ParameterName>string</ParameterName>
            <Operator>string</Operator>
            <IsExpression>string</IsExpression>
            <multiSelectType>string</multiSelectType>
            <selectedValues xsi:nil="true" />
          </Prompt>
          <Prompt>
            <ParameterName>string</ParameterName>
            <Operator>string</Operator>
            <IsExpression>string</IsExpression>
            <multiSelectType>string</multiSelectType>
            <selectedValues xsi:nil="true" />
          </Prompt>
        </promptsArray>
      </prompts>
      <toList>
        <string>string</string>
        <string>string</string>
      </toList>
      <emailBody>string</emailBody>
      <sessionVariables>
        <KeyValue>
          <key>string</key>
          <value>string</value>
        </KeyValue>
        <KeyValue>
          <key>string</key>
          <value>string</value>
        </KeyValue>
      </sessionVariables>
    </scheduleExportReport>
  </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>
    <scheduleExportReportResponse xmlns="http://www.birst.com/">
      <scheduleExportReportResult>string</scheduleExportReportResult>
    </scheduleExportReportResponse>
  </soap12:Body>
</soap12:Envelope>