SOAP

The following is a sample SOAP request and response. The placeholders shown need to be replaced with actual values.

Request

POST /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/getODBCMetaData"

<?xml version="1.0" encoding="utf-8"?>
<s:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <getODBCMetaData xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
    </getODBCMetaData>
  </s:Body>
</s:Envelope>

Response

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <getODBCMetaDataResponse xmlns="http://www.birst.com/">
      <getODBCMetaDataResult>
        <tables>
          <ODBCTableResult>
            <tableName>string</tableName>
            <isFact>boolean</isFact>
            <columns>
              <ODBCColumnResult>
                <columnName>string</columnName>
                <birstColumnName>string</birstColumnName>
                <dataType>int</dataType>
                <width>int</width>
                <aggsSupported>
                  <string>string</string>
                </aggsSupported>
                <key>int</key>
                <isFact>boolean</isFact>
              </ODBCColumnResult>
            </columns>
          </ODBCTableResult>
        </tables>
        <relationships>
          <ODBCRelationshipResult>
            <primaryTable>string</primaryTable>
            <foreignTable>string</foreignTable>
            <primaryTableColumn>string</primaryTableColumn>
            <foreignTableColumn>string</foreignTableColumn>
          </ODBCRelationshipResult>
        </relationships>
        <errorCode>int</errorCode>
        <errorMessage>string</errorMessage>
      </getODBCMetaDataResult>
    </getODBCMetaDataResponse>
  </s:Body>
</s:Envelope>