CommandWebService Web Service

CommandWebService

Click here for a complete list of operations.

modifyRealTimeConnectionInformation

Modify real time connection information. Arguments are the Login token, the space id, the name of the connection, the host, the port, the name of the database, the user name, the password and the 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/modifyRealTimeConnectionInformation"

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