CommandWebService

Click here for a complete list of operations.

setDataCharacteristics

Sets data characteristics for given source. Argments are Login token, space Id, sourceName and data characteristics. Possible data characteristics options and value formats are: OnlyQuoteAfterSeparator=[true|false], DoNotTreatCarriageReturnAsNewline=[true|false], HasHeaders=[true|false], ForceNumColumns=[true|false], Separator=[char], IgnoredRows=[number], IgnoredLastRows=[number], Quote=[char], Encoding=[string]. 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.

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

<?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>
    <setDataCharacteristics xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <sourceName>string</sourceName>
      <dataCharacteristics>
        <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>
      </dataCharacteristics>
    </setDataCharacteristics>
  </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">
    <setDataCharacteristicsResponse xmlns="http://www.birst.com/">
    </setDataCharacteristicsResponse>
  </s:Body>
</s:Envelope>