FastreportCloudSdk.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, opts)

Returns a export file with specified id

Example

import FastreportCloudSdk from 'fastreport-cloud-sdk';
let defaultClient = FastreportCloudSdk.ApiClient.instance;
// Configure HTTP basic authorization: ApiKey
let ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.username = 'YOUR USERNAME';
ApiKey.password = 'YOUR PASSWORD';
// Configure Bearer (JWT) access token for authorization: JWT
let JWT = defaultClient.authentications['JWT'];
JWT.accessToken = "YOUR ACCESS TOKEN"

let apiInstance = new FastreportCloudSdk.DownloadApi();
let id = "id_example"; // String | 
let opts = {
  'preview': false // Boolean | 
};
apiInstance.downloadGetExport(id, opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

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

downloadGetExportThumbnail

File downloadGetExportThumbnail(id)

Returns export's thumbnail

Example

import FastreportCloudSdk from 'fastreport-cloud-sdk';
let defaultClient = FastreportCloudSdk.ApiClient.instance;
// Configure HTTP basic authorization: ApiKey
let ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.username = 'YOUR USERNAME';
ApiKey.password = 'YOUR PASSWORD';
// Configure Bearer (JWT) access token for authorization: JWT
let JWT = defaultClient.authentications['JWT'];
JWT.accessToken = "YOUR ACCESS TOKEN"

let apiInstance = new FastreportCloudSdk.DownloadApi();
let id = "id_example"; // String | 
apiInstance.downloadGetExportThumbnail(id).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

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

downloadGetExports

File downloadGetExports(archiveName, opts)

Returns a zip archive with selected ids

Example

import FastreportCloudSdk from 'fastreport-cloud-sdk';
let defaultClient = FastreportCloudSdk.ApiClient.instance;
// Configure HTTP basic authorization: ApiKey
let ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.username = 'YOUR USERNAME';
ApiKey.password = 'YOUR PASSWORD';
// Configure Bearer (JWT) access token for authorization: JWT
let JWT = defaultClient.authentications['JWT'];
JWT.accessToken = "YOUR ACCESS TOKEN"

let apiInstance = new FastreportCloudSdk.DownloadApi();
let archiveName = "archiveName_example"; // String | name of the created archive
let opts = {
  'fileIds': "fileIds_example", // String | ids separated with a ',' sign
  'folderIds': "folderIds_example" // String | ids separated with a ',' sign
};
apiInstance.downloadGetExports(archiveName, opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

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

downloadGetLastSVGExport

File downloadGetLastSVGExport(reportId)

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

Example

import FastreportCloudSdk from 'fastreport-cloud-sdk';
let defaultClient = FastreportCloudSdk.ApiClient.instance;
// Configure HTTP basic authorization: ApiKey
let ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.username = 'YOUR USERNAME';
ApiKey.password = 'YOUR PASSWORD';
// Configure Bearer (JWT) access token for authorization: JWT
let JWT = defaultClient.authentications['JWT'];
JWT.accessToken = "YOUR ACCESS TOKEN"

let apiInstance = new FastreportCloudSdk.DownloadApi();
let reportId = "reportId_example"; // String | 
apiInstance.downloadGetLastSVGExport(reportId).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

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

downloadGetReport

File downloadGetReport(id)

Returns a prepared file with specified id

Example

import FastreportCloudSdk from 'fastreport-cloud-sdk';
let defaultClient = FastreportCloudSdk.ApiClient.instance;
// Configure HTTP basic authorization: ApiKey
let ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.username = 'YOUR USERNAME';
ApiKey.password = 'YOUR PASSWORD';
// Configure Bearer (JWT) access token for authorization: JWT
let JWT = defaultClient.authentications['JWT'];
JWT.accessToken = "YOUR ACCESS TOKEN"

let apiInstance = new FastreportCloudSdk.DownloadApi();
let id = "id_example"; // String | 
apiInstance.downloadGetReport(id).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

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

downloadGetReportThumbnail

File downloadGetReportThumbnail(id)

Returns report's thumbnail

Example

import FastreportCloudSdk from 'fastreport-cloud-sdk';
let defaultClient = FastreportCloudSdk.ApiClient.instance;
// Configure HTTP basic authorization: ApiKey
let ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.username = 'YOUR USERNAME';
ApiKey.password = 'YOUR PASSWORD';
// Configure Bearer (JWT) access token for authorization: JWT
let JWT = defaultClient.authentications['JWT'];
JWT.accessToken = "YOUR ACCESS TOKEN"

let apiInstance = new FastreportCloudSdk.DownloadApi();
let id = "id_example"; // String | 
apiInstance.downloadGetReportThumbnail(id).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

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

downloadGetReports

File downloadGetReports(archiveName, opts)

Returns a zip archive with selected files

Example

import FastreportCloudSdk from 'fastreport-cloud-sdk';
let defaultClient = FastreportCloudSdk.ApiClient.instance;
// Configure HTTP basic authorization: ApiKey
let ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.username = 'YOUR USERNAME';
ApiKey.password = 'YOUR PASSWORD';
// Configure Bearer (JWT) access token for authorization: JWT
let JWT = defaultClient.authentications['JWT'];
JWT.accessToken = "YOUR ACCESS TOKEN"

let apiInstance = new FastreportCloudSdk.DownloadApi();
let archiveName = "archiveName_example"; // String | name of the created archive
let opts = {
  'fileIds': "fileIds_example", // String | ids separated with a ',' sign
  'folderIds': "folderIds_example" // String | ids separated with a ',' sign
};
apiInstance.downloadGetReports(archiveName, opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

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

downloadGetTemplate

File downloadGetTemplate(id)

Returns a Template file with specified id

Example

import FastreportCloudSdk from 'fastreport-cloud-sdk';
let defaultClient = FastreportCloudSdk.ApiClient.instance;
// Configure HTTP basic authorization: ApiKey
let ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.username = 'YOUR USERNAME';
ApiKey.password = 'YOUR PASSWORD';
// Configure Bearer (JWT) access token for authorization: JWT
let JWT = defaultClient.authentications['JWT'];
JWT.accessToken = "YOUR ACCESS TOKEN"

let apiInstance = new FastreportCloudSdk.DownloadApi();
let id = "id_example"; // String | template id
apiInstance.downloadGetTemplate(id).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

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

downloadGetTemplateThumbnail

File downloadGetTemplateThumbnail(id)

Returns template's thumbnail

Example

import FastreportCloudSdk from 'fastreport-cloud-sdk';
let defaultClient = FastreportCloudSdk.ApiClient.instance;
// Configure HTTP basic authorization: ApiKey
let ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.username = 'YOUR USERNAME';
ApiKey.password = 'YOUR PASSWORD';
// Configure Bearer (JWT) access token for authorization: JWT
let JWT = defaultClient.authentications['JWT'];
JWT.accessToken = "YOUR ACCESS TOKEN"

let apiInstance = new FastreportCloudSdk.DownloadApi();
let id = "id_example"; // String | 
apiInstance.downloadGetTemplateThumbnail(id).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

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

downloadGetTemplates

File downloadGetTemplates(archiveName, opts)

Returns a zip archive with selected files

Example

import FastreportCloudSdk from 'fastreport-cloud-sdk';
let defaultClient = FastreportCloudSdk.ApiClient.instance;
// Configure HTTP basic authorization: ApiKey
let ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.username = 'YOUR USERNAME';
ApiKey.password = 'YOUR PASSWORD';
// Configure Bearer (JWT) access token for authorization: JWT
let JWT = defaultClient.authentications['JWT'];
JWT.accessToken = "YOUR ACCESS TOKEN"

let apiInstance = new FastreportCloudSdk.DownloadApi();
let archiveName = "archiveName_example"; // String | name of the created archive
let opts = {
  'fileIds': "fileIds_example", // String | ids separated with a ',' sign
  'folderIds': "folderIds_example" // String | ids separated with a ',' sign
};
apiInstance.downloadGetTemplates(archiveName, opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

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

Files

DownloadApi.md

Latest commit

History

DownloadApi.md

File metadata and controls

FastreportCloudSdk.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