Export visual data in CSV, JSON or XLSX format, using Visual-Id
curl --request POST \
--url http://10.2.4.166:8080/composer/api/export/visualdata/{id} \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"formatting": {
"xlsx": {
"notes": [
{
"title": "<string>",
"description": "<string>"
}
],
"sheetName": "<string>"
}
}
}
'import requests
url = "http://10.2.4.166:8080/composer/api/export/visualdata/{id}"
payload = { "formatting": { "xlsx": {
"notes": [
{
"title": "<string>",
"description": "<string>"
}
],
"sheetName": "<string>"
} } }
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
formatting: {
xlsx: {notes: [{title: '<string>', description: '<string>'}], sheetName: '<string>'}
}
})
};
fetch('http://10.2.4.166:8080/composer/api/export/visualdata/{id}', 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/export/visualdata/{id}",
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([
'formatting' => [
'xlsx' => [
'notes' => [
[
'title' => '<string>',
'description' => '<string>'
]
],
'sheetName' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/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/export/visualdata/{id}"
payload := strings.NewReader("{\n \"formatting\": {\n \"xlsx\": {\n \"notes\": [\n {\n \"title\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"sheetName\": \"<string>\"\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/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/export/visualdata/{id}")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"formatting\": {\n \"xlsx\": {\n \"notes\": [\n {\n \"title\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"sheetName\": \"<string>\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://10.2.4.166:8080/composer/api/export/visualdata/{id}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"formatting\": {\n \"xlsx\": {\n \"notes\": [\n {\n \"title\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"sheetName\": \"<string>\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"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>"
}{
"timestamp": "2023-11-07T05:31:56Z",
"status": 123,
"error": "<string>",
"message": "<string>",
"path": "<string>"
}Export visual data in CSV, JSON or XLSX format, using Visual-Id
Requires DATA_ACCESS permission on the source
Export visual data in CSV, JSON or XLSX format, using Visual-Id
curl --request POST \
--url http://10.2.4.166:8080/composer/api/export/visualdata/{id} \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"formatting": {
"xlsx": {
"notes": [
{
"title": "<string>",
"description": "<string>"
}
],
"sheetName": "<string>"
}
}
}
'import requests
url = "http://10.2.4.166:8080/composer/api/export/visualdata/{id}"
payload = { "formatting": { "xlsx": {
"notes": [
{
"title": "<string>",
"description": "<string>"
}
],
"sheetName": "<string>"
} } }
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
formatting: {
xlsx: {notes: [{title: '<string>', description: '<string>'}], sheetName: '<string>'}
}
})
};
fetch('http://10.2.4.166:8080/composer/api/export/visualdata/{id}', 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/export/visualdata/{id}",
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([
'formatting' => [
'xlsx' => [
'notes' => [
[
'title' => '<string>',
'description' => '<string>'
]
],
'sheetName' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/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/export/visualdata/{id}"
payload := strings.NewReader("{\n \"formatting\": {\n \"xlsx\": {\n \"notes\": [\n {\n \"title\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"sheetName\": \"<string>\"\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/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/export/visualdata/{id}")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"formatting\": {\n \"xlsx\": {\n \"notes\": [\n {\n \"title\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"sheetName\": \"<string>\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://10.2.4.166:8080/composer/api/export/visualdata/{id}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"formatting\": {\n \"xlsx\": {\n \"notes\": [\n {\n \"title\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"sheetName\": \"<string>\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"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>"
}{
"timestamp": "2023-11-07T05:31:56Z",
"status": 123,
"error": "<string>",
"message": "<string>",
"path": "<string>"
}Authorizations
HTTP Basic authentication using global administrator credentials (username and password).
Path Parameters
Query Parameters
Body
application/json
Visual data export resource with visual id.
Visual data export formatting resource (with export format config).
Show child attributes
Show child attributes
Response
The data were exported
Was this page helpful?