CommandWebService Web Service

CommandWebService

Click here for a complete list of operations.

submitExportJob

Kicks off an export job

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

<?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>
    <submitExportJob xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceId>string</spaceId>
      <jobRequest>
        <exportData>
          <ExportData>
            <name>string</name>
            <collection>string</collection>
            <bookmark>string</bookmark>
            <filters xsi:nil="true" />
          </ExportData>
          <ExportData>
            <name>string</name>
            <collection>string</collection>
            <bookmark>string</bookmark>
            <filters xsi:nil="true" />
          </ExportData>
        </exportData>
        <sessionVars>
          <SessionVar>
            <key>string</key>
            <value>string</value>
            <label>string</label>
          </SessionVar>
          <SessionVar>
            <key>string</key>
            <value>string</value>
            <label>string</label>
          </SessionVar>
        </sessionVars>
        <deliveryMethod>EMAIL or URL</deliveryMethod>
        <viewPortOptions>
          <height>int</height>
          <width>int</width>
        </viewPortOptions>
        <printOptions>
          <marginLeft>
            <value>float</value>
            <type>px or in or cm or mm</type>
          </marginLeft>
          <marginRight>
            <value>float</value>
            <type>px or in or cm or mm</type>
          </marginRight>
          <marginBottom>
            <value>float</value>
            <type>px or in or cm or mm</type>
          </marginBottom>
          <marginTop>
            <value>float</value>
            <type>px or in or cm or mm</type>
          </marginTop>
          <orientation>PORTRAIT or LANDSCAPE</orientation>
          <paperHeight>
            <value>float</value>
            <type>px or in or cm or mm</type>
          </paperHeight>
          <paperWidth>
            <value>float</value>
            <type>px or in or cm or mm</type>
          </paperWidth>
          <paperFormat>LEGAL or LETTER or A4</paperFormat>
          <dashletOnWholePage>boolean</dashletOnWholePage>
          <printAllDashlets>boolean</printAllDashlets>
        </printOptions>
        <format>PDF or EXCEL or PPT</format>
        <printSessionVars>boolean</printSessionVars>
      </jobRequest>
    </submitExportJob>
  </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>
    <submitExportJobResponse xmlns="http://www.birst.com/">
      <submitExportJobResult>string</submitExportJobResult>
    </submitExportJobResponse>
  </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>
    <submitExportJob xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceId>string</spaceId>
      <jobRequest>
        <exportData>
          <ExportData>
            <name>string</name>
            <collection>string</collection>
            <bookmark>string</bookmark>
            <filters xsi:nil="true" />
          </ExportData>
          <ExportData>
            <name>string</name>
            <collection>string</collection>
            <bookmark>string</bookmark>
            <filters xsi:nil="true" />
          </ExportData>
        </exportData>
        <sessionVars>
          <SessionVar>
            <key>string</key>
            <value>string</value>
            <label>string</label>
          </SessionVar>
          <SessionVar>
            <key>string</key>
            <value>string</value>
            <label>string</label>
          </SessionVar>
        </sessionVars>
        <deliveryMethod>EMAIL or URL</deliveryMethod>
        <viewPortOptions>
          <height>int</height>
          <width>int</width>
        </viewPortOptions>
        <printOptions>
          <marginLeft>
            <value>float</value>
            <type>px or in or cm or mm</type>
          </marginLeft>
          <marginRight>
            <value>float</value>
            <type>px or in or cm or mm</type>
          </marginRight>
          <marginBottom>
            <value>float</value>
            <type>px or in or cm or mm</type>
          </marginBottom>
          <marginTop>
            <value>float</value>
            <type>px or in or cm or mm</type>
          </marginTop>
          <orientation>PORTRAIT or LANDSCAPE</orientation>
          <paperHeight>
            <value>float</value>
            <type>px or in or cm or mm</type>
          </paperHeight>
          <paperWidth>
            <value>float</value>
            <type>px or in or cm or mm</type>
          </paperWidth>
          <paperFormat>LEGAL or LETTER or A4</paperFormat>
          <dashletOnWholePage>boolean</dashletOnWholePage>
          <printAllDashlets>boolean</printAllDashlets>
        </printOptions>
        <format>PDF or EXCEL or PPT</format>
        <printSessionVars>boolean</printSessionVars>
      </jobRequest>
    </submitExportJob>
  </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>
    <submitExportJobResponse xmlns="http://www.birst.com/">
      <submitExportJobResult>string</submitExportJobResult>
    </submitExportJobResponse>
  </soap12:Body>
</soap12:Envelope>