CommandWebService
Click here for a complete list of operations.
getODBCMetaDataSubjectAreas
Get ODBC driver meta data - by subject area. Arguments are the Login token and the space Id.
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/getODBCMetaDataSubjectAreas" <?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> <getODBCMetaDataSubjectAreas xmlns="http://www.birst.com/"> <token>string</token> <spaceID>string</spaceID> </getODBCMetaDataSubjectAreas> </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> <getODBCMetaDataSubjectAreasResponse xmlns="http://www.birst.com/"> <getODBCMetaDataSubjectAreasResult> <tables> <ODBCTableResult> <tableName>string</tableName> <isFact>boolean</isFact> <columns xsi:nil="true" /> </ODBCTableResult> <ODBCTableResult> <tableName>string</tableName> <isFact>boolean</isFact> <columns xsi:nil="true" /> </ODBCTableResult> </tables> <relationships> <ODBCRelationshipResult> <primaryTable>string</primaryTable> <foreignTable>string</foreignTable> <primaryTableColumn>string</primaryTableColumn> <foreignTableColumn>string</foreignTableColumn> </ODBCRelationshipResult> <ODBCRelationshipResult> <primaryTable>string</primaryTable> <foreignTable>string</foreignTable> <primaryTableColumn>string</primaryTableColumn> <foreignTableColumn>string</foreignTableColumn> </ODBCRelationshipResult> </relationships> <errorCode>int</errorCode> <errorMessage>string</errorMessage> </getODBCMetaDataSubjectAreasResult> </getODBCMetaDataSubjectAreasResponse> </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> <getODBCMetaDataSubjectAreas xmlns="http://www.birst.com/"> <token>string</token> <spaceID>string</spaceID> </getODBCMetaDataSubjectAreas> </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> <getODBCMetaDataSubjectAreasResponse xmlns="http://www.birst.com/"> <getODBCMetaDataSubjectAreasResult> <tables> <ODBCTableResult> <tableName>string</tableName> <isFact>boolean</isFact> <columns xsi:nil="true" /> </ODBCTableResult> <ODBCTableResult> <tableName>string</tableName> <isFact>boolean</isFact> <columns xsi:nil="true" /> </ODBCTableResult> </tables> <relationships> <ODBCRelationshipResult> <primaryTable>string</primaryTable> <foreignTable>string</foreignTable> <primaryTableColumn>string</primaryTableColumn> <foreignTableColumn>string</foreignTableColumn> </ODBCRelationshipResult> <ODBCRelationshipResult> <primaryTable>string</primaryTable> <foreignTable>string</foreignTable> <primaryTableColumn>string</primaryTableColumn> <foreignTableColumn>string</foreignTableColumn> </ODBCRelationshipResult> </relationships> <errorCode>int</errorCode> <errorMessage>string</errorMessage> </getODBCMetaDataSubjectAreasResult> </getODBCMetaDataSubjectAreasResponse> </soap12:Body> </soap12:Envelope>