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.

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

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