ReportArchiveApi
extends AbstractApi
in package
Use API to manage report archives.
Table of Contents
Methods
- checkExportStatus() : ReportArchiveExport|null
- Check Report Archive Export Status
- delete() : void
- Delete Report Archive
- downloadReportArchive() : DownloadFile|null
- Download Report Archive
- export() : ReportArchiveExport|null
- Export Report Archive
- get() : ReportArchive|null
- Get Report Archive
- list() : ModelCollection
- List Report Archives
Methods
checkExportStatus()
Check Report Archive Export Status
public
checkExportStatus(int $archiveId, string $exportId) : ReportArchiveExport|null
Parameters
- $archiveId : int
- $exportId : string
Tags
Return values
ReportArchiveExport|nulldelete()
Delete Report Archive
public
delete(int $archiveId) : void
Parameters
- $archiveId : int
Tags
downloadReportArchive()
Download Report Archive
public
downloadReportArchive(int $archiveId, string $exportId) : DownloadFile|null
Parameters
- $archiveId : int
- $exportId : string
Tags
Return values
DownloadFile|nullexport()
Export Report Archive
public
export(int $archiveId[, array<string|int, mixed> $params = [] ]) : ReportArchiveExport|null
Parameters
- $archiveId : int
- $params : array<string|int, mixed> = []
-
string $params[format] Enum: "xlsx" "csv" "json"
Tags
Return values
ReportArchiveExport|nullget()
Get Report Archive
public
get(int $archiveId) : ReportArchive|null
Parameters
- $archiveId : int
Tags
Return values
ReportArchive|nulllist()
List Report Archives
public
list([array<string|int, mixed> $params = [] ]) : ModelCollection
Parameters
- $params : array<string|int, mixed> = []
-
string $params[scopeType] integer $params[scopeId] integer $params[limit] integer $params[offset]