ExportData method

Exports the data of any generic object to an Excel file or a open XML file. If the object contains excluded values, those excluded values are not exported. This API has limited functionality and will not support CSV export from all types of objects. Consider using Excel export instead. Treemap and bar chart are not supported.

Default limitations in number of rows and columns

The default maximum number of rows and columns in the Excel export file is:

  • 1048566 rows per sheet. For pivot tables: 1048566 column dimensions. 10 rows can be added after the export.
  • 16384 columns per sheet. If the number of columns exceeds the limit, the exported file is truncated and a warning message is sent.

Default limitations in number of cells

The default maximum number of cells in the export file is:

  • 1000000 to export to an Excel file
  • 5000000 to export to a CSV file

The exported file is truncated if the number of cells exceeds the limit. A warning message with code 1000 is sent. There is an option to export only the possible values ( qExportState is P).

Default limitation in number of columns

The default maximum number of columns in the export file is:

  • 1000 to export to a CSV file

The exported file is truncated if the number of cells exceeds the limit. A warning message with code 1000 is sent.

There is an option to export only the possible values ( qExportState is P).

Default limitation in size

The default size limit of an export file is:

  • 10241024800 for an export to an Excel file.

If the exported file is larger than the maximum value, then an out-of-memory error with code 13000 is returned.

Exported files are temporary and are available only for a certain time span and only to the user who created them.



Parameters

Name Description Mandatory Type
qFileType

Type of the file to export.

One of:

  • CSV_C or EXPORT_CSV_C
  • CSV_T or EXPORT_CSV_T
  • OOXML or EXPORT_OOXML
 Yes String
qPath

Path to the definition of the object to be exported. For example, /qHyperCubeDef . This parameter is mandatory if the file type is _CSVC or _CSVT .

 No String
qFileName

Name of the exported file after download from browser. This parameter is optional and only used in Qlik Sense Desktop.

 No String
qExportState

Defines the values to be exported. The default value is A.

One of:

  • P or EXPORT_POSSIBLE
  • A or EXPORT_ALL
 No String

Returns

Name Description Type
qUrl

<url of the exported file>

 String
qWarnings

[1000]

 Array of Strings