URL
POST /api/v1/management/import
The options are passed via the body as multipart/form-data. The export file to import is also added via the form body (only one file is supported):
|
Name |
Type |
Function |
|
Password |
string |
The password to decrypt the export file (empty for no password) |
|
DatabaseUsername |
string |
only for PostgreSQL: username of the database administrator to log in (e.g. "postgres") |
|
DatabasePassword |
string |
only for PostgreSQL: password of the database admin-rator account |
Optional parameters
can be passed in url as ?param=value or form-encoded in request body
Name Values Default Function
format json/xml xml Specifies the format in which the collection is returned.
|
Name |
Values |
Default |
Function |
|
format |
json/xml |
xml |
Specifies the format in which the collection is returned. |
Result
Return type: ImportResult
|
Statuscode |
explanation |
|
ImportedDatasets |
Number of imported datasets |
|
SkipedDatasets |
Number of skipped datasets |
As JSON
{
"ImportedDatasets": 0,
"SkipedDatasets": 0
}
Export report templates and settings
URL
POST /api/v1/management/export
The options are passed via the body as JSON with the following model:
|
Name |
Type |
Function |
|
ExportAll |
boolean |
Specifies whether all settings should be exported (true), or only those specified in SelectedTempla-tes (false). |
|
Password |
string |
Optional password with which the export should be encrypted (must be entered during the later import). Encrypted with PBKDF2 and AES-256 |
|
SelectedTemplates |
string[] |
Specifies the report templates to export (list of report template IDs) |
Optional parameters
Can be passed in url as ?param=value or form-encoded in request body.
|
Name |
values |
Default |
Function |
|
format |
json/xml |
xml |
Specifies the format in which the listing is returned. |
Result
Return type: byte[]
Returns the file as "content" with "applicati-on/octet-stream" and the filename "export.rsxfer" on successful export.