CommandWebService


Click here for a complete list of operations.

getJobStatus

Get the status of an asynchronous job after it has completed. Arguments include the Login token and the job token. Returns an XML representation of the status.

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

<?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>
    <getJobStatus xmlns="http://www.birst.com/">
      <token>string</token>
      <jobToken>string</jobToken>
    </getJobStatus>
  </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">
    <getJobStatusResponse xmlns="http://www.birst.com/">
      <getJobStatusResult>
        <processingGroup>string</processingGroup>
        <type>int</type>
        <loadid>int</loadid>
        <message>string</message>
        <statusCode>string</statusCode>
      </getJobStatusResult>
    </getJobStatusResponse>
  </s:Body>
</s:Envelope>