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

File downloadGetExport(id, preview)

Returns a export file with specified id

Example

// Import classes:
import cloud.fastreport.ApiClient;
import cloud.fastreport.ApiException;
import cloud.fastreport.Configuration;
import cloud.fastreport.auth.*;
import cloud.fastreport.models.*;
import cloud.fastreport.client.DownloadApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");
        
        // Configure HTTP basic authorization: ApiKey
        HttpBasicAuth ApiKey = (HttpBasicAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setUsername("YOUR USERNAME");
        ApiKey.setPassword("YOUR PASSWORD");

        // Configure HTTP bearer authorization: JWT
        HttpBearerAuth JWT = (HttpBearerAuth) defaultClient.getAuthentication("JWT");
        JWT.setBearerToken("BEARER TOKEN");

        DownloadApi apiInstance = new DownloadApi(defaultClient);
        String id = "id_example"; // String | 
        Boolean preview = false; // Boolean | 
        try {
            File result = apiInstance.downloadGetExport(id, preview);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DownloadApi#downloadGetExport");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

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

Return type

File

Authorization

ApiKey, JWT

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Specified file was found	-
404	Specified file was not found or user do not has access to the file	-
400	Bad id provided	-
402	Subscription is blocked	-
403	Not enough permissions for the operation	-

downloadGetExportThumbnail

File downloadGetExportThumbnail(id)

Returns export's thumbnail

Example

// Import classes:
import cloud.fastreport.ApiClient;
import cloud.fastreport.ApiException;
import cloud.fastreport.Configuration;
import cloud.fastreport.auth.*;
import cloud.fastreport.models.*;
import cloud.fastreport.client.DownloadApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");
        
        // Configure HTTP basic authorization: ApiKey
        HttpBasicAuth ApiKey = (HttpBasicAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setUsername("YOUR USERNAME");
        ApiKey.setPassword("YOUR PASSWORD");

        // Configure HTTP bearer authorization: JWT
        HttpBearerAuth JWT = (HttpBearerAuth) defaultClient.getAuthentication("JWT");
        JWT.setBearerToken("BEARER TOKEN");

        DownloadApi apiInstance = new DownloadApi(defaultClient);
        String id = "id_example"; // String | 
        try {
            File result = apiInstance.downloadGetExportThumbnail(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DownloadApi#downloadGetExportThumbnail");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
id	String

Return type

File

Authorization

ApiKey, JWT

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, image/png, image/jpeg

HTTP response details

Status code	Description	Response headers
200	Specified thumbnail was found	-
404	Specified thumbnail was not found or user do not has access to it	-
400	Bad id provided	-
402	Subscription is blocked	-
403	Not enough permissions for the operation	-

downloadGetExports

File downloadGetExports(archiveName, fileIds, folderIds)

Returns a zip archive with selected ids

Example

// Import classes:
import cloud.fastreport.ApiClient;
import cloud.fastreport.ApiException;
import cloud.fastreport.Configuration;
import cloud.fastreport.auth.*;
import cloud.fastreport.models.*;
import cloud.fastreport.client.DownloadApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");
        
        // Configure HTTP basic authorization: ApiKey
        HttpBasicAuth ApiKey = (HttpBasicAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setUsername("YOUR USERNAME");
        ApiKey.setPassword("YOUR PASSWORD");

        // Configure HTTP bearer authorization: JWT
        HttpBearerAuth JWT = (HttpBearerAuth) defaultClient.getAuthentication("JWT");
        JWT.setBearerToken("BEARER TOKEN");

        DownloadApi apiInstance = new DownloadApi(defaultClient);
        String archiveName = "archiveName_example"; // String | name of the created archive
        String fileIds = "fileIds_example"; // String | ids separated with a ',' sign
        String folderIds = "folderIds_example"; // String | ids separated with a ',' sign
        try {
            File result = apiInstance.downloadGetExports(archiveName, fileIds, folderIds);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DownloadApi#downloadGetExports");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

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

Return type

File

Authorization

ApiKey, JWT

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, application/zip

HTTP response details

Status code	Description	Response headers
200	Specified file was found	-
400	Bad id provided	-
402	Subscription is blocked	-
403	Not enough permissions for the operation	-
404	Specified file was not found or user do not has access to the file	-

downloadGetLastSVGExport

File downloadGetLastSVGExport(reportId)

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

Example

// Import classes:
import cloud.fastreport.ApiClient;
import cloud.fastreport.ApiException;
import cloud.fastreport.Configuration;
import cloud.fastreport.auth.*;
import cloud.fastreport.models.*;
import cloud.fastreport.client.DownloadApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");
        
        // Configure HTTP basic authorization: ApiKey
        HttpBasicAuth ApiKey = (HttpBasicAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setUsername("YOUR USERNAME");
        ApiKey.setPassword("YOUR PASSWORD");

        // Configure HTTP bearer authorization: JWT
        HttpBearerAuth JWT = (HttpBearerAuth) defaultClient.getAuthentication("JWT");
        JWT.setBearerToken("BEARER TOKEN");

        DownloadApi apiInstance = new DownloadApi(defaultClient);
        String reportId = "reportId_example"; // String | 
        try {
            File result = apiInstance.downloadGetLastSVGExport(reportId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DownloadApi#downloadGetLastSVGExport");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
reportId	String

Return type

File

Authorization

ApiKey, JWT

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Success	-
404	Not Found	-
400	Bad Request	-
402	Client Error	-
403	Forbidden	-

downloadGetReport

File downloadGetReport(id)

Returns a prepared file with specified id

Example

// Import classes:
import cloud.fastreport.ApiClient;
import cloud.fastreport.ApiException;
import cloud.fastreport.Configuration;
import cloud.fastreport.auth.*;
import cloud.fastreport.models.*;
import cloud.fastreport.client.DownloadApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");
        
        // Configure HTTP basic authorization: ApiKey
        HttpBasicAuth ApiKey = (HttpBasicAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setUsername("YOUR USERNAME");
        ApiKey.setPassword("YOUR PASSWORD");

        // Configure HTTP bearer authorization: JWT
        HttpBearerAuth JWT = (HttpBearerAuth) defaultClient.getAuthentication("JWT");
        JWT.setBearerToken("BEARER TOKEN");

        DownloadApi apiInstance = new DownloadApi(defaultClient);
        String id = "id_example"; // String | 
        try {
            File result = apiInstance.downloadGetReport(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DownloadApi#downloadGetReport");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
id	String

Return type

File

Authorization

ApiKey, JWT

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Specified file was found	-
404	Specified file was not found or user do not has access to the file	-
400	bad id provided	-
402	Subscription is blocked	-
403	Not enough permissions	-

downloadGetReportThumbnail

File downloadGetReportThumbnail(id)

Returns report's thumbnail

Example

// Import classes:
import cloud.fastreport.ApiClient;
import cloud.fastreport.ApiException;
import cloud.fastreport.Configuration;
import cloud.fastreport.auth.*;
import cloud.fastreport.models.*;
import cloud.fastreport.client.DownloadApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");
        
        // Configure HTTP basic authorization: ApiKey
        HttpBasicAuth ApiKey = (HttpBasicAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setUsername("YOUR USERNAME");
        ApiKey.setPassword("YOUR PASSWORD");

        // Configure HTTP bearer authorization: JWT
        HttpBearerAuth JWT = (HttpBearerAuth) defaultClient.getAuthentication("JWT");
        JWT.setBearerToken("BEARER TOKEN");

        DownloadApi apiInstance = new DownloadApi(defaultClient);
        String id = "id_example"; // String | 
        try {
            File result = apiInstance.downloadGetReportThumbnail(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DownloadApi#downloadGetReportThumbnail");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
id	String

Return type

File

Authorization

ApiKey, JWT

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, image/png, image/jpeg

HTTP response details

Status code	Description	Response headers
200	Specified thumbnail was found	-
404	Specified thumbnail was not found or user do not has access to it	-
400	Bad id provided	-
402	Subscription is blocked	-
403	Not enough permissions for the operation	-

downloadGetReports

File downloadGetReports(archiveName, fileIds, folderIds)

Returns a zip archive with selected files

Example

// Import classes:
import cloud.fastreport.ApiClient;
import cloud.fastreport.ApiException;
import cloud.fastreport.Configuration;
import cloud.fastreport.auth.*;
import cloud.fastreport.models.*;
import cloud.fastreport.client.DownloadApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");
        
        // Configure HTTP basic authorization: ApiKey
        HttpBasicAuth ApiKey = (HttpBasicAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setUsername("YOUR USERNAME");
        ApiKey.setPassword("YOUR PASSWORD");

        // Configure HTTP bearer authorization: JWT
        HttpBearerAuth JWT = (HttpBearerAuth) defaultClient.getAuthentication("JWT");
        JWT.setBearerToken("BEARER TOKEN");

        DownloadApi apiInstance = new DownloadApi(defaultClient);
        String archiveName = "archiveName_example"; // String | name of the created archive
        String fileIds = "fileIds_example"; // String | ids separated with a ',' sign
        String folderIds = "folderIds_example"; // String | ids separated with a ',' sign
        try {
            File result = apiInstance.downloadGetReports(archiveName, fileIds, folderIds);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DownloadApi#downloadGetReports");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

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

Return type

File

Authorization

ApiKey, JWT

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, application/zip

HTTP response details

Status code	Description	Response headers
200	File has been downloaded	-
404	files is not found	-
400	wrong parameters provided	-
402	Subscription is blocked	-
403	You don't have rights for the operation	-

downloadGetTemplate

File downloadGetTemplate(id)

Returns a Template file with specified id

Example

// Import classes:
import cloud.fastreport.ApiClient;
import cloud.fastreport.ApiException;
import cloud.fastreport.Configuration;
import cloud.fastreport.auth.*;
import cloud.fastreport.models.*;
import cloud.fastreport.client.DownloadApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");
        
        // Configure HTTP basic authorization: ApiKey
        HttpBasicAuth ApiKey = (HttpBasicAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setUsername("YOUR USERNAME");
        ApiKey.setPassword("YOUR PASSWORD");

        // Configure HTTP bearer authorization: JWT
        HttpBearerAuth JWT = (HttpBearerAuth) defaultClient.getAuthentication("JWT");
        JWT.setBearerToken("BEARER TOKEN");

        DownloadApi apiInstance = new DownloadApi(defaultClient);
        String id = "id_example"; // String | template id
        try {
            File result = apiInstance.downloadGetTemplate(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DownloadApi#downloadGetTemplate");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
id	String	template id

Return type

File

Authorization

ApiKey, JWT

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Specified file was found	-
404	Specified file was not found or user do not has access to the file	-
400	bad id provided	-
402	Subscription is blocked	-
403	Not enough permissions	-

downloadGetTemplateThumbnail

File downloadGetTemplateThumbnail(id)

Returns template's thumbnail

Example

// Import classes:
import cloud.fastreport.ApiClient;
import cloud.fastreport.ApiException;
import cloud.fastreport.Configuration;
import cloud.fastreport.auth.*;
import cloud.fastreport.models.*;
import cloud.fastreport.client.DownloadApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");
        
        // Configure HTTP basic authorization: ApiKey
        HttpBasicAuth ApiKey = (HttpBasicAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setUsername("YOUR USERNAME");
        ApiKey.setPassword("YOUR PASSWORD");

        // Configure HTTP bearer authorization: JWT
        HttpBearerAuth JWT = (HttpBearerAuth) defaultClient.getAuthentication("JWT");
        JWT.setBearerToken("BEARER TOKEN");

        DownloadApi apiInstance = new DownloadApi(defaultClient);
        String id = "id_example"; // String | 
        try {
            File result = apiInstance.downloadGetTemplateThumbnail(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DownloadApi#downloadGetTemplateThumbnail");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
id	String

Return type

File

Authorization

ApiKey, JWT

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, image/png, image/jpeg

HTTP response details

Status code	Description	Response headers
200	Specified thumbnail was found	-
404	Specified thumbnail was not found or user do not has access to it	-
400	Bad id provided	-
402	Subscription is blocked	-
403	Not enough permissions for the operation	-

downloadGetTemplates

File downloadGetTemplates(archiveName, fileIds, folderIds)

Returns a zip archive with selected files

Example

// Import classes:
import cloud.fastreport.ApiClient;
import cloud.fastreport.ApiException;
import cloud.fastreport.Configuration;
import cloud.fastreport.auth.*;
import cloud.fastreport.models.*;
import cloud.fastreport.client.DownloadApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");
        
        // Configure HTTP basic authorization: ApiKey
        HttpBasicAuth ApiKey = (HttpBasicAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setUsername("YOUR USERNAME");
        ApiKey.setPassword("YOUR PASSWORD");

        // Configure HTTP bearer authorization: JWT
        HttpBearerAuth JWT = (HttpBearerAuth) defaultClient.getAuthentication("JWT");
        JWT.setBearerToken("BEARER TOKEN");

        DownloadApi apiInstance = new DownloadApi(defaultClient);
        String archiveName = "archiveName_example"; // String | name of the created archive
        String fileIds = "fileIds_example"; // String | ids separated with a ',' sign
        String folderIds = "folderIds_example"; // String | ids separated with a ',' sign
        try {
            File result = apiInstance.downloadGetTemplates(archiveName, fileIds, folderIds);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DownloadApi#downloadGetTemplates");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

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

Return type

File

Authorization

ApiKey, JWT

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, application/zip

HTTP response details

Status code	Description	Response headers
200	File has been downloaded	-
400	wrong parameters provided	-
402	Subscription is blocked	-
403	You don't have rights for the operation	-
404	files is not found	-

Files

DownloadApi.md

Latest commit

History

DownloadApi.md

File metadata and controls

DownloadApi

downloadGetExport

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

downloadGetExportThumbnail

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

downloadGetExports

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

downloadGetLastSVGExport

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

downloadGetReport

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

downloadGetReportThumbnail

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

downloadGetReports

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

downloadGetTemplate

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

downloadGetTemplateThumbnail

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

downloadGetTemplates

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details