DownloadApi

All URIs are relative to http://localhost

Method	HTTP request	Description
downloadGetExport	GET /download/e/{id}	Returns a export file with specified id
downloadGetExportThumbnail	GET /download/e/{id}/thumbnail	Returns export's thumbnail
downloadGetExports	GET /download/es/{archiveName}	Returns a zip archive with selected ids
downloadGetLastSVGExport	GET /download/lastPreview/{reportId}	returns export, that was created from report with specified id. INTERNAL USAGE ONLY!
downloadGetReport	GET /download/r/{id}	Returns a prepared file with specified id
downloadGetReportThumbnail	GET /download/r/{id}/thumbnail	Returns report's thumbnail
downloadGetReports	GET /download/rs/{archiveName}	Returns a zip archive with selected files
downloadGetTemplate	GET /download/t/{id}	Returns a Template file with specified id
downloadGetTemplateThumbnail	GET /download/t/{id}/thumbnail	Returns template's thumbnail
downloadGetTemplates	GET /download/ts/{archiveName}	Returns a zip archive with selected files

downloadGetExport

java.io.File downloadGetExport(id, preview)

Returns a export file with specified id

Example

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

val apiInstance = DownloadApi()
val id : kotlin.String = id_example // kotlin.String | 
val preview : kotlin.Boolean = true // kotlin.Boolean | 
try {
    val result : java.io.File = apiInstance.downloadGetExport(id, preview)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling DownloadApi#downloadGetExport")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling DownloadApi#downloadGetExport")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
id	kotlin.String
preview	kotlin.Boolean		[optional] [default to false]

Return type

java.io.File

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/octet-stream

downloadGetExportThumbnail

java.io.File downloadGetExportThumbnail(id)

Returns export's thumbnail

Example

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

val apiInstance = DownloadApi()
val id : kotlin.String = id_example // kotlin.String | 
try {
    val result : java.io.File = apiInstance.downloadGetExportThumbnail(id)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling DownloadApi#downloadGetExportThumbnail")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling DownloadApi#downloadGetExportThumbnail")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
id	kotlin.String

Return type

java.io.File

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

downloadGetExports

java.io.File downloadGetExports(archiveName, fileIds, folderIds)

Returns a zip archive with selected ids

Example

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

val apiInstance = DownloadApi()
val archiveName : kotlin.String = archiveName_example // kotlin.String | name of the created archive
val fileIds : kotlin.String = fileIds_example // kotlin.String | ids separated with a ',' sign
val folderIds : kotlin.String = folderIds_example // kotlin.String | ids separated with a ',' sign
try {
    val result : java.io.File = apiInstance.downloadGetExports(archiveName, fileIds, folderIds)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling DownloadApi#downloadGetExports")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling DownloadApi#downloadGetExports")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
archiveName	kotlin.String	name of the created archive
fileIds	kotlin.String	ids separated with a ',' sign	[optional]
folderIds	kotlin.String	ids separated with a ',' sign	[optional]

Return type

java.io.File

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

downloadGetLastSVGExport

java.io.File downloadGetLastSVGExport(reportId)

returns export, that was created from report with specified id. INTERNAL USAGE ONLY!

Example

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

val apiInstance = DownloadApi()
val reportId : kotlin.String = reportId_example // kotlin.String | 
try {
    val result : java.io.File = apiInstance.downloadGetLastSVGExport(reportId)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling DownloadApi#downloadGetLastSVGExport")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling DownloadApi#downloadGetLastSVGExport")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
reportId	kotlin.String

Return type

java.io.File

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/octet-stream

downloadGetReport

java.io.File downloadGetReport(id)

Returns a prepared file with specified id

Example

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

val apiInstance = DownloadApi()
val id : kotlin.String = id_example // kotlin.String | 
try {
    val result : java.io.File = apiInstance.downloadGetReport(id)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling DownloadApi#downloadGetReport")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling DownloadApi#downloadGetReport")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
id	kotlin.String

Return type

java.io.File

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/octet-stream

downloadGetReportThumbnail

java.io.File downloadGetReportThumbnail(id)

Returns report's thumbnail

Example

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

val apiInstance = DownloadApi()
val id : kotlin.String = id_example // kotlin.String | 
try {
    val result : java.io.File = apiInstance.downloadGetReportThumbnail(id)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling DownloadApi#downloadGetReportThumbnail")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling DownloadApi#downloadGetReportThumbnail")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
id	kotlin.String

Return type

java.io.File

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

downloadGetReports

java.io.File downloadGetReports(archiveName, fileIds, folderIds)

Returns a zip archive with selected files

Example

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

val apiInstance = DownloadApi()
val archiveName : kotlin.String = archiveName_example // kotlin.String | name of the created archive
val fileIds : kotlin.String = fileIds_example // kotlin.String | ids separated with a ',' sign
val folderIds : kotlin.String = folderIds_example // kotlin.String | ids separated with a ',' sign
try {
    val result : java.io.File = apiInstance.downloadGetReports(archiveName, fileIds, folderIds)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling DownloadApi#downloadGetReports")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling DownloadApi#downloadGetReports")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
archiveName	kotlin.String	name of the created archive
fileIds	kotlin.String	ids separated with a ',' sign	[optional]
folderIds	kotlin.String	ids separated with a ',' sign	[optional]

Return type

java.io.File

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

downloadGetTemplate

java.io.File downloadGetTemplate(id)

Returns a Template file with specified id

Example

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

val apiInstance = DownloadApi()
val id : kotlin.String = id_example // kotlin.String | template id
try {
    val result : java.io.File = apiInstance.downloadGetTemplate(id)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling DownloadApi#downloadGetTemplate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling DownloadApi#downloadGetTemplate")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
id	kotlin.String	template id

Return type

java.io.File

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/octet-stream

downloadGetTemplateThumbnail

java.io.File downloadGetTemplateThumbnail(id)

Returns template's thumbnail

Example

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

val apiInstance = DownloadApi()
val id : kotlin.String = id_example // kotlin.String | 
try {
    val result : java.io.File = apiInstance.downloadGetTemplateThumbnail(id)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling DownloadApi#downloadGetTemplateThumbnail")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling DownloadApi#downloadGetTemplateThumbnail")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
id	kotlin.String

Return type

java.io.File

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

downloadGetTemplates

java.io.File downloadGetTemplates(archiveName, fileIds, folderIds)

Returns a zip archive with selected files

Example

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

val apiInstance = DownloadApi()
val archiveName : kotlin.String = archiveName_example // kotlin.String | name of the created archive
val fileIds : kotlin.String = fileIds_example // kotlin.String | ids separated with a ',' sign
val folderIds : kotlin.String = folderIds_example // kotlin.String | ids separated with a ',' sign
try {
    val result : java.io.File = apiInstance.downloadGetTemplates(archiveName, fileIds, folderIds)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling DownloadApi#downloadGetTemplates")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling DownloadApi#downloadGetTemplates")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
archiveName	kotlin.String	name of the created archive
fileIds	kotlin.String	ids separated with a ',' sign	[optional]
folderIds	kotlin.String	ids separated with a ',' sign	[optional]

Return type

java.io.File

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: application/json

Files

DownloadApi.md

Latest commit

History

DownloadApi.md

File metadata and controls

DownloadApi

downloadGetExport

Example

Parameters

Return type

Authorization

HTTP request headers

downloadGetExportThumbnail

Example

Parameters

Return type

Authorization

HTTP request headers

downloadGetExports

Example

Parameters

Return type

Authorization

HTTP request headers

downloadGetLastSVGExport

Example

Parameters

Return type

Authorization

HTTP request headers

downloadGetReport

Example

Parameters

Return type

Authorization

HTTP request headers

downloadGetReportThumbnail

Example

Parameters

Return type

Authorization

HTTP request headers

downloadGetReports

Example

Parameters

Return type

Authorization

HTTP request headers

downloadGetTemplate

Example

Parameters

Return type

Authorization

HTTP request headers

downloadGetTemplateThumbnail

Example

Parameters

Return type

Authorization

HTTP request headers

downloadGetTemplates

Example

Parameters

Return type

Authorization

HTTP request headers