CommandWebService


Click here for a complete list of operations.

mapLiveAccessSource

Adds or Updates Live Access source. Arguments are the login token, space Id, and the source meta data.

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

<?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>
    <mapLiveAccessSource xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <sourceMetadata>
        <Connection>string</Connection>
        <SourceName>string</SourceName>
        <IsQuerySource>boolean</IsQuerySource>
        <PhysicalTableName>string</PhysicalTableName>
        <Query>string</Query>
        <SchemaName>string</SchemaName>
      </sourceMetadata>
    </mapLiveAccessSource>
  </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>
    <mapLiveAccessSourceResponse 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>
    <mapLiveAccessSource xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <sourceMetadata>
        <Connection>string</Connection>
        <SourceName>string</SourceName>
        <IsQuerySource>boolean</IsQuerySource>
        <PhysicalTableName>string</PhysicalTableName>
        <Query>string</Query>
        <SchemaName>string</SchemaName>
      </sourceMetadata>
    </mapLiveAccessSource>
  </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>
    <mapLiveAccessSourceResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>