CommandWebService


Click here for a complete list of operations.

getDataCharacteristics

Gets data characteristics for given source.Argments are Login token, space Id and sourceName. This API should only be used for sources getting extracted through SFTP connector. Please use the "Data Characteristics" option in Modeler Connect for sources extracted using other connectors.

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

<?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>
    <getDataCharacteristics xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <sourceName>string</sourceName>
    </getDataCharacteristics>
  </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>
    <getDataCharacteristicsResponse xmlns="http://www.birst.com/">
      <getDataCharacteristicsResult>
        <OnlyQuoteAfterSeparator>string</OnlyQuoteAfterSeparator>
        <DoNotTreatCarriageReturnAsNewline>string</DoNotTreatCarriageReturnAsNewline>
        <HasHeaders>string</HasHeaders>
        <ForceNumColumns>string</ForceNumColumns>
        <Separator>string</Separator>
        <IgnoredRows>string</IgnoredRows>
        <IgnoredLastRows>string</IgnoredLastRows>
        <Quote>string</Quote>
        <Encoding>string</Encoding>
      </getDataCharacteristicsResult>
    </getDataCharacteristicsResponse>
  </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>
    <getDataCharacteristics xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <sourceName>string</sourceName>
    </getDataCharacteristics>
  </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>
    <getDataCharacteristicsResponse xmlns="http://www.birst.com/">
      <getDataCharacteristicsResult>
        <OnlyQuoteAfterSeparator>string</OnlyQuoteAfterSeparator>
        <DoNotTreatCarriageReturnAsNewline>string</DoNotTreatCarriageReturnAsNewline>
        <HasHeaders>string</HasHeaders>
        <ForceNumColumns>string</ForceNumColumns>
        <Separator>string</Separator>
        <IgnoredRows>string</IgnoredRows>
        <IgnoredLastRows>string</IgnoredLastRows>
        <Quote>string</Quote>
        <Encoding>string</Encoding>
      </getDataCharacteristicsResult>
    </getDataCharacteristicsResponse>
  </soap12:Body>
</soap12:Envelope>