Skip to main content
POST
/
activeviam
/
pivot
/
rest
/
v9
/
cube
/
dataexport
/
export
Export MDX query results to file
curl --request POST \
  --url http://localhost:9090/activeviam/pivot/rest/v9/cube/dataexport/export \
  --header 'Content-Type: application/json' \
  --data '
{
  "jsonMdxQuery": {
    "context": {},
    "mdx": "<string>"
  },
  "outputConfiguration": {
    "columnFormatters": [
      {}
    ],
    "fileConfiguration": {
      "directoryName": "<string>",
      "fileName": "<string>",
      "maxBatchesPerFile": 123,
      "maxLinesPerFile": 123,
      "useMultipleFiles": true,
      "useZipFile": true
    },
    "format": "<string>"
  }
}
'
import requests

url = "http://localhost:9090/activeviam/pivot/rest/v9/cube/dataexport/export"

payload = {
    "jsonMdxQuery": {
        "context": {},
        "mdx": "<string>"
    },
    "outputConfiguration": {
        "columnFormatters": [{}],
        "fileConfiguration": {
            "directoryName": "<string>",
            "fileName": "<string>",
            "maxBatchesPerFile": 123,
            "maxLinesPerFile": 123,
            "useMultipleFiles": True,
            "useZipFile": True
        },
        "format": "<string>"
    }
}
headers = {"Content-Type": "application/json"}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    jsonMdxQuery: {context: {}, mdx: '<string>'},
    outputConfiguration: {
      columnFormatters: [{}],
      fileConfiguration: {
        directoryName: '<string>',
        fileName: '<string>',
        maxBatchesPerFile: 123,
        maxLinesPerFile: 123,
        useMultipleFiles: true,
        useZipFile: true
      },
      format: '<string>'
    }
  })
};

fetch('http://localhost:9090/activeviam/pivot/rest/v9/cube/dataexport/export', 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 => "9090",
  CURLOPT_URL => "http://localhost:9090/activeviam/pivot/rest/v9/cube/dataexport/export",
  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([
    'jsonMdxQuery' => [
        'context' => [
                
        ],
        'mdx' => '<string>'
    ],
    'outputConfiguration' => [
        'columnFormatters' => [
                [
                                
                ]
        ],
        'fileConfiguration' => [
                'directoryName' => '<string>',
                'fileName' => '<string>',
                'maxBatchesPerFile' => 123,
                'maxLinesPerFile' => 123,
                'useMultipleFiles' => true,
                'useZipFile' => true
        ],
        'format' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "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://localhost:9090/activeviam/pivot/rest/v9/cube/dataexport/export"

	payload := strings.NewReader("{\n  \"jsonMdxQuery\": {\n    \"context\": {},\n    \"mdx\": \"<string>\"\n  },\n  \"outputConfiguration\": {\n    \"columnFormatters\": [\n      {}\n    ],\n    \"fileConfiguration\": {\n      \"directoryName\": \"<string>\",\n      \"fileName\": \"<string>\",\n      \"maxBatchesPerFile\": 123,\n      \"maxLinesPerFile\": 123,\n      \"useMultipleFiles\": true,\n      \"useZipFile\": true\n    },\n    \"format\": \"<string>\"\n  }\n}")

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

	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://localhost:9090/activeviam/pivot/rest/v9/cube/dataexport/export")
  .header("Content-Type", "application/json")
  .body("{\n  \"jsonMdxQuery\": {\n    \"context\": {},\n    \"mdx\": \"<string>\"\n  },\n  \"outputConfiguration\": {\n    \"columnFormatters\": [\n      {}\n    ],\n    \"fileConfiguration\": {\n      \"directoryName\": \"<string>\",\n      \"fileName\": \"<string>\",\n      \"maxBatchesPerFile\": 123,\n      \"maxLinesPerFile\": 123,\n      \"useMultipleFiles\": true,\n      \"useZipFile\": true\n    },\n    \"format\": \"<string>\"\n  }\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("http://localhost:9090/activeviam/pivot/rest/v9/cube/dataexport/export")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"jsonMdxQuery\": {\n    \"context\": {},\n    \"mdx\": \"<string>\"\n  },\n  \"outputConfiguration\": {\n    \"columnFormatters\": [\n      {}\n    ],\n    \"fileConfiguration\": {\n      \"directoryName\": \"<string>\",\n      \"fileName\": \"<string>\",\n      \"maxBatchesPerFile\": 123,\n      \"maxLinesPerFile\": 123,\n      \"useMultipleFiles\": true,\n      \"useZipFile\": true\n    },\n    \"format\": \"<string>\"\n  }\n}"

response = http.request(request)
puts response.read_body
{}
{
  "error": "Export failed",
  "message": "The cube does not exist"
}

Body

application/json

The MDX query to run and export options

jsonMdxQuery
object
outputConfiguration
object

Response

The export was a success

Empty export success response

Example:
{}