CommandWebService


Click here for a complete list of operations.

publishData

Start the processing of uploaded data sources. Arguments are Login token, space id, subgroups (if defined in the space), and the date to use as the load date. Returns a publishing token. Call getDetailedJobStatus and isJobComplete to check 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/publishData"

<?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>
    <publishData xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <subgroups>
        <string>string</string>
        <string>string</string>
      </subgroups>
      <date>dateTime</date>
    </publishData>
  </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>
    <publishDataResponse xmlns="http://www.birst.com/">
      <publishDataResult>string</publishDataResult>
    </publishDataResponse>
  </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>
    <publishData xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <subgroups>
        <string>string</string>
        <string>string</string>
      </subgroups>
      <date>dateTime</date>
    </publishData>
  </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>
    <publishDataResponse xmlns="http://www.birst.com/">
      <publishDataResult>string</publishDataResult>
    </publishDataResponse>
  </soap12:Body>
</soap12:Envelope>