Export raw data for visual in CSV, JSON or XLSX format, using Visual-Id

curl --request POST \
  --url http://10.2.4.166:8080/composer/api/export/rawdataforvisual/{id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "formatting": {
    "xlsx": {
      "notes": [
        {
          "title": "<string>",
          "description": "<string>"
        }
      ],
      "sheetName": "<string>"
    }
  },
  "postProcessing": {
    "sorts": [
      {
        "field": {
          "field": {
            "name": "<string>"
          }
        }
      }
    ],
    "limit": 123
  }
}
'

import requests

url = "http://10.2.4.166:8080/composer/api/export/rawdataforvisual/{id}"

payload = {
    "formatting": { "xlsx": {
            "notes": [
                {
                    "title": "<string>",
                    "description": "<string>"
                }
            ],
            "sheetName": "<string>"
        } },
    "postProcessing": {
        "sorts": [{ "field": { "field": { "name": "<string>" } } }],
        "limit": 123
    }
}
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>'}
    },
    postProcessing: {sorts: [{field: {field: {name: '<string>'}}}], limit: 123}
  })
};

fetch('http://10.2.4.166:8080/composer/api/export/rawdataforvisual/{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/rawdataforvisual/{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>'
        ]
    ],
    'postProcessing' => [
        'sorts' => [
                [
                                'field' => [
                                                                'field' => [
                                                                                                                                'name' => '<string>'
                                                                ]
                                ]
                ]
        ],
        'limit' => 123
    ]
  ]),
  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/rawdataforvisual/{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  \"postProcessing\": {\n    \"sorts\": [\n      {\n        \"field\": {\n          \"field\": {\n            \"name\": \"<string>\"\n          }\n        }\n      }\n    ],\n    \"limit\": 123\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/rawdataforvisual/{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  \"postProcessing\": {\n    \"sorts\": [\n      {\n        \"field\": {\n          \"field\": {\n            \"name\": \"<string>\"\n          }\n        }\n      }\n    ],\n    \"limit\": 123\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://10.2.4.166:8080/composer/api/export/rawdataforvisual/{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  \"postProcessing\": {\n    \"sorts\": [\n      {\n        \"field\": {\n          \"field\": {\n            \"name\": \"<string>\"\n          }\n        }\n      }\n    ],\n    \"limit\": 123\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 raw data for visual in CSV, JSON or XLSX format, using Visual-Id

curl --request POST \
  --url http://10.2.4.166:8080/composer/api/export/rawdataforvisual/{id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "formatting": {
    "xlsx": {
      "notes": [
        {
          "title": "<string>",
          "description": "<string>"
        }
      ],
      "sheetName": "<string>"
    }
  },
  "postProcessing": {
    "sorts": [
      {
        "field": {
          "field": {
            "name": "<string>"
          }
        }
      }
    ],
    "limit": 123
  }
}
'

import requests

url = "http://10.2.4.166:8080/composer/api/export/rawdataforvisual/{id}"

payload = {
    "formatting": { "xlsx": {
            "notes": [
                {
                    "title": "<string>",
                    "description": "<string>"
                }
            ],
            "sheetName": "<string>"
        } },
    "postProcessing": {
        "sorts": [{ "field": { "field": { "name": "<string>" } } }],
        "limit": 123
    }
}
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>'}
    },
    postProcessing: {sorts: [{field: {field: {name: '<string>'}}}], limit: 123}
  })
};

fetch('http://10.2.4.166:8080/composer/api/export/rawdataforvisual/{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/rawdataforvisual/{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>'
        ]
    ],
    'postProcessing' => [
        'sorts' => [
                [
                                'field' => [
                                                                'field' => [
                                                                                                                                'name' => '<string>'
                                                                ]
                                ]
                ]
        ],
        'limit' => 123
    ]
  ]),
  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/rawdataforvisual/{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  \"postProcessing\": {\n    \"sorts\": [\n      {\n        \"field\": {\n          \"field\": {\n            \"name\": \"<string>\"\n          }\n        }\n      }\n    ],\n    \"limit\": 123\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/rawdataforvisual/{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  \"postProcessing\": {\n    \"sorts\": [\n      {\n        \"field\": {\n          \"field\": {\n            \"name\": \"<string>\"\n          }\n        }\n      }\n    ],\n    \"limit\": 123\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://10.2.4.166:8080/composer/api/export/rawdataforvisual/{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  \"postProcessing\": {\n    \"sorts\": [\n      {\n        \"field\": {\n          \"field\": {\n            \"name\": \"<string>\"\n          }\n        }\n      }\n    ],\n    \"limit\": 123\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

Authorization

string

header

required

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

Path Parameters

string

required

Body

application/json

Raw data for visual export resource with visual id.

formatting

object

required

Raw data export formatting resource (with export format config).

Show child attributes

postProcessing

object

Show child attributes

Response

The data were exported

Release Notes

Administer

Connect to Data

Present Data

Embed and Extend

Reference

Export raw data for visual in CSV, JSON or XLSX format, using Visual-Id

Authorizations

Path Parameters

Body

Response