If you need to export your data, from custom tables or from system tables, you should use this API.
Essentially, you have to write a query and the system will return you the full result set of the query.
No pagination is done but the results are streamed in the most efficient way.
The result is encoded using the CSV format, with UTF-8 encoding, no field delimiter, semicolon as field separator and windows line separator.
You can set these parameters in query string url request.
bulkdownload
POST https://apiserver/ws/rest/api/v19/export/bulkdownload
Request Body example (place the CSV option parameters between the quotes):
{
"query": "SELECT * FROM NEWSLETTERS",
"options" : {
"lineSeparator" : "\r\n",
"quotationMark" : "'",
"encoding" : "UTF-8",
"fieldSeparator" : ";"
}
}
Query parameters
| Option | Description |
|---|---|
lineSeparator |
Used to mark line endings. |
quotationMark |
|
encoding |
Used to represent the set of characters used in a file. |
fieldSeparator |
Used to separate fields. |
See queries documentation to learn to access SYSTEM tables and to write queries.