ReportsApi.md

ReportsApi

All URIs are relative to http://localhost

Method	HTTP request	Description
reportFolderAndFileClearRecycleBin	DELETE /api/rp/v1/Reports/{subscriptionId}/ClearRecycleBin	Delete all folders and files from recycle bin
reportFolderAndFileCopyFiles	POST /api/rp/v1/Reports/{subscriptionId}/CopyFiles	Copy folders and files to a specified folder
reportFolderAndFileCountRecycleBinFoldersAndFiles	GET /api/rp/v1/Reports/{subscriptionId}/CountRecycleBinFolderAndFiles	Count all folders and files from recycle bin
reportFolderAndFileDeleteFiles	POST /api/rp/v1/Reports/{subscriptionId}/DeleteFiles	Delete folders and files
reportFolderAndFileGetCount	GET /api/rp/v1/Reports/Folder/{id}/CountFolderAndFiles	Get count of files and folders what contains in a specified folder
reportFolderAndFileGetFoldersAndFiles	GET /api/rp/v1/Reports/Folder/{id}/ListFolderAndFiles	Get all folders and files from specified folder
reportFolderAndFileGetRecycleBinFoldersAndFiles	GET /api/rp/v1/Reports/{subscriptionId}/ListRecycleBinFolderAndFiles	Get all folders and files from recycle bin
reportFolderAndFileMoveFiles	POST /api/rp/v1/Reports/{subscriptionId}/MoveFiles	Move folders and files to a specified folder
reportFolderAndFileMoveFilesToBin	POST /api/rp/v1/Reports/{subscriptionId}/ToBin	Move folders and files to bin
reportFolderAndFileRecoverAllFromRecycleBin	POST /api/rp/v1/Reports/{subscriptionId}/RecoverRecycleBin	Recover all folders and files from recycle bin
reportFolderAndFileRecoverFiles	POST /api/rp/v1/Reports/{subscriptionId}/RecoverFiles	Recover folders and files from bin
reportFoldersCalculateFolderSize	GET /api/rp/v1/Reports/Folder/{id}/size	Get specified folder, calculate it's size
reportFoldersCopyFolder	POST /api/rp/v1/Reports/Folder/{id}/Copy/{folderId}	Move folder to a specified folder
reportFoldersDeleteFolder	DELETE /api/rp/v1/Reports/Folder/{id}	Delete specified folder
reportFoldersExport	POST /api/rp/v1/Reports/Folder/{id}/Export	Export specified report folder to a specified format
reportFoldersGetBreadcrumbs	GET /api/rp/v1/Reports/Folder/{id}/Breadcrumbs	Get specified folder breadcrumbs
reportFoldersGetFolder	GET /api/rp/v1/Reports/Folder/{id}	Get specified folder
reportFoldersGetFolders	GET /api/rp/v1/Reports/Folder/{id}/ListFolders	Get all folders from specified folder
reportFoldersGetFoldersCount	GET /api/rp/v1/Reports/Folder/{id}/CountFolders	Get count of folders what contains in a specified folder
reportFoldersGetOrCreate	GET /api/rp/v1/Reports/Folder/getOrCreate	Get specified folder
reportFoldersGetPermissions	GET /api/rp/v1/Reports/Folder/{id}/permissions	Get all folder permissions
reportFoldersGetRootFolder	GET /api/rp/v1/Reports/Root	Get user's root folder (without parents)
reportFoldersMoveFolder	POST /api/rp/v1/Reports/Folder/{id}/Move/{folderId}	Move folder to a specified folder
reportFoldersMoveFolderToBin	DELETE /api/rp/v1/Reports/Folder/{id}/ToBin	Move specified folder to recycle bin
reportFoldersPostFolder	POST /api/rp/v1/Reports/Folder/{id}/Folder	Create folder
reportFoldersRecoverFolder	POST /api/rp/v1/Reports/Folder/{id}/Recover	Recover specified folder
reportFoldersRenameFolder	PUT /api/rp/v1/Reports/Folder/{id}/Rename	Rename a folder
reportFoldersUpdateIcon	PUT /api/rp/v1/Reports/Folder/{id}/Icon	Update a folder's icon
reportFoldersUpdatePermissions	POST /api/rp/v1/Reports/{id}/permissions	Update permissions
reportFoldersUpdateTags	PUT /api/rp/v1/Reports/Folder/{id}/UpdateTags	Update tags
reportsCopyFile	POST /api/rp/v1/Reports/File/{id}/Copy/{folderId}	Copy file to a specified folder
reportsCreateSharingKey	POST /api/rp/v1/Reports/File/{id}/sharingKey	Create a new key, that can be used to share access to a file (You need Administrate.Anon permission to create a new key)
reportsDeleteFile	DELETE /api/rp/v1/Reports/File/{id}	Delete specified file
reportsDeleteSharingKey	DELETE /api/rp/v1/Reports/File/{id}/sharingKey	Deletes a sharing key, making links, that utilizing it no longer work
reportsExport	POST /api/rp/v1/Reports/File/{id}/Export	Export specified report to a specified format
reportsGetFile	GET /api/rp/v1/Reports/File/{id}	Get specified file
reportsGetFileHistory	GET /api/rp/v1/Reports/File/{id}/History	Returns list of actions, performed on this file
reportsGetFilesCount	GET /api/rp/v1/Reports/Folder/{id}/CountFiles	Get count of files what contains in a specified folder
reportsGetFilesList	GET /api/rp/v1/Reports/Folder/{id}/ListFiles	Get all files from specified folder. <br /> User with Get Entity permission can access this method. <br /> The method will returns minimal infomration about the file: <br /> id, name, size, editedTime, createdTime, tags, status, statusReason.
reportsGetPermissions	GET /api/rp/v1/Reports/File/{id}/permissions
reportsGetSharingKeys	GET /api/rp/v1/Reports/File/{id}/sharingKeys	Returns all sharing keys, associated with the file
reportsMoveFile	POST /api/rp/v1/Reports/File/{id}/Move/{folderId}	Move file to a specified folder
reportsMoveFileToBin	DELETE /api/rp/v1/Reports/File/{id}/ToBin	Move specified file to recycle bin
reportsRecoverFile	POST /api/rp/v1/Reports/File/{id}/Recover	Recover specified file from bin
reportsRenameFile	PUT /api/rp/v1/Reports/File/{id}/Rename	Rename a file
reportsStaticPreview	POST /api/rp/v1/Reports/File/{id}/StaticPreview	Make preview for the report. Generate a new or return exist prepared svg files. If template was changed will be returned a new. Pass the `` parameter to check prepared timestamp
reportsUpdateIcon	PUT /api/rp/v1/Reports/File/{id}/Icon	Update a files's icon
reportsUpdatePermissions	POST /api/rp/v1/Reports/File/{id}/permissions	Update permissions
reportsUpdateTags	PUT /api/rp/v1/Reports/File/{id}/UpdateTags	Update tags
reportsUploadFile	POST /api/rp/v1/Reports/Folder/{id}/File	Upload a file to the specified folder. The method is deprecated, use the UploadFileV2 method instead!
reportsUploadFileV2	POST /api/rp/v2/Reports/Folder/{id}/File	Alternative api for upload a file to the specified folder!

reportFolderAndFileClearRecycleBin

reportFolderAndFileClearRecycleBin(subscriptionId)

Delete all folders and files from recycle bin

User with a Delete RecycleBin permission can access this method.

Example

// Import classes:
//import org.openapitools.client.infrastructure.*
//import cloud.fastreport.model.*

val apiInstance = ReportsApi()
val subscriptionId : kotlin.String = subscriptionId_example // kotlin.String | subscription id
try {
    apiInstance.reportFolderAndFileClearRecycleBin(subscriptionId)
} catch (e: ClientException) {
    println("4xx response calling ReportsApi#reportFolderAndFileClearRecycleBin")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ReportsApi#reportFolderAndFileClearRecycleBin")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
subscriptionId	kotlin.String	subscription id

Return type

null (empty response body)

Authorization

Configure ApiKey: ApiClient.username = "" ApiClient.password = "" Configure JWT: ApiClient.accessToken = ""

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

reportFolderAndFileCopyFiles

reportFolderAndFileCopyFiles(subscriptionId, selectedFilesVM)

Copy folders and files to a specified folder

User with a Get permission for a files and Create permission for a destination folder can access this method.

Example

// Import classes:
//import org.openapitools.client.infrastructure.*
//import cloud.fastreport.model.*

val apiInstance = ReportsApi()
val subscriptionId : kotlin.String = subscriptionId_example // kotlin.String | id of current subscription
val selectedFilesVM : SelectedFilesVM =  // SelectedFilesVM | VM with files' ids and params of their destination
try {
    apiInstance.reportFolderAndFileCopyFiles(subscriptionId, selectedFilesVM)
} catch (e: ClientException) {
    println("4xx response calling ReportsApi#reportFolderAndFileCopyFiles")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ReportsApi#reportFolderAndFileCopyFiles")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
subscriptionId	kotlin.String	id of current subscription
selectedFilesVM	SelectedFilesVM	VM with files' ids and params of their destination	[optional]

Return type

null (empty response body)

Authorization

Configure ApiKey: ApiClient.username = "" ApiClient.password = "" Configure JWT: ApiClient.accessToken = ""

HTTP request headers

• Content-Type: application/json
• Accept: application/json

reportFolderAndFileCountRecycleBinFoldersAndFiles

CountVM reportFolderAndFileCountRecycleBinFoldersAndFiles(subscriptionId, searchPattern, useRegex)

Count all folders and files from recycle bin

User with a Get DeletedFiles permission can access this method.

Example

// Import classes:
//import org.openapitools.client.infrastructure.*
//import cloud.fastreport.model.*

val apiInstance = ReportsApi()
val subscriptionId : kotlin.String = subscriptionId_example // kotlin.String | subscription id
val searchPattern : kotlin.String = searchPattern_example // kotlin.String | 
val useRegex : kotlin.Boolean = true // kotlin.Boolean | 
try {
    val result : CountVM = apiInstance.reportFolderAndFileCountRecycleBinFoldersAndFiles(subscriptionId, searchPattern, useRegex)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ReportsApi#reportFolderAndFileCountRecycleBinFoldersAndFiles")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ReportsApi#reportFolderAndFileCountRecycleBinFoldersAndFiles")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
subscriptionId	kotlin.String	subscription id
searchPattern	kotlin.String		[optional] [default to ""]
useRegex	kotlin.Boolean		[optional] [default to false]

Return type

CountVM

Authorization

Configure ApiKey: ApiClient.username = "" ApiClient.password = "" Configure JWT: ApiClient.accessToken = ""

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

reportFolderAndFileDeleteFiles

reportFolderAndFileDeleteFiles(subscriptionId, selectedFilesVM)

Delete folders and files

User with a Delete permission can access this method.

Example

// Import classes:
//import org.openapitools.client.infrastructure.*
//import cloud.fastreport.model.*

val apiInstance = ReportsApi()
val subscriptionId : kotlin.String = subscriptionId_example // kotlin.String | id of current subscription
val selectedFilesVM : SelectedFilesVM =  // SelectedFilesVM | VM with files' ids and params of their destination
try {
    apiInstance.reportFolderAndFileDeleteFiles(subscriptionId, selectedFilesVM)
} catch (e: ClientException) {
    println("4xx response calling ReportsApi#reportFolderAndFileDeleteFiles")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ReportsApi#reportFolderAndFileDeleteFiles")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
subscriptionId	kotlin.String	id of current subscription
selectedFilesVM	SelectedFilesVM	VM with files' ids and params of their destination	[optional]

Return type

null (empty response body)

Authorization

Configure ApiKey: ApiClient.username = "" ApiClient.password = "" Configure JWT: ApiClient.accessToken = ""

HTTP request headers

• Content-Type: application/json
• Accept: application/json

reportFolderAndFileGetCount

CountVM reportFolderAndFileGetCount(id, searchPattern, useRegex)

Get count of files and folders what contains in a specified folder

User with a Get Count permission can access this method.

Example

// Import classes:
//import org.openapitools.client.infrastructure.*
//import cloud.fastreport.model.*

val apiInstance = ReportsApi()
val id : kotlin.String = id_example // kotlin.String | folder id
val searchPattern : kotlin.String = searchPattern_example // kotlin.String | string, that must be incuded in file or folder name to be counted <br />              (leave undefined to count all files and folders)
val useRegex : kotlin.Boolean = true // kotlin.Boolean | set this to true if you want to use regular expression to search
try {
    val result : CountVM = apiInstance.reportFolderAndFileGetCount(id, searchPattern, useRegex)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ReportsApi#reportFolderAndFileGetCount")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ReportsApi#reportFolderAndFileGetCount")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
id	kotlin.String	folder id
searchPattern	kotlin.String	string, that must be incuded in file or folder name to be counted <br /> (leave undefined to count all files and folders)	[optional]
useRegex	kotlin.Boolean	set this to true if you want to use regular expression to search	[optional] [default to false]

Return type

CountVM

Authorization

Configure ApiKey: ApiClient.username = "" ApiClient.password = "" Configure JWT: ApiClient.accessToken = ""

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

reportFolderAndFileGetFoldersAndFiles

FilesVM reportFolderAndFileGetFoldersAndFiles(id, skip, take, orderBy, desc, searchPattern, useRegex)

Get all folders and files from specified folder

User with a Get Entity permission can access this method.

Example

// Import classes:
//import org.openapitools.client.infrastructure.*
//import cloud.fastreport.model.*

val apiInstance = ReportsApi()
val id : kotlin.String = id_example // kotlin.String | folder id
val skip : kotlin.Int = 56 // kotlin.Int | number of folder and files, that have to be skipped
val take : kotlin.Int = 56 // kotlin.Int | number of folder and files, that have to be returned
val orderBy : FileSorting =  // FileSorting | indicates a field to sort by
val desc : kotlin.Boolean = true // kotlin.Boolean | indicates if sorting is descending
val searchPattern : kotlin.String = searchPattern_example // kotlin.String | 
val useRegex : kotlin.Boolean = true // kotlin.Boolean | 
try {
    val result : FilesVM = apiInstance.reportFolderAndFileGetFoldersAndFiles(id, skip, take, orderBy, desc, searchPattern, useRegex)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ReportsApi#reportFolderAndFileGetFoldersAndFiles")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ReportsApi#reportFolderAndFileGetFoldersAndFiles")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
id	kotlin.String	folder id
skip	kotlin.Int	number of folder and files, that have to be skipped	[optional] [default to 0]
take	kotlin.Int	number of folder and files, that have to be returned	[optional] [default to 10]
orderBy	FileSorting	indicates a field to sort by	[optional] [enum: CreatedTime, EditedTime, Size, Name]
desc	kotlin.Boolean	indicates if sorting is descending	[optional] [default to false]
searchPattern	kotlin.String		[optional] [default to ""]
useRegex	kotlin.Boolean		[optional] [default to false]

Return type

FilesVM

Authorization

Configure ApiKey: ApiClient.username = "" ApiClient.password = "" Configure JWT: ApiClient.accessToken = ""

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

reportFolderAndFileGetRecycleBinFoldersAndFiles

FilesVM reportFolderAndFileGetRecycleBinFoldersAndFiles(subscriptionId, skip, take, orderBy, desc, searchPattern, useRegex)

Get all folders and files from recycle bin

User with a Get DeletedFiles permission can access this method.

Example

// Import classes:
//import org.openapitools.client.infrastructure.*
//import cloud.fastreport.model.*

val apiInstance = ReportsApi()
val subscriptionId : kotlin.String = subscriptionId_example // kotlin.String | subscription id
val skip : kotlin.Int = 56 // kotlin.Int | number of folder and files, that have to be skipped
val take : kotlin.Int = 56 // kotlin.Int | number of folder and files, that have to be returned
val orderBy : FileSorting =  // FileSorting | indicates a field to sort by
val desc : kotlin.Boolean = true // kotlin.Boolean | indicates if sorting is descending
val searchPattern : kotlin.String = searchPattern_example // kotlin.String | 
val useRegex : kotlin.Boolean = true // kotlin.Boolean | 
try {
    val result : FilesVM = apiInstance.reportFolderAndFileGetRecycleBinFoldersAndFiles(subscriptionId, skip, take, orderBy, desc, searchPattern, useRegex)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ReportsApi#reportFolderAndFileGetRecycleBinFoldersAndFiles")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ReportsApi#reportFolderAndFileGetRecycleBinFoldersAndFiles")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
subscriptionId	kotlin.String	subscription id
skip	kotlin.Int	number of folder and files, that have to be skipped	[optional] [default to 0]
take	kotlin.Int	number of folder and files, that have to be returned	[optional] [default to 10]
orderBy	FileSorting	indicates a field to sort by	[optional] [enum: CreatedTime, EditedTime, Size, Name]
desc	kotlin.Boolean	indicates if sorting is descending	[optional] [default to false]
searchPattern	kotlin.String		[optional] [default to ""]
useRegex	kotlin.Boolean		[optional] [default to false]

Return type

FilesVM

Authorization

Configure ApiKey: ApiClient.username = "" ApiClient.password = "" Configure JWT: ApiClient.accessToken = ""

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

reportFolderAndFileMoveFiles

reportFolderAndFileMoveFiles(subscriptionId, selectedFilesVM)

Move folders and files to a specified folder

User with a Update Place permission for a files and Create permission for a destination folder can access this method.

Example

// Import classes:
//import org.openapitools.client.infrastructure.*
//import cloud.fastreport.model.*

val apiInstance = ReportsApi()
val subscriptionId : kotlin.String = subscriptionId_example // kotlin.String | id of current subscription
val selectedFilesVM : SelectedFilesVM =  // SelectedFilesVM | VM with files' ids and params of their destination
try {
    apiInstance.reportFolderAndFileMoveFiles(subscriptionId, selectedFilesVM)
} catch (e: ClientException) {
    println("4xx response calling ReportsApi#reportFolderAndFileMoveFiles")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ReportsApi#reportFolderAndFileMoveFiles")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
subscriptionId	kotlin.String	id of current subscription
selectedFilesVM	SelectedFilesVM	VM with files' ids and params of their destination	[optional]

Return type

null (empty response body)

Authorization

Configure ApiKey: ApiClient.username = "" ApiClient.password = "" Configure JWT: ApiClient.accessToken = ""

HTTP request headers

• Content-Type: application/json
• Accept: application/json

reportFolderAndFileMoveFilesToBin

reportFolderAndFileMoveFilesToBin(subscriptionId, selectedFilesVM)

Move folders and files to bin

User with a Delete permission can access this method.

Example

// Import classes:
//import org.openapitools.client.infrastructure.*
//import cloud.fastreport.model.*

val apiInstance = ReportsApi()
val subscriptionId : kotlin.String = subscriptionId_example // kotlin.String | id of current subscription
val selectedFilesVM : SelectedFilesVM =  // SelectedFilesVM | VM with files' ids and params of their destination
try {
    apiInstance.reportFolderAndFileMoveFilesToBin(subscriptionId, selectedFilesVM)
} catch (e: ClientException) {
    println("4xx response calling ReportsApi#reportFolderAndFileMoveFilesToBin")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ReportsApi#reportFolderAndFileMoveFilesToBin")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
subscriptionId	kotlin.String	id of current subscription
selectedFilesVM	SelectedFilesVM	VM with files' ids and params of their destination	[optional]

Return type

null (empty response body)

Authorization

Configure ApiKey: ApiClient.username = "" ApiClient.password = "" Configure JWT: ApiClient.accessToken = ""

HTTP request headers

• Content-Type: application/json
• Accept: application/json

reportFolderAndFileRecoverAllFromRecycleBin

reportFolderAndFileRecoverAllFromRecycleBin(subscriptionId)

Recover all folders and files from recycle bin

User with a Create RecycleBin permission can access this method.

Example

// Import classes:
//import org.openapitools.client.infrastructure.*
//import cloud.fastreport.model.*

val apiInstance = ReportsApi()
val subscriptionId : kotlin.String = subscriptionId_example // kotlin.String | subscription id
try {
    apiInstance.reportFolderAndFileRecoverAllFromRecycleBin(subscriptionId)
} catch (e: ClientException) {
    println("4xx response calling ReportsApi#reportFolderAndFileRecoverAllFromRecycleBin")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ReportsApi#reportFolderAndFileRecoverAllFromRecycleBin")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
subscriptionId	kotlin.String	subscription id

Return type

null (empty response body)

Authorization

Configure ApiKey: ApiClient.username = "" ApiClient.password = "" Configure JWT: ApiClient.accessToken = ""

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

reportFolderAndFileRecoverFiles

reportFolderAndFileRecoverFiles(subscriptionId, selectedFilesVM)

Recover folders and files from bin

User with a SubscriptionCreate permission can access this method.

Example

// Import classes:
//import org.openapitools.client.infrastructure.*
//import cloud.fastreport.model.*

val apiInstance = ReportsApi()
val subscriptionId : kotlin.String = subscriptionId_example // kotlin.String | id of current subscription
val selectedFilesVM : SelectedFilesVM =  // SelectedFilesVM | VM with files' ids and params of their destination
try {
    apiInstance.reportFolderAndFileRecoverFiles(subscriptionId, selectedFilesVM)
} catch (e: ClientException) {
    println("4xx response calling ReportsApi#reportFolderAndFileRecoverFiles")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ReportsApi#reportFolderAndFileRecoverFiles")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
subscriptionId	kotlin.String	id of current subscription
selectedFilesVM	SelectedFilesVM	VM with files' ids and params of their destination	[optional]

Return type

null (empty response body)

Authorization

Configure ApiKey: ApiClient.username = "" ApiClient.password = "" Configure JWT: ApiClient.accessToken = ""

HTTP request headers

• Content-Type: application/json
• Accept: application/json

reportFoldersCalculateFolderSize

FolderSizeVM reportFoldersCalculateFolderSize(id)

Get specified folder, calculate it's size

User with a Get Entity permission can access this method.

Example

// Import classes:
//import org.openapitools.client.infrastructure.*
//import cloud.fastreport.model.*

val apiInstance = ReportsApi()
val id : kotlin.String = id_example // kotlin.String | folder id
try {
    val result : FolderSizeVM = apiInstance.reportFoldersCalculateFolderSize(id)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ReportsApi#reportFoldersCalculateFolderSize")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ReportsApi#reportFoldersCalculateFolderSize")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
id	kotlin.String	folder id

Return type

FolderSizeVM

Authorization

Configure ApiKey: ApiClient.username = "" ApiClient.password = "" Configure JWT: ApiClient.accessToken = ""

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

reportFoldersCopyFolder

FileVM reportFoldersCopyFolder(id, folderId)

Move folder to a specified folder

User with a Update Place permission for a folder and Create Entity for a Parent Folder can access this method.

Example

// Import classes:
//import org.openapitools.client.infrastructure.*
//import cloud.fastreport.model.*

val apiInstance = ReportsApi()
val id : kotlin.String = id_example // kotlin.String | moving folder id
val folderId : kotlin.String = folderId_example // kotlin.String | destination folder id
try {
    val result : FileVM = apiInstance.reportFoldersCopyFolder(id, folderId)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ReportsApi#reportFoldersCopyFolder")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ReportsApi#reportFoldersCopyFolder")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
id	kotlin.String	moving folder id
folderId	kotlin.String	destination folder id

Return type

FileVM

Authorization

Configure ApiKey: ApiClient.username = "" ApiClient.password = "" Configure JWT: ApiClient.accessToken = ""

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

reportFoldersDeleteFolder

reportFoldersDeleteFolder(id)

Delete specified folder

User with a Delete Entity permission can access this method.

Example

// Import classes:
//import org.openapitools.client.infrastructure.*
//import cloud.fastreport.model.*

val apiInstance = ReportsApi()
val id : kotlin.String = id_example // kotlin.String | folder id
try {
    apiInstance.reportFoldersDeleteFolder(id)
} catch (e: ClientException) {
    println("4xx response calling ReportsApi#reportFoldersDeleteFolder")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ReportsApi#reportFoldersDeleteFolder")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
id	kotlin.String	folder id

Return type

null (empty response body)

Authorization

Configure ApiKey: ApiClient.username = "" ApiClient.password = "" Configure JWT: ApiClient.accessToken = ""

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

reportFoldersExport

FileVM reportFoldersExport(id, exportReportVM)

Export specified report folder to a specified format

User with Execute Export permission on report folder and Create Entity on an export folder can access this method.

Example

// Import classes:
//import org.openapitools.client.infrastructure.*
//import cloud.fastreport.model.*

val apiInstance = ReportsApi()
val id : kotlin.String = id_example // kotlin.String | report folder id
val exportReportVM : ExportReportVM =  // ExportReportVM | export parameters
try {
    val result : FileVM = apiInstance.reportFoldersExport(id, exportReportVM)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ReportsApi#reportFoldersExport")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ReportsApi#reportFoldersExport")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
id	kotlin.String	report folder id
exportReportVM	ExportReportVM	export parameters	[optional]

Return type

FileVM

Authorization

Configure ApiKey: ApiClient.username = "" ApiClient.password = "" Configure JWT: ApiClient.accessToken = ""

HTTP request headers

• Content-Type: application/json
• Accept: application/json

reportFoldersGetBreadcrumbs

BreadcrumbsVM reportFoldersGetBreadcrumbs(id)

Get specified folder breadcrumbs

User with a Get Entity permission can access this method.

Example

// Import classes:
//import org.openapitools.client.infrastructure.*
//import cloud.fastreport.model.*

val apiInstance = ReportsApi()
val id : kotlin.String = id_example // kotlin.String | folder id
try {
    val result : BreadcrumbsVM = apiInstance.reportFoldersGetBreadcrumbs(id)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ReportsApi#reportFoldersGetBreadcrumbs")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ReportsApi#reportFoldersGetBreadcrumbs")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
id	kotlin.String	folder id

Return type

BreadcrumbsVM

Authorization

Configure ApiKey: ApiClient.username = "" ApiClient.password = "" Configure JWT: ApiClient.accessToken = ""

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

reportFoldersGetFolder

FileVM reportFoldersGetFolder(id)

Get specified folder

User with a Get Entity permission can access this method.

Example

// Import classes:
//import org.openapitools.client.infrastructure.*
//import cloud.fastreport.model.*

val apiInstance = ReportsApi()
val id : kotlin.String = id_example // kotlin.String | folder id
try {
    val result : FileVM = apiInstance.reportFoldersGetFolder(id)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ReportsApi#reportFoldersGetFolder")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ReportsApi#reportFoldersGetFolder")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
id	kotlin.String	folder id

Return type

FileVM

Authorization

Configure ApiKey: ApiClient.username = "" ApiClient.password = "" Configure JWT: ApiClient.accessToken = ""

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

reportFoldersGetFolders

FilesVM reportFoldersGetFolders(id, skip, take, orderBy, desc, searchPattern, useRegex)

Get all folders from specified folder

User with a Get Entity permission can access this method.

Example

// Import classes:
//import org.openapitools.client.infrastructure.*
//import cloud.fastreport.model.*

val apiInstance = ReportsApi()
val id : kotlin.String = id_example // kotlin.String | folder id
val skip : kotlin.Int = 56 // kotlin.Int | number of files, that have to be skipped
val take : kotlin.Int = 56 // kotlin.Int | number of files, that have to be returned
val orderBy : FileSorting =  // FileSorting | 
val desc : kotlin.Boolean = true // kotlin.Boolean | 
val searchPattern : kotlin.String = searchPattern_example // kotlin.String | 
val useRegex : kotlin.Boolean = true // kotlin.Boolean | 
try {
    val result : FilesVM = apiInstance.reportFoldersGetFolders(id, skip, take, orderBy, desc, searchPattern, useRegex)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ReportsApi#reportFoldersGetFolders")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ReportsApi#reportFoldersGetFolders")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
id	kotlin.String	folder id
skip	kotlin.Int	number of files, that have to be skipped	[optional] [default to 0]
take	kotlin.Int	number of files, that have to be returned	[optional] [default to 10]
orderBy	FileSorting		[optional] [enum: CreatedTime, EditedTime, Size, Name]
desc	kotlin.Boolean		[optional] [default to false]
searchPattern	kotlin.String		[optional] [default to ""]
useRegex	kotlin.Boolean		[optional] [default to false]

Return type

FilesVM

Authorization

Configure ApiKey: ApiClient.username = "" ApiClient.password = "" Configure JWT: ApiClient.accessToken = ""

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

reportFoldersGetFoldersCount

CountVM reportFoldersGetFoldersCount(id)

Get count of folders what contains in a specified folder

User with a Get Count permission can access this method.

Example

// Import classes:
//import org.openapitools.client.infrastructure.*
//import cloud.fastreport.model.*

val apiInstance = ReportsApi()
val id : kotlin.String = id_example // kotlin.String | folder id
try {
    val result : CountVM = apiInstance.reportFoldersGetFoldersCount(id)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ReportsApi#reportFoldersGetFoldersCount")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ReportsApi#reportFoldersGetFoldersCount")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
id	kotlin.String	folder id

Return type

CountVM

Authorization

Configure ApiKey: ApiClient.username = "" ApiClient.password = "" Configure JWT: ApiClient.accessToken = ""

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

reportFoldersGetOrCreate

FileVM reportFoldersGetOrCreate(name, subscriptionId, parentId)

Get specified folder

User with a Get Entity permission can access this method.

Example

// Import classes:
//import org.openapitools.client.infrastructure.*
//import cloud.fastreport.model.*

val apiInstance = ReportsApi()
val name : kotlin.String = name_example // kotlin.String | folder name
val subscriptionId : kotlin.String = subscriptionId_example // kotlin.String | subscriptionId
val parentId : kotlin.String = parentId_example // kotlin.String | parent folder id
try {
    val result : FileVM = apiInstance.reportFoldersGetOrCreate(name, subscriptionId, parentId)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ReportsApi#reportFoldersGetOrCreate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ReportsApi#reportFoldersGetOrCreate")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
name	kotlin.String	folder name	[optional]
subscriptionId	kotlin.String	subscriptionId	[optional]
parentId	kotlin.String	parent folder id	[optional]

Return type

FileVM

Authorization

Configure ApiKey: ApiClient.username = "" ApiClient.password = "" Configure JWT: ApiClient.accessToken = ""

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

reportFoldersGetPermissions

FilePermissionsVM reportFoldersGetPermissions(id)

Get all folder permissions

Example

// Import classes:
//import org.openapitools.client.infrastructure.*
//import cloud.fastreport.model.*

val apiInstance = ReportsApi()
val id : kotlin.String = id_example // kotlin.String | 
try {
    val result : FilePermissionsVM = apiInstance.reportFoldersGetPermissions(id)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ReportsApi#reportFoldersGetPermissions")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ReportsApi#reportFoldersGetPermissions")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
id	kotlin.String

Return type

FilePermissionsVM

Authorization

Configure ApiKey: ApiClient.username = "" ApiClient.password = "" Configure JWT: ApiClient.accessToken = ""

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

reportFoldersGetRootFolder

FileVM reportFoldersGetRootFolder(subscriptionId)

Get user's root folder (without parents)

> Breakchange. Now user model doesn't contain a root folders. This method can return error 400 and 404 when subscription is not found.

Example

// Import classes:
//import org.openapitools.client.infrastructure.*
//import cloud.fastreport.model.*

val apiInstance = ReportsApi()
val subscriptionId : kotlin.String = subscriptionId_example // kotlin.String | 
try {
    val result : FileVM = apiInstance.reportFoldersGetRootFolder(subscriptionId)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ReportsApi#reportFoldersGetRootFolder")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ReportsApi#reportFoldersGetRootFolder")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
subscriptionId	kotlin.String		[optional]

Return type

FileVM

Authorization

Configure ApiKey: ApiClient.username = "" ApiClient.password = "" Configure JWT: ApiClient.accessToken = ""

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

reportFoldersMoveFolder

FileVM reportFoldersMoveFolder(id, folderId)

Move folder to a specified folder

User with a Update Place permission for a folder and Create Entity for a Parent Folder can access this method.

Example

// Import classes:
//import org.openapitools.client.infrastructure.*
//import cloud.fastreport.model.*

val apiInstance = ReportsApi()
val id : kotlin.String = id_example // kotlin.String | moving folder id
val folderId : kotlin.String = folderId_example // kotlin.String | destination folder id
try {
    val result : FileVM = apiInstance.reportFoldersMoveFolder(id, folderId)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ReportsApi#reportFoldersMoveFolder")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ReportsApi#reportFoldersMoveFolder")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
id	kotlin.String	moving folder id
folderId	kotlin.String	destination folder id

Return type

FileVM

Authorization

Configure ApiKey: ApiClient.username = "" ApiClient.password = "" Configure JWT: ApiClient.accessToken = ""

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

reportFoldersMoveFolderToBin

reportFoldersMoveFolderToBin(id)

Move specified folder to recycle bin

User with a Delete Entity permission can access this method.

Example

// Import classes:
//import org.openapitools.client.infrastructure.*
//import cloud.fastreport.model.*

val apiInstance = ReportsApi()
val id : kotlin.String = id_example // kotlin.String | folder id
try {
    apiInstance.reportFoldersMoveFolderToBin(id)
} catch (e: ClientException) {
    println("4xx response calling ReportsApi#reportFoldersMoveFolderToBin")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ReportsApi#reportFoldersMoveFolderToBin")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
id	kotlin.String	folder id

Return type

null (empty response body)

Authorization

Configure ApiKey: ApiClient.username = "" ApiClient.password = "" Configure JWT: ApiClient.accessToken = ""

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

reportFoldersPostFolder

FileVM reportFoldersPostFolder(id, reportFolderCreateVM)

Create folder

User with a Create Entity permisison can access this method.

Example

// Import classes:
//import org.openapitools.client.infrastructure.*
//import cloud.fastreport.model.*

val apiInstance = ReportsApi()
val id : kotlin.String = id_example // kotlin.String | Identifier of parent folder id
val reportFolderCreateVM : ReportFolderCreateVM =  // ReportFolderCreateVM | create VM
try {
    val result : FileVM = apiInstance.reportFoldersPostFolder(id, reportFolderCreateVM)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ReportsApi#reportFoldersPostFolder")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ReportsApi#reportFoldersPostFolder")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
id	kotlin.String	Identifier of parent folder id
reportFolderCreateVM	ReportFolderCreateVM	create VM	[optional]

Return type

FileVM

Authorization

Configure ApiKey: ApiClient.username = "" ApiClient.password = "" Configure JWT: ApiClient.accessToken = ""

HTTP request headers

• Content-Type: application/json
• Accept: application/json

reportFoldersRecoverFolder

reportFoldersRecoverFolder(id, recoveryPath)

Recover specified folder

User with a Delete Entity permission can access this method.

Example

// Import classes:
//import org.openapitools.client.infrastructure.*
//import cloud.fastreport.model.*

val apiInstance = ReportsApi()
val id : kotlin.String = id_example // kotlin.String | folder id
val recoveryPath : kotlin.String = recoveryPath_example // kotlin.String | 
try {
    apiInstance.reportFoldersRecoverFolder(id, recoveryPath)
} catch (e: ClientException) {
    println("4xx response calling ReportsApi#reportFoldersRecoverFolder")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ReportsApi#reportFoldersRecoverFolder")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
id	kotlin.String	folder id
recoveryPath	kotlin.String		[optional]

Return type

null (empty response body)

Authorization

Configure ApiKey: ApiClient.username = "" ApiClient.password = "" Configure JWT: ApiClient.accessToken = ""

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

reportFoldersRenameFolder

FileVM reportFoldersRenameFolder(id, folderRenameVM)

Rename a folder

User with a Update Name permision can access this method.

Example

// Import classes:
//import org.openapitools.client.infrastructure.*
//import cloud.fastreport.model.*

val apiInstance = ReportsApi()
val id : kotlin.String = id_example // kotlin.String | 
val folderRenameVM : FolderRenameVM =  // FolderRenameVM | 
try {
    val result : FileVM = apiInstance.reportFoldersRenameFolder(id, folderRenameVM)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ReportsApi#reportFoldersRenameFolder")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ReportsApi#reportFoldersRenameFolder")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
id	kotlin.String
folderRenameVM	FolderRenameVM		[optional]

Return type

FileVM

Authorization

Configure ApiKey: ApiClient.username = "" ApiClient.password = "" Configure JWT: ApiClient.accessToken = ""

HTTP request headers

• Content-Type: application/json
• Accept: application/json

reportFoldersUpdateIcon

FileVM reportFoldersUpdateIcon(id, folderIconVM)

Update a folder's icon

User with a Update Icon permission can access this method.

Example

// Import classes:
//import org.openapitools.client.infrastructure.*
//import cloud.fastreport.model.*

val apiInstance = ReportsApi()
val id : kotlin.String = id_example // kotlin.String | Identifier of folder
val folderIconVM : FolderIconVM =  // FolderIconVM | Update icon model
try {
    val result : FileVM = apiInstance.reportFoldersUpdateIcon(id, folderIconVM)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ReportsApi#reportFoldersUpdateIcon")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ReportsApi#reportFoldersUpdateIcon")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
id	kotlin.String	Identifier of folder
folderIconVM	FolderIconVM	Update icon model	[optional]

Return type

FileVM

Authorization

Configure ApiKey: ApiClient.username = "" ApiClient.password = "" Configure JWT: ApiClient.accessToken = ""

HTTP request headers

• Content-Type: application/json
• Accept: application/json

reportFoldersUpdatePermissions

reportFoldersUpdatePermissions(id, updateFilePermissionsVM)

Update permissions

Example

// Import classes:
//import org.openapitools.client.infrastructure.*
//import cloud.fastreport.model.*

val apiInstance = ReportsApi()
val id : kotlin.String = id_example // kotlin.String | 
val updateFilePermissionsVM : UpdateFilePermissionsVM =  // UpdateFilePermissionsVM | 
try {
    apiInstance.reportFoldersUpdatePermissions(id, updateFilePermissionsVM)
} catch (e: ClientException) {
    println("4xx response calling ReportsApi#reportFoldersUpdatePermissions")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ReportsApi#reportFoldersUpdatePermissions")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
id	kotlin.String
updateFilePermissionsVM	UpdateFilePermissionsVM		[optional]

Return type

null (empty response body)

Authorization

Configure ApiKey: ApiClient.username = "" ApiClient.password = "" Configure JWT: ApiClient.accessToken = ""

HTTP request headers

• Content-Type: application/json
• Accept: application/json

reportFoldersUpdateTags

FileVM reportFoldersUpdateTags(id, folderTagsUpdateVM)

Update tags

User with a Update Tags permission can access this method.

Example

// Import classes:
//import org.openapitools.client.infrastructure.*
//import cloud.fastreport.model.*

val apiInstance = ReportsApi()
val id : kotlin.String = id_example // kotlin.String | 
val folderTagsUpdateVM : FolderTagsUpdateVM =  // FolderTagsUpdateVM | 
try {
    val result : FileVM = apiInstance.reportFoldersUpdateTags(id, folderTagsUpdateVM)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ReportsApi#reportFoldersUpdateTags")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ReportsApi#reportFoldersUpdateTags")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
id	kotlin.String
folderTagsUpdateVM	FolderTagsUpdateVM		[optional]

Return type

FileVM

Authorization

Configure ApiKey: ApiClient.username = "" ApiClient.password = "" Configure JWT: ApiClient.accessToken = ""

HTTP request headers

• Content-Type: application/json
• Accept: application/json

reportsCopyFile

ReportVM reportsCopyFile(id, folderId)

Copy file to a specified folder

Example

// Import classes:
//import org.openapitools.client.infrastructure.*
//import cloud.fastreport.model.*

val apiInstance = ReportsApi()
val id : kotlin.String = id_example // kotlin.String | file id
val folderId : kotlin.String = folderId_example // kotlin.String | folder id
try {
    val result : ReportVM = apiInstance.reportsCopyFile(id, folderId)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ReportsApi#reportsCopyFile")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ReportsApi#reportsCopyFile")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
id	kotlin.String	file id
folderId	kotlin.String	folder id

Return type

ReportVM

Authorization

Configure ApiKey: ApiClient.username = "" ApiClient.password = "" Configure JWT: ApiClient.accessToken = ""

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

reportsCreateSharingKey

FileSharingKeysVM reportsCreateSharingKey(id, createFileShareVM)

Create a new key, that can be used to share access to a file (You need Administrate.Anon permission to create a new key)

Example

// Import classes:
//import org.openapitools.client.infrastructure.*
//import cloud.fastreport.model.*

val apiInstance = ReportsApi()
val id : kotlin.String = id_example // kotlin.String | file id
val createFileShareVM : CreateFileShareVM =  // CreateFileShareVM | parameters for sharing key creation
try {
    val result : FileSharingKeysVM = apiInstance.reportsCreateSharingKey(id, createFileShareVM)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ReportsApi#reportsCreateSharingKey")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ReportsApi#reportsCreateSharingKey")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
id	kotlin.String	file id
createFileShareVM	CreateFileShareVM	parameters for sharing key creation	[optional]

Return type

FileSharingKeysVM

Authorization

Configure ApiKey: ApiClient.username = "" ApiClient.password = "" Configure JWT: ApiClient.accessToken = ""

HTTP request headers

• Content-Type: application/json
• Accept: application/json

reportsDeleteFile

reportsDeleteFile(id)

Delete specified file

User with Delete permission can access the method.

Example

// Import classes:
//import org.openapitools.client.infrastructure.*
//import cloud.fastreport.model.*

val apiInstance = ReportsApi()
val id : kotlin.String = id_example // kotlin.String | file id
try {
    apiInstance.reportsDeleteFile(id)
} catch (e: ClientException) {
    println("4xx response calling ReportsApi#reportsDeleteFile")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ReportsApi#reportsDeleteFile")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
id	kotlin.String	file id

Return type

null (empty response body)

Authorization

Configure ApiKey: ApiClient.username = "" ApiClient.password = "" Configure JWT: ApiClient.accessToken = ""

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

reportsDeleteSharingKey

reportsDeleteSharingKey(id, key)

Deletes a sharing key, making links, that utilizing it no longer work

Example

// Import classes:
//import org.openapitools.client.infrastructure.*
//import cloud.fastreport.model.*

val apiInstance = ReportsApi()
val id : kotlin.String = id_example // kotlin.String | file id
val key : kotlin.String = key_example // kotlin.String | key to delete
try {
    apiInstance.reportsDeleteSharingKey(id, key)
} catch (e: ClientException) {
    println("4xx response calling ReportsApi#reportsDeleteSharingKey")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ReportsApi#reportsDeleteSharingKey")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
id	kotlin.String	file id
key	kotlin.String	key to delete

Return type

null (empty response body)

Authorization

Configure ApiKey: ApiClient.username = "" ApiClient.password = "" Configure JWT: ApiClient.accessToken = ""

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

reportsExport

ExportVM reportsExport(id, exportReportVM)

Export specified report to a specified format

User with Execute Export permission on prepared report and Create Entity on an export folder can access this method.

Example

// Import classes:
//import org.openapitools.client.infrastructure.*
//import cloud.fastreport.model.*

val apiInstance = ReportsApi()
val id : kotlin.String = id_example // kotlin.String | report id
val exportReportVM : ExportReportVM =  // ExportReportVM | export parameters
try {
    val result : ExportVM = apiInstance.reportsExport(id, exportReportVM)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ReportsApi#reportsExport")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ReportsApi#reportsExport")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
id	kotlin.String	report id
exportReportVM	ExportReportVM	export parameters	[optional]

Return type

ExportVM

Authorization

Configure ApiKey: ApiClient.username = "" ApiClient.password = "" Configure JWT: ApiClient.accessToken = ""

HTTP request headers

• Content-Type: application/json
• Accept: application/json

reportsGetFile

ReportVM reportsGetFile(id)

Get specified file

User with Get Entity permission can access this method.

Example

// Import classes:
//import org.openapitools.client.infrastructure.*
//import cloud.fastreport.model.*

val apiInstance = ReportsApi()
val id : kotlin.String = id_example // kotlin.String | file id
try {
    val result : ReportVM = apiInstance.reportsGetFile(id)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ReportsApi#reportsGetFile")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ReportsApi#reportsGetFile")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
id	kotlin.String	file id

Return type

ReportVM

Authorization

Configure ApiKey: ApiClient.username = "" ApiClient.password = "" Configure JWT: ApiClient.accessToken = ""

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

reportsGetFileHistory

AuditActionsVM reportsGetFileHistory(id, skip, take)

Returns list of actions, performed on this file

Example

// Import classes:
//import org.openapitools.client.infrastructure.*
//import cloud.fastreport.model.*

val apiInstance = ReportsApi()
val id : kotlin.String = id_example // kotlin.String | 
val skip : kotlin.Int = 56 // kotlin.Int | 
val take : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : AuditActionsVM = apiInstance.reportsGetFileHistory(id, skip, take)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ReportsApi#reportsGetFileHistory")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ReportsApi#reportsGetFileHistory")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
id	kotlin.String
skip	kotlin.Int		[optional] [default to 0]
take	kotlin.Int		[optional] [default to 10]

Return type

AuditActionsVM

Authorization

Configure ApiKey: ApiClient.username = "" ApiClient.password = "" Configure JWT: ApiClient.accessToken = ""

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

reportsGetFilesCount

CountVM reportsGetFilesCount(id)

Get count of files what contains in a specified folder

User with Get Count permission can access this method.

Example

// Import classes:
//import org.openapitools.client.infrastructure.*
//import cloud.fastreport.model.*

val apiInstance = ReportsApi()
val id : kotlin.String = id_example // kotlin.String | folder id
try {
    val result : CountVM = apiInstance.reportsGetFilesCount(id)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ReportsApi#reportsGetFilesCount")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ReportsApi#reportsGetFilesCount")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
id	kotlin.String	folder id

Return type

CountVM

Authorization

Configure ApiKey: ApiClient.username = "" ApiClient.password = "" Configure JWT: ApiClient.accessToken = ""

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

reportsGetFilesList

ReportsVM reportsGetFilesList(id, skip, take, searchPattern, orderBy, desc, useRegex)

Get all files from specified folder. <br /> User with Get Entity permission can access this method. <br /> The method will returns minimal infomration about the file: <br /> id, name, size, editedTime, createdTime, tags, status, statusReason.

Example

// Import classes:
//import org.openapitools.client.infrastructure.*
//import cloud.fastreport.model.*

val apiInstance = ReportsApi()
val id : kotlin.String = id_example // kotlin.String | folder id
val skip : kotlin.Int = 56 // kotlin.Int | number of files, that have to be skipped
val take : kotlin.Int = 56 // kotlin.Int | number of files, that have to be returned
val searchPattern : kotlin.String = searchPattern_example // kotlin.String | 
val orderBy : FileSorting =  // FileSorting | 
val desc : kotlin.Boolean = true // kotlin.Boolean | 
val useRegex : kotlin.Boolean = true // kotlin.Boolean | 
try {
    val result : ReportsVM = apiInstance.reportsGetFilesList(id, skip, take, searchPattern, orderBy, desc, useRegex)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ReportsApi#reportsGetFilesList")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ReportsApi#reportsGetFilesList")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
id	kotlin.String	folder id
skip	kotlin.Int	number of files, that have to be skipped	[optional] [default to 0]
take	kotlin.Int	number of files, that have to be returned	[optional] [default to 10]
searchPattern	kotlin.String		[optional]
orderBy	FileSorting		[optional] [enum: CreatedTime, EditedTime, Size, Name]
desc	kotlin.Boolean		[optional] [default to false]
useRegex	kotlin.Boolean		[optional] [default to false]

Return type

ReportsVM

Authorization

Configure ApiKey: ApiClient.username = "" ApiClient.password = "" Configure JWT: ApiClient.accessToken = ""

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

reportsGetPermissions

FilePermissionsVM reportsGetPermissions(id)

Example

// Import classes:
//import org.openapitools.client.infrastructure.*
//import cloud.fastreport.model.*

val apiInstance = ReportsApi()
val id : kotlin.String = id_example // kotlin.String | 
try {
    val result : FilePermissionsVM = apiInstance.reportsGetPermissions(id)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ReportsApi#reportsGetPermissions")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ReportsApi#reportsGetPermissions")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
id	kotlin.String

Return type

FilePermissionsVM

Authorization

Configure ApiKey: ApiClient.username = "" ApiClient.password = "" Configure JWT: ApiClient.accessToken = ""

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

reportsGetSharingKeys

FileSharingKeysVM reportsGetSharingKeys(id)

Returns all sharing keys, associated with the file

Example

// Import classes:
//import org.openapitools.client.infrastructure.*
//import cloud.fastreport.model.*

val apiInstance = ReportsApi()
val id : kotlin.String = id_example // kotlin.String | file id
try {
    val result : FileSharingKeysVM = apiInstance.reportsGetSharingKeys(id)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ReportsApi#reportsGetSharingKeys")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ReportsApi#reportsGetSharingKeys")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
id	kotlin.String	file id

Return type

FileSharingKeysVM

Authorization

Configure ApiKey: ApiClient.username = "" ApiClient.password = "" Configure JWT: ApiClient.accessToken = ""

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

reportsMoveFile

ReportVM reportsMoveFile(id, folderId)

Move file to a specified folder

User with a Update Place permission for a folder and Create Entity for a Parent Folder can access this method.

Example

// Import classes:
//import org.openapitools.client.infrastructure.*
//import cloud.fastreport.model.*

val apiInstance = ReportsApi()
val id : kotlin.String = id_example // kotlin.String | file id
val folderId : kotlin.String = folderId_example // kotlin.String | folder id
try {
    val result : ReportVM = apiInstance.reportsMoveFile(id, folderId)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ReportsApi#reportsMoveFile")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ReportsApi#reportsMoveFile")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
id	kotlin.String	file id
folderId	kotlin.String	folder id

Return type

ReportVM

Authorization

Configure ApiKey: ApiClient.username = "" ApiClient.password = "" Configure JWT: ApiClient.accessToken = ""

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

reportsMoveFileToBin

reportsMoveFileToBin(id)

Move specified file to recycle bin

User with Delete permission can access the method.

Example

// Import classes:
//import org.openapitools.client.infrastructure.*
//import cloud.fastreport.model.*

val apiInstance = ReportsApi()
val id : kotlin.String = id_example // kotlin.String | file id
try {
    apiInstance.reportsMoveFileToBin(id)
} catch (e: ClientException) {
    println("4xx response calling ReportsApi#reportsMoveFileToBin")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ReportsApi#reportsMoveFileToBin")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
id	kotlin.String	file id

Return type

null (empty response body)

Authorization

Configure ApiKey: ApiClient.username = "" ApiClient.password = "" Configure JWT: ApiClient.accessToken = ""

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

reportsRecoverFile

reportsRecoverFile(id, recoveryPath)

Recover specified file from bin

User with Delete permission can access the method.

Example

// Import classes:
//import org.openapitools.client.infrastructure.*
//import cloud.fastreport.model.*

val apiInstance = ReportsApi()
val id : kotlin.String = id_example // kotlin.String | file id
val recoveryPath : kotlin.String = recoveryPath_example // kotlin.String | 
try {
    apiInstance.reportsRecoverFile(id, recoveryPath)
} catch (e: ClientException) {
    println("4xx response calling ReportsApi#reportsRecoverFile")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ReportsApi#reportsRecoverFile")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
id	kotlin.String	file id
recoveryPath	kotlin.String		[optional]

Return type

null (empty response body)

Authorization

Configure ApiKey: ApiClient.username = "" ApiClient.password = "" Configure JWT: ApiClient.accessToken = ""

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

reportsRenameFile

ReportVM reportsRenameFile(id, fileRenameVM)

Rename a file

User with Update Name permission can access this method.

Example

// Import classes:
//import org.openapitools.client.infrastructure.*
//import cloud.fastreport.model.*

val apiInstance = ReportsApi()
val id : kotlin.String = id_example // kotlin.String | 
val fileRenameVM : FileRenameVM =  // FileRenameVM | 
try {
    val result : ReportVM = apiInstance.reportsRenameFile(id, fileRenameVM)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ReportsApi#reportsRenameFile")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ReportsApi#reportsRenameFile")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
id	kotlin.String
fileRenameVM	FileRenameVM		[optional]

Return type

ReportVM

Authorization

Configure ApiKey: ApiClient.username = "" ApiClient.password = "" Configure JWT: ApiClient.accessToken = ""

HTTP request headers

• Content-Type: application/json
• Accept: application/json

reportsStaticPreview

ExportVM reportsStaticPreview(id, previewReportVM)

Make preview for the report. Generate a new or return exist prepared svg files. If template was changed will be returned a new. Pass the `` parameter to check prepared timestamp

Example

// Import classes:
//import org.openapitools.client.infrastructure.*
//import cloud.fastreport.model.*

val apiInstance = ReportsApi()
val id : kotlin.String = id_example // kotlin.String | template id
val previewReportVM : PreviewReportVM =  // PreviewReportVM | Model with parameters
try {
    val result : ExportVM = apiInstance.reportsStaticPreview(id, previewReportVM)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ReportsApi#reportsStaticPreview")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ReportsApi#reportsStaticPreview")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
id	kotlin.String	template id
previewReportVM	PreviewReportVM	Model with parameters	[optional]

Return type

ExportVM

Authorization

Configure ApiKey: ApiClient.username = "" ApiClient.password = "" Configure JWT: ApiClient.accessToken = ""

HTTP request headers

• Content-Type: application/json
• Accept: application/json

reportsUpdateIcon

ReportVM reportsUpdateIcon(id, fileIconVM)

Update a files's icon

User with Update Icon permission can access this method.

Example

// Import classes:
//import org.openapitools.client.infrastructure.*
//import cloud.fastreport.model.*

val apiInstance = ReportsApi()
val id : kotlin.String = id_example // kotlin.String | 
val fileIconVM : FileIconVM =  // FileIconVM | 
try {
    val result : ReportVM = apiInstance.reportsUpdateIcon(id, fileIconVM)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ReportsApi#reportsUpdateIcon")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ReportsApi#reportsUpdateIcon")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
id	kotlin.String
fileIconVM	FileIconVM		[optional]

Return type

ReportVM

Authorization

Configure ApiKey: ApiClient.username = "" ApiClient.password = "" Configure JWT: ApiClient.accessToken = ""

HTTP request headers

• Content-Type: application/json
• Accept: application/json

reportsUpdatePermissions

reportsUpdatePermissions(id, updateFilePermissionsVM)

Update permissions

Example

// Import classes:
//import org.openapitools.client.infrastructure.*
//import cloud.fastreport.model.*

val apiInstance = ReportsApi()
val id : kotlin.String = id_example // kotlin.String | 
val updateFilePermissionsVM : UpdateFilePermissionsVM =  // UpdateFilePermissionsVM | 
try {
    apiInstance.reportsUpdatePermissions(id, updateFilePermissionsVM)
} catch (e: ClientException) {
    println("4xx response calling ReportsApi#reportsUpdatePermissions")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ReportsApi#reportsUpdatePermissions")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
id	kotlin.String
updateFilePermissionsVM	UpdateFilePermissionsVM		[optional]

Return type

null (empty response body)

Authorization

Configure ApiKey: ApiClient.username = "" ApiClient.password = "" Configure JWT: ApiClient.accessToken = ""

HTTP request headers

• Content-Type: application/json
• Accept: application/json

reportsUpdateTags

ReportVM reportsUpdateTags(id, fileTagsUpdateVM)

Update tags

User with Update Tags permission can access this method.

Example

// Import classes:
//import org.openapitools.client.infrastructure.*
//import cloud.fastreport.model.*

val apiInstance = ReportsApi()
val id : kotlin.String = id_example // kotlin.String | 
val fileTagsUpdateVM : FileTagsUpdateVM =  // FileTagsUpdateVM | 
try {
    val result : ReportVM = apiInstance.reportsUpdateTags(id, fileTagsUpdateVM)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ReportsApi#reportsUpdateTags")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ReportsApi#reportsUpdateTags")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
id	kotlin.String
fileTagsUpdateVM	FileTagsUpdateVM		[optional]

Return type

ReportVM

Authorization

Configure ApiKey: ApiClient.username = "" ApiClient.password = "" Configure JWT: ApiClient.accessToken = ""

HTTP request headers

• Content-Type: application/json
• Accept: application/json

reportsUploadFile

ReportVM reportsUploadFile(id, reportCreateVM)

Upload a file to the specified folder. The method is deprecated, use the UploadFileV2 method instead!

User with Create Entity permission can access this method.

Example

// Import classes:
//import org.openapitools.client.infrastructure.*
//import cloud.fastreport.model.*

val apiInstance = ReportsApi()
val id : kotlin.String = id_example // kotlin.String | Identifier of folder
val reportCreateVM : ReportCreateVM =  // ReportCreateVM | file's view model
try {
    val result : ReportVM = apiInstance.reportsUploadFile(id, reportCreateVM)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ReportsApi#reportsUploadFile")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ReportsApi#reportsUploadFile")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
id	kotlin.String	Identifier of folder
reportCreateVM	ReportCreateVM	file's view model	[optional]

Return type

ReportVM

Authorization

Configure ApiKey: ApiClient.username = "" ApiClient.password = "" Configure JWT: ApiClient.accessToken = ""

HTTP request headers

• Content-Type: application/json
• Accept: application/json

reportsUploadFileV2

ReportVM reportsUploadFileV2(id, fileContent, templateId, tags, icon)

Alternative api for upload a file to the specified folder!

User with Create Entity permission can access this method.

Example

// Import classes:
//import org.openapitools.client.infrastructure.*
//import cloud.fastreport.model.*

val apiInstance = ReportsApi()
val id : kotlin.String = id_example // kotlin.String | Identifier of folder
val fileContent : java.io.File = BINARY_DATA_HERE // java.io.File | 
val templateId : kotlin.String = templateId_example // kotlin.String | 
val tags : kotlin.collections.List<kotlin.String> =  // kotlin.collections.List<kotlin.String> | 
val icon : java.io.File = BINARY_DATA_HERE // java.io.File | 
try {
    val result : ReportVM = apiInstance.reportsUploadFileV2(id, fileContent, templateId, tags, icon)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ReportsApi#reportsUploadFileV2")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ReportsApi#reportsUploadFileV2")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
id	kotlin.String	Identifier of folder
fileContent	java.io.File
templateId	kotlin.String		[optional]
tags	kotlin.collections.List<kotlin.String>		[optional]
icon	java.io.File		[optional]

Return type

ReportVM

Authorization

Configure ApiKey: ApiClient.username = "" ApiClient.password = "" Configure JWT: ApiClient.accessToken = ""

HTTP request headers

• Content-Type: multipart/form-data
• Accept: application/json