CommandWebService Web Service

CommandWebService

Click here for a complete list of operations.

getSourceDetails

Gets source data. Argments are the Login token, the space Id and the sourceName

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

<?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>
    <getSourceDetails xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <sourceName>string</sourceName>
    </getSourceDetails>
  </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>
    <getSourceDetailsResponse xmlns="http://www.birst.com/">
      <getSourceDetailsResult>
        <Name>string</Name>
        <OriginalName>string</OriginalName>
        <Disabled>boolean</Disabled>
        <Script>
          <InputQuery>string</InputQuery>
          <Output>string</Output>
          <Script>string</Script>
        </Script>
        <LastModifiedDate>dateTime</LastModifiedDate>
        <SubGroups>
          <string>string</string>
          <string>string</string>
        </SubGroups>
        <Columns>
          <SourceColumnSubClass>
            <Name>string</Name>
            <OriginalName>string</OriginalName>
            <AnalyzeMeasure>boolean</AnalyzeMeasure>
            <DataType>string</DataType>
            <Format>string</Format>
            <EnableSecutityFilter>boolean</EnableSecutityFilter>
            <SourceFileColumn>string</SourceFileColumn>
            <TargetAggregations xsi:nil="true" />
            <TargetTypes xsi:nil="true" />
            <UnknownValue>string</UnknownValue>
            <Width>int</Width>
            <HierarchyName>string</HierarchyName>
            <LevelName>string</LevelName>
            <Levels xsi:nil="true" />
            <AnalyzeByDate>boolean</AnalyzeByDate>
            <Measure>boolean</Measure>
            <LockType>boolean</LockType>
          </SourceColumnSubClass>
          <SourceColumnSubClass>
            <Name>string</Name>
            <OriginalName>string</OriginalName>
            <AnalyzeMeasure>boolean</AnalyzeMeasure>
            <DataType>string</DataType>
            <Format>string</Format>
            <EnableSecutityFilter>boolean</EnableSecutityFilter>
            <SourceFileColumn>string</SourceFileColumn>
            <TargetAggregations xsi:nil="true" />
            <TargetTypes xsi:nil="true" />
            <UnknownValue>string</UnknownValue>
            <Width>int</Width>
            <HierarchyName>string</HierarchyName>
            <LevelName>string</LevelName>
            <Levels xsi:nil="true" />
            <AnalyzeByDate>boolean</AnalyzeByDate>
            <Measure>boolean</Measure>
            <LockType>boolean</LockType>
          </SourceColumnSubClass>
        </Columns>
      </getSourceDetailsResult>
    </getSourceDetailsResponse>
  </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>
    <getSourceDetails xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <sourceName>string</sourceName>
    </getSourceDetails>
  </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>
    <getSourceDetailsResponse xmlns="http://www.birst.com/">
      <getSourceDetailsResult>
        <Name>string</Name>
        <OriginalName>string</OriginalName>
        <Disabled>boolean</Disabled>
        <Script>
          <InputQuery>string</InputQuery>
          <Output>string</Output>
          <Script>string</Script>
        </Script>
        <LastModifiedDate>dateTime</LastModifiedDate>
        <SubGroups>
          <string>string</string>
          <string>string</string>
        </SubGroups>
        <Columns>
          <SourceColumnSubClass>
            <Name>string</Name>
            <OriginalName>string</OriginalName>
            <AnalyzeMeasure>boolean</AnalyzeMeasure>
            <DataType>string</DataType>
            <Format>string</Format>
            <EnableSecutityFilter>boolean</EnableSecutityFilter>
            <SourceFileColumn>string</SourceFileColumn>
            <TargetAggregations xsi:nil="true" />
            <TargetTypes xsi:nil="true" />
            <UnknownValue>string</UnknownValue>
            <Width>int</Width>
            <HierarchyName>string</HierarchyName>
            <LevelName>string</LevelName>
            <Levels xsi:nil="true" />
            <AnalyzeByDate>boolean</AnalyzeByDate>
            <Measure>boolean</Measure>
            <LockType>boolean</LockType>
          </SourceColumnSubClass>
          <SourceColumnSubClass>
            <Name>string</Name>
            <OriginalName>string</OriginalName>
            <AnalyzeMeasure>boolean</AnalyzeMeasure>
            <DataType>string</DataType>
            <Format>string</Format>
            <EnableSecutityFilter>boolean</EnableSecutityFilter>
            <SourceFileColumn>string</SourceFileColumn>
            <TargetAggregations xsi:nil="true" />
            <TargetTypes xsi:nil="true" />
            <UnknownValue>string</UnknownValue>
            <Width>int</Width>
            <HierarchyName>string</HierarchyName>
            <LevelName>string</LevelName>
            <Levels xsi:nil="true" />
            <AnalyzeByDate>boolean</AnalyzeByDate>
            <Measure>boolean</Measure>
            <LockType>boolean</LockType>
          </SourceColumnSubClass>
        </Columns>
      </getSourceDetailsResult>
    </getSourceDetailsResponse>
  </soap12:Body>
</soap12:Envelope>