Export MDX query results to file

curl --request POST \
  --url http://localhost:9090/activeviam/pivot/rest/v10/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>"
  }
}
'

{}

Export MDX query results to file

Exports the result of a MDX query in CSV or Arrow format to a file in the server or in the cloud.

Local Server Export: Files are exported to directories under the system temporary directory:

Linux/Unix: /tmp/<directoryName>
Windows: C:\Users\<userName>\AppData\Local\Temp\<directoryName>

The target directory must already exist before export. The export will fail if the directory does not exist.

Cloud Export: Cloud exports are supported for configured cloud storage providers. For cloud exports, the directoryName should specify the cloud path (e.g., S3 bucket path).

POST

activeviam

pivot

rest

v10

cube

dataexport

export

Export MDX query results to file

curl --request POST \
  --url http://localhost:9090/activeviam/pivot/rest/v10/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>"
  }
}
'

{}

Body

application/json

The MDX query to run and export options

jsonMdxQuery

object

Show child attributes

outputConfiguration

object

Show child attributes

Response

The export was a success

Empty export success response

Example:

{}

⌘I