Returns data preview of the provided file

curl --request POST \
  --url http://10.2.4.166:8080/composer/api/uploads/preview \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: multipart/form-data' \
  --form fileData=@example-file \
  --form 'uploadRequest={
  "name": "<string>",
  "description": "<string>",
  "delimiter": "<string>",
  "quoteCharacter": "<string>",
  "includesHeader": true,
  "ignoreUnknownFields": true,
  "disableDetectEpochDate": true,
  "parsedDelimiter": "<string>",
  "parsedQuoteCharacter": "<string>"
}'

import requests

url = "http://10.2.4.166:8080/composer/api/uploads/preview"

files = { "fileData": ("example-file", open("example-file", "rb")) }
payload = { "uploadRequest": "{
  \"name\": \"<string>\",
  \"description\": \"<string>\",
  \"delimiter\": \"<string>\",
  \"quoteCharacter\": \"<string>\",
  \"includesHeader\": true,
  \"ignoreUnknownFields\": true,
  \"disableDetectEpochDate\": true,
  \"parsedDelimiter\": \"<string>\",
  \"parsedQuoteCharacter\": \"<string>\"
}" }
headers = {"Authorization": "Basic <encoded-value>"}

response = requests.post(url, data=payload, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('fileData', '<string>');
form.append('uploadRequest', '{
  "name": "<string>",
  "description": "<string>",
  "delimiter": "<string>",
  "quoteCharacter": "<string>",
  "includesHeader": true,
  "ignoreUnknownFields": true,
  "disableDetectEpochDate": true,
  "parsedDelimiter": "<string>",
  "parsedQuoteCharacter": "<string>"
}');

const options = {method: 'POST', headers: {Authorization: 'Basic <encoded-value>'}};

options.body = form;

fetch('http://10.2.4.166:8080/composer/api/uploads/preview', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "8080",
  CURLOPT_URL => "http://10.2.4.166:8080/composer/api/uploads/preview",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"fileData\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"uploadRequest\"\r\n\r\n{\r\n  \"name\": \"<string>\",\r\n  \"description\": \"<string>\",\r\n  \"delimiter\": \"<string>\",\r\n  \"quoteCharacter\": \"<string>\",\r\n  \"includesHeader\": true,\r\n  \"ignoreUnknownFields\": true,\r\n  \"disableDetectEpochDate\": true,\r\n  \"parsedDelimiter\": \"<string>\",\r\n  \"parsedQuoteCharacter\": \"<string>\"\r\n}\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: multipart/form-data"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "http://10.2.4.166:8080/composer/api/uploads/preview"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"fileData\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"uploadRequest\"\r\n\r\n{\r\n  \"name\": \"<string>\",\r\n  \"description\": \"<string>\",\r\n  \"delimiter\": \"<string>\",\r\n  \"quoteCharacter\": \"<string>\",\r\n  \"includesHeader\": true,\r\n  \"ignoreUnknownFields\": true,\r\n  \"disableDetectEpochDate\": true,\r\n  \"parsedDelimiter\": \"<string>\",\r\n  \"parsedQuoteCharacter\": \"<string>\"\r\n}\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("http://10.2.4.166:8080/composer/api/uploads/preview")
  .header("Authorization", "Basic <encoded-value>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"fileData\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"uploadRequest\"\r\n\r\n{\r\n  \"name\": \"<string>\",\r\n  \"description\": \"<string>\",\r\n  \"delimiter\": \"<string>\",\r\n  \"quoteCharacter\": \"<string>\",\r\n  \"includesHeader\": true,\r\n  \"ignoreUnknownFields\": true,\r\n  \"disableDetectEpochDate\": true,\r\n  \"parsedDelimiter\": \"<string>\",\r\n  \"parsedQuoteCharacter\": \"<string>\"\r\n}\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://10.2.4.166:8080/composer/api/uploads/preview")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"fileData\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"uploadRequest\"\r\n\r\n{\r\n  \"name\": \"<string>\",\r\n  \"description\": \"<string>\",\r\n  \"delimiter\": \"<string>\",\r\n  \"quoteCharacter\": \"<string>\",\r\n  \"includesHeader\": true,\r\n  \"ignoreUnknownFields\": true,\r\n  \"disableDetectEpochDate\": true,\r\n  \"parsedDelimiter\": \"<string>\",\r\n  \"parsedQuoteCharacter\": \"<string>\"\r\n}\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

{
  "metadata": [
    {
      "name": "<string>"
    }
  ],
  "data": [
    [
      "<unknown>"
    ]
  ]
}

{
  "error": "<string>",
  "details": "<string>",
  "message": "<string>",
  "path": "<string>",
  "status": "<string>",
  "code": "<string>",
  "errorCode": "<string>",
  "timestamp": "<string>",
  "problems": [
    {
      "name": "<string>",
      "message": "<string>",
      "level": "ERROR",
      "dependencies": {}
    }
  ]
}

{
  "timestamp": "2023-11-07T05:31:56Z",
  "status": 123,
  "error": "<string>",
  "message": "<string>",
  "path": "<string>"
}

{
  "error": "<string>",
  "details": "<string>",
  "message": "<string>",
  "path": "<string>",
  "status": "<string>",
  "code": "<string>",
  "errorCode": "<string>",
  "timestamp": "<string>",
  "problems": [
    {
      "name": "<string>",
      "message": "<string>",
      "level": "ERROR",
      "dependencies": {}
    }
  ]
}

Returns data preview of the provided file

curl --request POST \
  --url http://10.2.4.166:8080/composer/api/uploads/preview \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: multipart/form-data' \
  --form fileData=@example-file \
  --form 'uploadRequest={
  "name": "<string>",
  "description": "<string>",
  "delimiter": "<string>",
  "quoteCharacter": "<string>",
  "includesHeader": true,
  "ignoreUnknownFields": true,
  "disableDetectEpochDate": true,
  "parsedDelimiter": "<string>",
  "parsedQuoteCharacter": "<string>"
}'

import requests

url = "http://10.2.4.166:8080/composer/api/uploads/preview"

files = { "fileData": ("example-file", open("example-file", "rb")) }
payload = { "uploadRequest": "{
  \"name\": \"<string>\",
  \"description\": \"<string>\",
  \"delimiter\": \"<string>\",
  \"quoteCharacter\": \"<string>\",
  \"includesHeader\": true,
  \"ignoreUnknownFields\": true,
  \"disableDetectEpochDate\": true,
  \"parsedDelimiter\": \"<string>\",
  \"parsedQuoteCharacter\": \"<string>\"
}" }
headers = {"Authorization": "Basic <encoded-value>"}

response = requests.post(url, data=payload, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('fileData', '<string>');
form.append('uploadRequest', '{
  "name": "<string>",
  "description": "<string>",
  "delimiter": "<string>",
  "quoteCharacter": "<string>",
  "includesHeader": true,
  "ignoreUnknownFields": true,
  "disableDetectEpochDate": true,
  "parsedDelimiter": "<string>",
  "parsedQuoteCharacter": "<string>"
}');

const options = {method: 'POST', headers: {Authorization: 'Basic <encoded-value>'}};

options.body = form;

fetch('http://10.2.4.166:8080/composer/api/uploads/preview', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "8080",
  CURLOPT_URL => "http://10.2.4.166:8080/composer/api/uploads/preview",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"fileData\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"uploadRequest\"\r\n\r\n{\r\n  \"name\": \"<string>\",\r\n  \"description\": \"<string>\",\r\n  \"delimiter\": \"<string>\",\r\n  \"quoteCharacter\": \"<string>\",\r\n  \"includesHeader\": true,\r\n  \"ignoreUnknownFields\": true,\r\n  \"disableDetectEpochDate\": true,\r\n  \"parsedDelimiter\": \"<string>\",\r\n  \"parsedQuoteCharacter\": \"<string>\"\r\n}\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: multipart/form-data"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "http://10.2.4.166:8080/composer/api/uploads/preview"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"fileData\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"uploadRequest\"\r\n\r\n{\r\n  \"name\": \"<string>\",\r\n  \"description\": \"<string>\",\r\n  \"delimiter\": \"<string>\",\r\n  \"quoteCharacter\": \"<string>\",\r\n  \"includesHeader\": true,\r\n  \"ignoreUnknownFields\": true,\r\n  \"disableDetectEpochDate\": true,\r\n  \"parsedDelimiter\": \"<string>\",\r\n  \"parsedQuoteCharacter\": \"<string>\"\r\n}\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("http://10.2.4.166:8080/composer/api/uploads/preview")
  .header("Authorization", "Basic <encoded-value>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"fileData\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"uploadRequest\"\r\n\r\n{\r\n  \"name\": \"<string>\",\r\n  \"description\": \"<string>\",\r\n  \"delimiter\": \"<string>\",\r\n  \"quoteCharacter\": \"<string>\",\r\n  \"includesHeader\": true,\r\n  \"ignoreUnknownFields\": true,\r\n  \"disableDetectEpochDate\": true,\r\n  \"parsedDelimiter\": \"<string>\",\r\n  \"parsedQuoteCharacter\": \"<string>\"\r\n}\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://10.2.4.166:8080/composer/api/uploads/preview")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"fileData\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"uploadRequest\"\r\n\r\n{\r\n  \"name\": \"<string>\",\r\n  \"description\": \"<string>\",\r\n  \"delimiter\": \"<string>\",\r\n  \"quoteCharacter\": \"<string>\",\r\n  \"includesHeader\": true,\r\n  \"ignoreUnknownFields\": true,\r\n  \"disableDetectEpochDate\": true,\r\n  \"parsedDelimiter\": \"<string>\",\r\n  \"parsedQuoteCharacter\": \"<string>\"\r\n}\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

{
  "metadata": [
    {
      "name": "<string>"
    }
  ],
  "data": [
    [
      "<unknown>"
    ]
  ]
}

{
  "error": "<string>",
  "details": "<string>",
  "message": "<string>",
  "path": "<string>",
  "status": "<string>",
  "code": "<string>",
  "errorCode": "<string>",
  "timestamp": "<string>",
  "problems": [
    {
      "name": "<string>",
      "message": "<string>",
      "level": "ERROR",
      "dependencies": {}
    }
  ]
}

{
  "timestamp": "2023-11-07T05:31:56Z",
  "status": 123,
  "error": "<string>",
  "message": "<string>",
  "path": "<string>"
}

{
  "error": "<string>",
  "details": "<string>",
  "message": "<string>",
  "path": "<string>",
  "status": "<string>",
  "code": "<string>",
  "errorCode": "<string>",
  "timestamp": "<string>",
  "problems": [
    {
      "name": "<string>",
      "message": "<string>",
      "level": "ERROR",
      "dependencies": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

HTTP Basic authentication using global administrator credentials (username and password).

Query Parameters

maxResults

integer<int32>

default:10

Body

fileData

file

required

uploadRequest

object

(experimental) Upload create request

Show child attributes

Response

The file was processed successfully

metadata

object[]

Fields metadata for the data

Show child attributes

data

any[][]

Data in tabular format. Field name can be retrieved from metadata by index

Release Notes

Administer

Connect to Data

Present Data

Embed and Extend

Reference

Returns data preview of the provided file

Authorizations

Query Parameters

Body

Response