CommandWebService


Click here for a complete list of operations.

setUpRealTimeConnectionForSpace

Add real time connection information. Arguments are the Login token, the space Id, configFileName, connectionName, databaseType, useDirectConnection, host, port, databaseName, userName, password and timeout.

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

<?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>
    <setUpRealTimeConnectionForSpace xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <configFileName>string</configFileName>
      <connectionName>string</connectionName>
      <databaseType>string</databaseType>
      <useDirectConnection>boolean</useDirectConnection>
      <host>string</host>
      <port>int</port>
      <databaseName>string</databaseName>
      <userName>string</userName>
      <password>string</password>
      <timeout>int</timeout>
    </setUpRealTimeConnectionForSpace>
  </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>
    <setUpRealTimeConnectionForSpaceResponse xmlns="http://www.birst.com/">
      <setUpRealTimeConnectionForSpaceResult>boolean</setUpRealTimeConnectionForSpaceResult>
    </setUpRealTimeConnectionForSpaceResponse>
  </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>
    <setUpRealTimeConnectionForSpace xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <configFileName>string</configFileName>
      <connectionName>string</connectionName>
      <databaseType>string</databaseType>
      <useDirectConnection>boolean</useDirectConnection>
      <host>string</host>
      <port>int</port>
      <databaseName>string</databaseName>
      <userName>string</userName>
      <password>string</password>
      <timeout>int</timeout>
    </setUpRealTimeConnectionForSpace>
  </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>
    <setUpRealTimeConnectionForSpaceResponse xmlns="http://www.birst.com/">
      <setUpRealTimeConnectionForSpaceResult>boolean</setUpRealTimeConnectionForSpaceResult>
    </setUpRealTimeConnectionForSpaceResponse>
  </soap12:Body>
</soap12:Envelope>