Skip to content

ExportsApi.md

Latest commit

 

History

History
2516 lines (1878 loc) · 73 KB

ExportsApi.md

File metadata and controls

2516 lines (1878 loc) · 73 KB

ExportsApi

All URIs are relative to http://localhost

Method HTTP request Description
exportFolderAndFileClearRecycleBin DELETE /api/rp/v1/Exports/{subscriptionId}/ClearRecycleBin Delete all folders and files from recycle bin
exportFolderAndFileCopyFiles POST /api/rp/v1/Exports/{subscriptionId}/CopyFiles Copy folders and files to a specified folder
exportFolderAndFileCountRecycleBinFoldersAndFiles GET /api/rp/v1/Exports/{subscriptionId}/CountRecycleBinFolderAndFiles Count all folders and files from recycle bin
exportFolderAndFileDeleteFiles POST /api/rp/v1/Exports/{subscriptionId}/DeleteFiles Delete folders and files
exportFolderAndFileGetCount GET /api/rp/v1/Exports/Folder/{id}/CountFolderAndFiles Get count of files and folders what contains in a specified folder
exportFolderAndFileGetFoldersAndFiles GET /api/rp/v1/Exports/Folder/{id}/ListFolderAndFiles Get all folders and files from specified folder
exportFolderAndFileGetRecycleBinFoldersAndFiles GET /api/rp/v1/Exports/{subscriptionId}/ListRecycleBinFolderAndFiles Get all folders and files from recycle bin
exportFolderAndFileMoveFiles POST /api/rp/v1/Exports/{subscriptionId}/MoveFiles Move folders and files to a specified folder
exportFolderAndFileMoveFilesToBin POST /api/rp/v1/Exports/{subscriptionId}/ToBin Move folders and files to bin
exportFolderAndFileRecoverAllFromRecycleBin POST /api/rp/v1/Exports/{subscriptionId}/RecoverRecycleBin Recover all folders and files from recycle bin
exportFolderAndFileRecoverFiles POST /api/rp/v1/Exports/{subscriptionId}/RecoverFiles Recover folders and files from bin
exportFoldersCalculateFolderSize GET /api/rp/v1/Exports/Folder/{id}/size Get specified folder, calculate it's size
exportFoldersCopyFolder POST /api/rp/v1/Exports/Folder/{id}/Copy/{folderId} Move folder to a specified folder
exportFoldersDeleteFolder DELETE /api/rp/v1/Exports/Folder/{id} Delete specified folder
exportFoldersGetBreadcrumbs GET /api/rp/v1/Exports/Folder/{id}/Breadcrumbs Get specified folder breadcrumbs
exportFoldersGetFolder GET /api/rp/v1/Exports/Folder/{id} Get specified folder
exportFoldersGetFolders GET /api/rp/v1/Exports/Folder/{id}/ListFolders Get all folders from specified folder
exportFoldersGetFoldersCount GET /api/rp/v1/Exports/Folder/{id}/CountFolders Get count of folders what contains in a specified folder
exportFoldersGetOrCreate GET /api/rp/v1/Exports/Folder/getOrCreate Get specified folder
exportFoldersGetPermissions GET /api/rp/v1/Exports/Folder/{id}/permissions Get all folder permissions
exportFoldersGetRootFolder GET /api/rp/v1/Exports/Root Get user's root folder (without parents)
exportFoldersMoveFolder POST /api/rp/v1/Exports/Folder/{id}/Move/{folderId} Move folder to a specified folder
exportFoldersMoveFolderToBin DELETE /api/rp/v1/Exports/Folder/{id}/ToBin Move specified folder to recycle bin
exportFoldersPostFolder POST /api/rp/v1/Exports/Folder/{id}/Folder Create folder
exportFoldersRecoverFolder POST /api/rp/v1/Exports/Folder/{id}/Recover Recover specified folder
exportFoldersRenameFolder PUT /api/rp/v1/Exports/Folder/{id}/Rename Rename a folder
exportFoldersUpdateIcon PUT /api/rp/v1/Exports/Folder/{id}/Icon Update a folder's icon
exportFoldersUpdatePermissions POST /api/rp/v1/Exports/{id}/permissions Update permissions
exportFoldersUpdateTags PUT /api/rp/v1/Exports/Folder/{id}/UpdateTags Update tags
exportsCopyFile POST /api/rp/v1/Exports/File/{id}/Copy/{folderId} Copy file to a specified folder
exportsCreateSharingKey POST /api/rp/v1/Exports/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)
exportsDeleteFile DELETE /api/rp/v1/Exports/File/{id} Delete specified file
exportsDeleteSharingKey DELETE /api/rp/v1/Exports/File/{id}/sharingKey Deletes a sharing key, making links, that utilizing it no longer work
exportsGetFile GET /api/rp/v1/Exports/File/{id} Get export by specified id
exportsGetFileHistory GET /api/rp/v1/Exports/File/{id}/History Returns list of actions, performed on this file
exportsGetFilesCount GET /api/rp/v1/Exports/Folder/{id}/CountFiles Get count of files what contains in a specified folder
exportsGetFilesList GET /api/rp/v1/Exports/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.
exportsGetPermissions GET /api/rp/v1/Exports/File/{id}/permissions
exportsGetSharingKeys GET /api/rp/v1/Exports/File/{id}/sharingKeys Returns all sharing keys, associated with the file
exportsMoveFile POST /api/rp/v1/Exports/File/{id}/Move/{folderId} Move file to a specified folder
exportsMoveFileToBin DELETE /api/rp/v1/Exports/File/{id}/ToBin Move specified file to recycle bin
exportsRecoverFile POST /api/rp/v1/Exports/File/{id}/Recover Recover specified file from bin
exportsRenameFile PUT /api/rp/v1/Exports/File/{id}/Rename Rename a file
exportsUpdateIcon PUT /api/rp/v1/Exports/File/{id}/Icon Update a files's icon
exportsUpdatePermissions POST /api/rp/v1/Exports/File/{id}/permissions Update permissions
exportsUpdateTags PUT /api/rp/v1/Exports/File/{id}/UpdateTags Update tags

exportFolderAndFileClearRecycleBin

exportFolderAndFileClearRecycleBin(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 = ExportsApi()
val subscriptionId : kotlin.String = subscriptionId_example // kotlin.String | subscription id
try {
    apiInstance.exportFolderAndFileClearRecycleBin(subscriptionId)
} catch (e: ClientException) {
    println("4xx response calling ExportsApi#exportFolderAndFileClearRecycleBin")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ExportsApi#exportFolderAndFileClearRecycleBin")
    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

exportFolderAndFileCopyFiles

exportFolderAndFileCopyFiles(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 = ExportsApi()
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.exportFolderAndFileCopyFiles(subscriptionId, selectedFilesVM)
} catch (e: ClientException) {
    println("4xx response calling ExportsApi#exportFolderAndFileCopyFiles")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ExportsApi#exportFolderAndFileCopyFiles")
    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

exportFolderAndFileCountRecycleBinFoldersAndFiles

CountVM exportFolderAndFileCountRecycleBinFoldersAndFiles(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 = ExportsApi()
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.exportFolderAndFileCountRecycleBinFoldersAndFiles(subscriptionId, searchPattern, useRegex)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ExportsApi#exportFolderAndFileCountRecycleBinFoldersAndFiles")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ExportsApi#exportFolderAndFileCountRecycleBinFoldersAndFiles")
    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

exportFolderAndFileDeleteFiles

exportFolderAndFileDeleteFiles(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 = ExportsApi()
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.exportFolderAndFileDeleteFiles(subscriptionId, selectedFilesVM)
} catch (e: ClientException) {
    println("4xx response calling ExportsApi#exportFolderAndFileDeleteFiles")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ExportsApi#exportFolderAndFileDeleteFiles")
    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

exportFolderAndFileGetCount

CountVM exportFolderAndFileGetCount(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 = ExportsApi()
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.exportFolderAndFileGetCount(id, searchPattern, useRegex)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ExportsApi#exportFolderAndFileGetCount")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ExportsApi#exportFolderAndFileGetCount")
    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

exportFolderAndFileGetFoldersAndFiles

FilesVM exportFolderAndFileGetFoldersAndFiles(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 = ExportsApi()
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.exportFolderAndFileGetFoldersAndFiles(id, skip, take, orderBy, desc, searchPattern, useRegex)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ExportsApi#exportFolderAndFileGetFoldersAndFiles")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ExportsApi#exportFolderAndFileGetFoldersAndFiles")
    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

exportFolderAndFileGetRecycleBinFoldersAndFiles

FilesVM exportFolderAndFileGetRecycleBinFoldersAndFiles(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 = ExportsApi()
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.exportFolderAndFileGetRecycleBinFoldersAndFiles(subscriptionId, skip, take, orderBy, desc, searchPattern, useRegex)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ExportsApi#exportFolderAndFileGetRecycleBinFoldersAndFiles")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ExportsApi#exportFolderAndFileGetRecycleBinFoldersAndFiles")
    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

exportFolderAndFileMoveFiles

exportFolderAndFileMoveFiles(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 = ExportsApi()
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.exportFolderAndFileMoveFiles(subscriptionId, selectedFilesVM)
} catch (e: ClientException) {
    println("4xx response calling ExportsApi#exportFolderAndFileMoveFiles")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ExportsApi#exportFolderAndFileMoveFiles")
    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

exportFolderAndFileMoveFilesToBin

exportFolderAndFileMoveFilesToBin(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 = ExportsApi()
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.exportFolderAndFileMoveFilesToBin(subscriptionId, selectedFilesVM)
} catch (e: ClientException) {
    println("4xx response calling ExportsApi#exportFolderAndFileMoveFilesToBin")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ExportsApi#exportFolderAndFileMoveFilesToBin")
    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

exportFolderAndFileRecoverAllFromRecycleBin

exportFolderAndFileRecoverAllFromRecycleBin(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 = ExportsApi()
val subscriptionId : kotlin.String = subscriptionId_example // kotlin.String | subscription id
try {
    apiInstance.exportFolderAndFileRecoverAllFromRecycleBin(subscriptionId)
} catch (e: ClientException) {
    println("4xx response calling ExportsApi#exportFolderAndFileRecoverAllFromRecycleBin")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ExportsApi#exportFolderAndFileRecoverAllFromRecycleBin")
    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

exportFolderAndFileRecoverFiles

exportFolderAndFileRecoverFiles(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 = ExportsApi()
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.exportFolderAndFileRecoverFiles(subscriptionId, selectedFilesVM)
} catch (e: ClientException) {
    println("4xx response calling ExportsApi#exportFolderAndFileRecoverFiles")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ExportsApi#exportFolderAndFileRecoverFiles")
    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

exportFoldersCalculateFolderSize

FolderSizeVM exportFoldersCalculateFolderSize(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 = ExportsApi()
val id : kotlin.String = id_example // kotlin.String | folder id
try {
    val result : FolderSizeVM = apiInstance.exportFoldersCalculateFolderSize(id)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ExportsApi#exportFoldersCalculateFolderSize")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ExportsApi#exportFoldersCalculateFolderSize")
    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

exportFoldersCopyFolder

FileVM exportFoldersCopyFolder(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 = ExportsApi()
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.exportFoldersCopyFolder(id, folderId)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ExportsApi#exportFoldersCopyFolder")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ExportsApi#exportFoldersCopyFolder")
    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

exportFoldersDeleteFolder

exportFoldersDeleteFolder(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 = ExportsApi()
val id : kotlin.String = id_example // kotlin.String | folder id
try {
    apiInstance.exportFoldersDeleteFolder(id)
} catch (e: ClientException) {
    println("4xx response calling ExportsApi#exportFoldersDeleteFolder")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ExportsApi#exportFoldersDeleteFolder")
    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

exportFoldersGetBreadcrumbs

BreadcrumbsVM exportFoldersGetBreadcrumbs(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 = ExportsApi()
val id : kotlin.String = id_example // kotlin.String | folder id
try {
    val result : BreadcrumbsVM = apiInstance.exportFoldersGetBreadcrumbs(id)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ExportsApi#exportFoldersGetBreadcrumbs")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ExportsApi#exportFoldersGetBreadcrumbs")
    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

exportFoldersGetFolder

FileVM exportFoldersGetFolder(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 = ExportsApi()
val id : kotlin.String = id_example // kotlin.String | folder id
try {
    val result : FileVM = apiInstance.exportFoldersGetFolder(id)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ExportsApi#exportFoldersGetFolder")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ExportsApi#exportFoldersGetFolder")
    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

exportFoldersGetFolders

FilesVM exportFoldersGetFolders(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 = ExportsApi()
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.exportFoldersGetFolders(id, skip, take, orderBy, desc, searchPattern, useRegex)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ExportsApi#exportFoldersGetFolders")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ExportsApi#exportFoldersGetFolders")
    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

exportFoldersGetFoldersCount

CountVM exportFoldersGetFoldersCount(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 = ExportsApi()
val id : kotlin.String = id_example // kotlin.String | folder id
try {
    val result : CountVM = apiInstance.exportFoldersGetFoldersCount(id)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ExportsApi#exportFoldersGetFoldersCount")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ExportsApi#exportFoldersGetFoldersCount")
    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

exportFoldersGetOrCreate

FileVM exportFoldersGetOrCreate(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 = ExportsApi()
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.exportFoldersGetOrCreate(name, subscriptionId, parentId)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ExportsApi#exportFoldersGetOrCreate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ExportsApi#exportFoldersGetOrCreate")
    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

exportFoldersGetPermissions

FilePermissionsVM exportFoldersGetPermissions(id)

Get all folder permissions

Example

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

val apiInstance = ExportsApi()
val id : kotlin.String = id_example // kotlin.String | 
try {
    val result : FilePermissionsVM = apiInstance.exportFoldersGetPermissions(id)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ExportsApi#exportFoldersGetPermissions")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ExportsApi#exportFoldersGetPermissions")
    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

exportFoldersGetRootFolder

FileVM exportFoldersGetRootFolder(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 = ExportsApi()
val subscriptionId : kotlin.String = subscriptionId_example // kotlin.String | 
try {
    val result : FileVM = apiInstance.exportFoldersGetRootFolder(subscriptionId)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ExportsApi#exportFoldersGetRootFolder")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ExportsApi#exportFoldersGetRootFolder")
    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

exportFoldersMoveFolder

FileVM exportFoldersMoveFolder(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 = ExportsApi()
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.exportFoldersMoveFolder(id, folderId)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ExportsApi#exportFoldersMoveFolder")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ExportsApi#exportFoldersMoveFolder")
    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

exportFoldersMoveFolderToBin

exportFoldersMoveFolderToBin(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 = ExportsApi()
val id : kotlin.String = id_example // kotlin.String | folder id
try {
    apiInstance.exportFoldersMoveFolderToBin(id)
} catch (e: ClientException) {
    println("4xx response calling ExportsApi#exportFoldersMoveFolderToBin")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ExportsApi#exportFoldersMoveFolderToBin")
    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

exportFoldersPostFolder

FileVM exportFoldersPostFolder(id, exportFolderCreateVM)

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 = ExportsApi()
val id : kotlin.String = id_example // kotlin.String | Identifier of parent folder id
val exportFolderCreateVM : ExportFolderCreateVM =  // ExportFolderCreateVM | create VM
try {
    val result : FileVM = apiInstance.exportFoldersPostFolder(id, exportFolderCreateVM)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ExportsApi#exportFoldersPostFolder")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ExportsApi#exportFoldersPostFolder")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
id kotlin.String Identifier of parent folder id
exportFolderCreateVM ExportFolderCreateVM 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

exportFoldersRecoverFolder

exportFoldersRecoverFolder(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 = ExportsApi()
val id : kotlin.String = id_example // kotlin.String | folder id
val recoveryPath : kotlin.String = recoveryPath_example // kotlin.String | 
try {
    apiInstance.exportFoldersRecoverFolder(id, recoveryPath)
} catch (e: ClientException) {
    println("4xx response calling ExportsApi#exportFoldersRecoverFolder")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ExportsApi#exportFoldersRecoverFolder")
    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

exportFoldersRenameFolder

FileVM exportFoldersRenameFolder(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 = ExportsApi()
val id : kotlin.String = id_example // kotlin.String | 
val folderRenameVM : FolderRenameVM =  // FolderRenameVM | 
try {
    val result : FileVM = apiInstance.exportFoldersRenameFolder(id, folderRenameVM)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ExportsApi#exportFoldersRenameFolder")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ExportsApi#exportFoldersRenameFolder")
    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

exportFoldersUpdateIcon

FileVM exportFoldersUpdateIcon(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 = ExportsApi()
val id : kotlin.String = id_example // kotlin.String | Identifier of folder
val folderIconVM : FolderIconVM =  // FolderIconVM | Update icon model
try {
    val result : FileVM = apiInstance.exportFoldersUpdateIcon(id, folderIconVM)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ExportsApi#exportFoldersUpdateIcon")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ExportsApi#exportFoldersUpdateIcon")
    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

exportFoldersUpdatePermissions

exportFoldersUpdatePermissions(id, updateFilePermissionsVM)

Update permissions

Example

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

val apiInstance = ExportsApi()
val id : kotlin.String = id_example // kotlin.String | 
val updateFilePermissionsVM : UpdateFilePermissionsVM =  // UpdateFilePermissionsVM | 
try {
    apiInstance.exportFoldersUpdatePermissions(id, updateFilePermissionsVM)
} catch (e: ClientException) {
    println("4xx response calling ExportsApi#exportFoldersUpdatePermissions")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ExportsApi#exportFoldersUpdatePermissions")
    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

exportFoldersUpdateTags

FileVM exportFoldersUpdateTags(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 = ExportsApi()
val id : kotlin.String = id_example // kotlin.String | 
val folderTagsUpdateVM : FolderTagsUpdateVM =  // FolderTagsUpdateVM | 
try {
    val result : FileVM = apiInstance.exportFoldersUpdateTags(id, folderTagsUpdateVM)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ExportsApi#exportFoldersUpdateTags")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ExportsApi#exportFoldersUpdateTags")
    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

exportsCopyFile

ExportVM exportsCopyFile(id, folderId)

Copy file to a specified folder

Example

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

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

Parameters

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

Return type

ExportVM

Authorization

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

HTTP request headers

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

exportsCreateSharingKey

FileSharingKeysVM exportsCreateSharingKey(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 = ExportsApi()
val id : kotlin.String = id_example // kotlin.String | file id
val createFileShareVM : CreateFileShareVM =  // CreateFileShareVM | parameters for sharing key creation
try {
    val result : FileSharingKeysVM = apiInstance.exportsCreateSharingKey(id, createFileShareVM)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ExportsApi#exportsCreateSharingKey")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ExportsApi#exportsCreateSharingKey")
    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

exportsDeleteFile

exportsDeleteFile(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 = ExportsApi()
val id : kotlin.String = id_example // kotlin.String | file id
try {
    apiInstance.exportsDeleteFile(id)
} catch (e: ClientException) {
    println("4xx response calling ExportsApi#exportsDeleteFile")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ExportsApi#exportsDeleteFile")
    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

exportsDeleteSharingKey

exportsDeleteSharingKey(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 = ExportsApi()
val id : kotlin.String = id_example // kotlin.String | file id
val key : kotlin.String = key_example // kotlin.String | key to delete
try {
    apiInstance.exportsDeleteSharingKey(id, key)
} catch (e: ClientException) {
    println("4xx response calling ExportsApi#exportsDeleteSharingKey")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ExportsApi#exportsDeleteSharingKey")
    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

exportsGetFile

ExportVM exportsGetFile(id)

Get export by specified id

Example

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

val apiInstance = ExportsApi()
val id : kotlin.String = id_example // kotlin.String | id of export
try {
    val result : ExportVM = apiInstance.exportsGetFile(id)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ExportsApi#exportsGetFile")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ExportsApi#exportsGetFile")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
id kotlin.String id of export

Return type

ExportVM

Authorization

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

HTTP request headers

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

exportsGetFileHistory

AuditActionsVM exportsGetFileHistory(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 = ExportsApi()
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.exportsGetFileHistory(id, skip, take)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ExportsApi#exportsGetFileHistory")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ExportsApi#exportsGetFileHistory")
    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

exportsGetFilesCount

CountVM exportsGetFilesCount(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 = ExportsApi()
val id : kotlin.String = id_example // kotlin.String | folder id
try {
    val result : CountVM = apiInstance.exportsGetFilesCount(id)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ExportsApi#exportsGetFilesCount")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ExportsApi#exportsGetFilesCount")
    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

exportsGetFilesList

ExportsVM exportsGetFilesList(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 = ExportsApi()
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 : ExportsVM = apiInstance.exportsGetFilesList(id, skip, take, searchPattern, orderBy, desc, useRegex)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ExportsApi#exportsGetFilesList")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ExportsApi#exportsGetFilesList")
    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

ExportsVM

Authorization

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

HTTP request headers

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

exportsGetPermissions

FilePermissionsVM exportsGetPermissions(id)

Example

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

val apiInstance = ExportsApi()
val id : kotlin.String = id_example // kotlin.String | 
try {
    val result : FilePermissionsVM = apiInstance.exportsGetPermissions(id)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ExportsApi#exportsGetPermissions")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ExportsApi#exportsGetPermissions")
    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

exportsGetSharingKeys

FileSharingKeysVM exportsGetSharingKeys(id)

Returns all sharing keys, associated with the file

Example

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

val apiInstance = ExportsApi()
val id : kotlin.String = id_example // kotlin.String | file id
try {
    val result : FileSharingKeysVM = apiInstance.exportsGetSharingKeys(id)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ExportsApi#exportsGetSharingKeys")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ExportsApi#exportsGetSharingKeys")
    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

exportsMoveFile

ExportVM exportsMoveFile(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 = ExportsApi()
val id : kotlin.String = id_example // kotlin.String | file id
val folderId : kotlin.String = folderId_example // kotlin.String | folder id
try {
    val result : ExportVM = apiInstance.exportsMoveFile(id, folderId)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ExportsApi#exportsMoveFile")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ExportsApi#exportsMoveFile")
    e.printStackTrace()
}

Parameters

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

Return type

ExportVM

Authorization

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

HTTP request headers

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

exportsMoveFileToBin

exportsMoveFileToBin(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 = ExportsApi()
val id : kotlin.String = id_example // kotlin.String | file id
try {
    apiInstance.exportsMoveFileToBin(id)
} catch (e: ClientException) {
    println("4xx response calling ExportsApi#exportsMoveFileToBin")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ExportsApi#exportsMoveFileToBin")
    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

exportsRecoverFile

exportsRecoverFile(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 = ExportsApi()
val id : kotlin.String = id_example // kotlin.String | file id
val recoveryPath : kotlin.String = recoveryPath_example // kotlin.String | 
try {
    apiInstance.exportsRecoverFile(id, recoveryPath)
} catch (e: ClientException) {
    println("4xx response calling ExportsApi#exportsRecoverFile")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ExportsApi#exportsRecoverFile")
    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

exportsRenameFile

ExportVM exportsRenameFile(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 = ExportsApi()
val id : kotlin.String = id_example // kotlin.String | 
val fileRenameVM : FileRenameVM =  // FileRenameVM | 
try {
    val result : ExportVM = apiInstance.exportsRenameFile(id, fileRenameVM)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ExportsApi#exportsRenameFile")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ExportsApi#exportsRenameFile")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
id kotlin.String
fileRenameVM FileRenameVM [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

exportsUpdateIcon

ExportVM exportsUpdateIcon(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 = ExportsApi()
val id : kotlin.String = id_example // kotlin.String | 
val fileIconVM : FileIconVM =  // FileIconVM | 
try {
    val result : ExportVM = apiInstance.exportsUpdateIcon(id, fileIconVM)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ExportsApi#exportsUpdateIcon")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ExportsApi#exportsUpdateIcon")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
id kotlin.String
fileIconVM FileIconVM [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

exportsUpdatePermissions

exportsUpdatePermissions(id, updateFilePermissionsVM)

Update permissions

Example

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

val apiInstance = ExportsApi()
val id : kotlin.String = id_example // kotlin.String | 
val updateFilePermissionsVM : UpdateFilePermissionsVM =  // UpdateFilePermissionsVM | 
try {
    apiInstance.exportsUpdatePermissions(id, updateFilePermissionsVM)
} catch (e: ClientException) {
    println("4xx response calling ExportsApi#exportsUpdatePermissions")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ExportsApi#exportsUpdatePermissions")
    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

exportsUpdateTags

ExportVM exportsUpdateTags(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 = ExportsApi()
val id : kotlin.String = id_example // kotlin.String | 
val fileTagsUpdateVM : FileTagsUpdateVM =  // FileTagsUpdateVM | 
try {
    val result : ExportVM = apiInstance.exportsUpdateTags(id, fileTagsUpdateVM)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ExportsApi#exportsUpdateTags")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ExportsApi#exportsUpdateTags")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
id kotlin.String
fileTagsUpdateVM FileTagsUpdateVM [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