Preview data available over provided connection

curl --request POST \
  --url http://10.2.4.166:8080/composer/api/connections/{connectionId}/preview \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/vnd.composer.v3+json' \
  --data '
{
  "connectionId": "<string>",
  "dataEntityName": "<string>",
  "dataEntityId": "<string>",
  "uploadId": "<string>",
  "collection": "<string>",
  "schema": "<string>",
  "collectionParams": {},
  "parameters": {},
  "partitions": {}
}
'

import requests

url = "http://10.2.4.166:8080/composer/api/connections/{connectionId}/preview"

payload = {
    "connectionId": "<string>",
    "dataEntityName": "<string>",
    "dataEntityId": "<string>",
    "uploadId": "<string>",
    "collection": "<string>",
    "schema": "<string>",
    "collectionParams": {},
    "parameters": {},
    "partitions": {}
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/vnd.composer.v3+json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Basic <encoded-value>',
    'Content-Type': 'application/vnd.composer.v3+json'
  },
  body: JSON.stringify({
    connectionId: '<string>',
    dataEntityName: '<string>',
    dataEntityId: '<string>',
    uploadId: '<string>',
    collection: '<string>',
    schema: '<string>',
    collectionParams: {},
    parameters: {},
    partitions: {}
  })
};

fetch('http://10.2.4.166:8080/composer/api/connections/{connectionId}/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/connections/{connectionId}/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 => json_encode([
    'connectionId' => '<string>',
    'dataEntityName' => '<string>',
    'dataEntityId' => '<string>',
    'uploadId' => '<string>',
    'collection' => '<string>',
    'schema' => '<string>',
    'collectionParams' => [
        
    ],
    'parameters' => [
        
    ],
    'partitions' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/vnd.composer.v3+json"
  ],
]);

$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/connections/{connectionId}/preview"

	payload := strings.NewReader("{\n  \"connectionId\": \"<string>\",\n  \"dataEntityName\": \"<string>\",\n  \"dataEntityId\": \"<string>\",\n  \"uploadId\": \"<string>\",\n  \"collection\": \"<string>\",\n  \"schema\": \"<string>\",\n  \"collectionParams\": {},\n  \"parameters\": {},\n  \"partitions\": {}\n}")

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

	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/vnd.composer.v3+json")

	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/connections/{connectionId}/preview")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/vnd.composer.v3+json")
  .body("{\n  \"connectionId\": \"<string>\",\n  \"dataEntityName\": \"<string>\",\n  \"dataEntityId\": \"<string>\",\n  \"uploadId\": \"<string>\",\n  \"collection\": \"<string>\",\n  \"schema\": \"<string>\",\n  \"collectionParams\": {},\n  \"parameters\": {},\n  \"partitions\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://10.2.4.166:8080/composer/api/connections/{connectionId}/preview")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/vnd.composer.v3+json'
request.body = "{\n  \"connectionId\": \"<string>\",\n  \"dataEntityName\": \"<string>\",\n  \"dataEntityId\": \"<string>\",\n  \"uploadId\": \"<string>\",\n  \"collection\": \"<string>\",\n  \"schema\": \"<string>\",\n  \"collectionParams\": {},\n  \"parameters\": {},\n  \"partitions\": {}\n}"

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

"<string>"

Preview data available over provided connection

curl --request POST \
  --url http://10.2.4.166:8080/composer/api/connections/{connectionId}/preview \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/vnd.composer.v3+json' \
  --data '
{
  "connectionId": "<string>",
  "dataEntityName": "<string>",
  "dataEntityId": "<string>",
  "uploadId": "<string>",
  "collection": "<string>",
  "schema": "<string>",
  "collectionParams": {},
  "parameters": {},
  "partitions": {}
}
'

import requests

url = "http://10.2.4.166:8080/composer/api/connections/{connectionId}/preview"

payload = {
    "connectionId": "<string>",
    "dataEntityName": "<string>",
    "dataEntityId": "<string>",
    "uploadId": "<string>",
    "collection": "<string>",
    "schema": "<string>",
    "collectionParams": {},
    "parameters": {},
    "partitions": {}
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/vnd.composer.v3+json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Basic <encoded-value>',
    'Content-Type': 'application/vnd.composer.v3+json'
  },
  body: JSON.stringify({
    connectionId: '<string>',
    dataEntityName: '<string>',
    dataEntityId: '<string>',
    uploadId: '<string>',
    collection: '<string>',
    schema: '<string>',
    collectionParams: {},
    parameters: {},
    partitions: {}
  })
};

fetch('http://10.2.4.166:8080/composer/api/connections/{connectionId}/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/connections/{connectionId}/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 => json_encode([
    'connectionId' => '<string>',
    'dataEntityName' => '<string>',
    'dataEntityId' => '<string>',
    'uploadId' => '<string>',
    'collection' => '<string>',
    'schema' => '<string>',
    'collectionParams' => [
        
    ],
    'parameters' => [
        
    ],
    'partitions' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/vnd.composer.v3+json"
  ],
]);

$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/connections/{connectionId}/preview"

	payload := strings.NewReader("{\n  \"connectionId\": \"<string>\",\n  \"dataEntityName\": \"<string>\",\n  \"dataEntityId\": \"<string>\",\n  \"uploadId\": \"<string>\",\n  \"collection\": \"<string>\",\n  \"schema\": \"<string>\",\n  \"collectionParams\": {},\n  \"parameters\": {},\n  \"partitions\": {}\n}")

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

	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/vnd.composer.v3+json")

	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/connections/{connectionId}/preview")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/vnd.composer.v3+json")
  .body("{\n  \"connectionId\": \"<string>\",\n  \"dataEntityName\": \"<string>\",\n  \"dataEntityId\": \"<string>\",\n  \"uploadId\": \"<string>\",\n  \"collection\": \"<string>\",\n  \"schema\": \"<string>\",\n  \"collectionParams\": {},\n  \"parameters\": {},\n  \"partitions\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://10.2.4.166:8080/composer/api/connections/{connectionId}/preview")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/vnd.composer.v3+json'
request.body = "{\n  \"connectionId\": \"<string>\",\n  \"dataEntityName\": \"<string>\",\n  \"dataEntityId\": \"<string>\",\n  \"uploadId\": \"<string>\",\n  \"collection\": \"<string>\",\n  \"schema\": \"<string>\",\n  \"collectionParams\": {},\n  \"parameters\": {},\n  \"partitions\": {}\n}"

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

"<string>"

Authorizations

Authorization

string

header

required

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

Path Parameters

connectionId

string

required

Query Parameters

limit

integer<int32>

required

Body

application/vnd.composer.v3+json

connectionId

string

dataEntityName

string

dataEntityId

string

dataEntityType

enum<string>

Available options:

SINGLE_COLLECTION,

CUSTOM_SQL,

INDEX,

UPLOAD

uploadId

string

collection

string

schema

string

collectionParams

object

Show child attributes

parameters

object

Show child attributes

partitions

object

Show child attributes

Response

200 - application/vnd.composer.v3+json;charset=UTF-8

The response is of type string.

Release Notes

Administer

Connect to Data

Present Data

Embed and Extend

Reference

Preview data available over provided connection

Authorizations

Path Parameters

Query Parameters

Body

Response