CommandWebService Web Service

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.

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

<?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>
    <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>
  </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>
    <setDataCharacteristicsResponse xmlns="http://www.birst.com/" />
  </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>
    <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>
  </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>
    <setDataCharacteristicsResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>