CommandWebService


Click here for a complete list of operations.

loadStagingtableFromS3Bucket

Direct Load Stagingtable from S3 bucket

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

<?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>
    <loadStagingtableFromS3Bucket xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <stagingDetails>
        <stagingTableName>string</stagingTableName>
        <sourceS3Path>string</sourceS3Path>
        <delimiter>string</delimiter>
        <columnNames>
          <string>string</string>
          <string>string</string>
        </columnNames>
        <awsKeyID>string</awsKeyID>
        <awsSecretKey>string</awsSecretKey>
        <awsTempToken>string</awsTempToken>
        <encryptionKey>string</encryptionKey>
        <dateFormat>string</dateFormat>
        <compressionFormat>string</compressionFormat>
        <ignoreHeaders>int</ignoreHeaders>
        <keepQuotes>boolean</keepQuotes>
        <skipEscape>boolean</skipEscape>
      </stagingDetails>
    </loadStagingtableFromS3Bucket>
  </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>
    <loadStagingtableFromS3BucketResponse xmlns="http://www.birst.com/">
      <loadStagingtableFromS3BucketResult>string</loadStagingtableFromS3BucketResult>
    </loadStagingtableFromS3BucketResponse>
  </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>
    <loadStagingtableFromS3Bucket xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <stagingDetails>
        <stagingTableName>string</stagingTableName>
        <sourceS3Path>string</sourceS3Path>
        <delimiter>string</delimiter>
        <columnNames>
          <string>string</string>
          <string>string</string>
        </columnNames>
        <awsKeyID>string</awsKeyID>
        <awsSecretKey>string</awsSecretKey>
        <awsTempToken>string</awsTempToken>
        <encryptionKey>string</encryptionKey>
        <dateFormat>string</dateFormat>
        <compressionFormat>string</compressionFormat>
        <ignoreHeaders>int</ignoreHeaders>
        <keepQuotes>boolean</keepQuotes>
        <skipEscape>boolean</skipEscape>
      </stagingDetails>
    </loadStagingtableFromS3Bucket>
  </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>
    <loadStagingtableFromS3BucketResponse xmlns="http://www.birst.com/">
      <loadStagingtableFromS3BucketResult>string</loadStagingtableFromS3BucketResult>
    </loadStagingtableFromS3BucketResponse>
  </soap12:Body>
</soap12:Envelope>