fastreport_cloud_sdk.DownloadApi

All URIs are relative to http://localhost

Method	HTTP request	Description
download_get_export	GET /download/e/{id}	Returns a export file with specified id
download_get_export_thumbnail	GET /download/e/{id}/thumbnail	Returns export's thumbnail
download_get_exports	GET /download/es/{archiveName}	Returns a zip archive with selected ids
download_get_last_svg_export	GET /download/lastPreview/{reportId}	returns export, that was created from report with specified id. INTERNAL USAGE ONLY!
download_get_report	GET /download/r/{id}	Returns a prepared file with specified id
download_get_report_thumbnail	GET /download/r/{id}/thumbnail	Returns report's thumbnail
download_get_reports	GET /download/rs/{archiveName}	Returns a zip archive with selected files
download_get_template	GET /download/t/{id}	Returns a Template file with specified id
download_get_template_thumbnail	GET /download/t/{id}/thumbnail	Returns template's thumbnail
download_get_templates	GET /download/ts/{archiveName}	Returns a zip archive with selected files

download_get_export

bytearray download_get_export(id, preview=preview)

Returns a export file with specified id

Example

Basic Authentication (ApiKey):
Bearer (JWT) Authentication (JWT):

import fastreport_cloud_sdk
from fastreport_cloud_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = fastreport_cloud_sdk.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: ApiKey
configuration = fastreport_cloud_sdk.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with fastreport_cloud_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = fastreport_cloud_sdk.DownloadApi(api_client)
    id = 'id_example' # str | 
    preview = False # bool |  (optional) (default to False)

    try:
        # Returns a export file with specified id
        api_response = api_instance.download_get_export(id, preview=preview)
        print("The response of DownloadApi->download_get_export:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DownloadApi->download_get_export: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
preview	bool		[optional] [default to False]

Return type

bytearray

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	-
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	-
500	Try again, if error still here - text our support	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

download_get_export_thumbnail

bytearray download_get_export_thumbnail(id)

Returns export's thumbnail

Example

Basic Authentication (ApiKey):
Bearer (JWT) Authentication (JWT):

import fastreport_cloud_sdk
from fastreport_cloud_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = fastreport_cloud_sdk.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: ApiKey
configuration = fastreport_cloud_sdk.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with fastreport_cloud_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = fastreport_cloud_sdk.DownloadApi(api_client)
    id = 'id_example' # str | 

    try:
        # Returns export's thumbnail
        api_response = api_instance.download_get_export_thumbnail(id)
        print("The response of DownloadApi->download_get_export_thumbnail:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DownloadApi->download_get_export_thumbnail: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str

Return type

bytearray

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	-
400	Bad id provided	-
402	Subscription is blocked	-
403	Not enough permissions for the operation	-
404	Specified thumbnail was not found or user do not has access to it	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

download_get_exports

bytearray download_get_exports(archive_name, file_ids=file_ids, folder_ids=folder_ids)

Returns a zip archive with selected ids

Example

Basic Authentication (ApiKey):
Bearer (JWT) Authentication (JWT):

import fastreport_cloud_sdk
from fastreport_cloud_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = fastreport_cloud_sdk.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: ApiKey
configuration = fastreport_cloud_sdk.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with fastreport_cloud_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = fastreport_cloud_sdk.DownloadApi(api_client)
    archive_name = 'archive_name_example' # str | name of the created archive
    file_ids = 'file_ids_example' # str | ids separated with a ',' sign (optional)
    folder_ids = 'folder_ids_example' # str | ids separated with a ',' sign (optional)

    try:
        # Returns a zip archive with selected ids
        api_response = api_instance.download_get_exports(archive_name, file_ids=file_ids, folder_ids=folder_ids)
        print("The response of DownloadApi->download_get_exports:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DownloadApi->download_get_exports: %s\n" % e)

Parameters

Name	Type	Description	Notes
archive_name	str	name of the created archive
file_ids	str	ids separated with a ',' sign	[optional]
folder_ids	str	ids separated with a ',' sign	[optional]

Return type

bytearray

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 files was found	-
400	Bad id provided	-
402	Subscription is blocked	-
403	Not enough permissions for the operation	-
404	Specified files were not found or user do not has access to the file	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

download_get_last_svg_export

bytearray download_get_last_svg_export(report_id)

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

Example

Basic Authentication (ApiKey):
Bearer (JWT) Authentication (JWT):

import fastreport_cloud_sdk
from fastreport_cloud_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = fastreport_cloud_sdk.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: ApiKey
configuration = fastreport_cloud_sdk.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with fastreport_cloud_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = fastreport_cloud_sdk.DownloadApi(api_client)
    report_id = 'report_id_example' # str | 

    try:
        # returns export, that was created from report with specified id.  INTERNAL USAGE ONLY!
        api_response = api_instance.download_get_last_svg_export(report_id)
        print("The response of DownloadApi->download_get_last_svg_export:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DownloadApi->download_get_last_svg_export: %s\n" % e)

Parameters

Name	Type	Description	Notes
report_id	str

Return type

bytearray

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

download_get_report

bytearray download_get_report(id)

Returns a prepared file with specified id

Example

Basic Authentication (ApiKey):
Bearer (JWT) Authentication (JWT):

import fastreport_cloud_sdk
from fastreport_cloud_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = fastreport_cloud_sdk.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: ApiKey
configuration = fastreport_cloud_sdk.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with fastreport_cloud_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = fastreport_cloud_sdk.DownloadApi(api_client)
    id = 'id_example' # str | 

    try:
        # Returns a prepared file with specified id
        api_response = api_instance.download_get_report(id)
        print("The response of DownloadApi->download_get_report:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DownloadApi->download_get_report: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str

Return type

bytearray

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	-
400	Bad id provided	-
402	Subscription is blocked	-
403	Not enough permissions	-
404	Specified file was not found or user do not has access to the file	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

download_get_report_thumbnail

bytearray download_get_report_thumbnail(id)

Returns report's thumbnail

Example

Basic Authentication (ApiKey):
Bearer (JWT) Authentication (JWT):

import fastreport_cloud_sdk
from fastreport_cloud_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = fastreport_cloud_sdk.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: ApiKey
configuration = fastreport_cloud_sdk.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with fastreport_cloud_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = fastreport_cloud_sdk.DownloadApi(api_client)
    id = 'id_example' # str | 

    try:
        # Returns report's thumbnail
        api_response = api_instance.download_get_report_thumbnail(id)
        print("The response of DownloadApi->download_get_report_thumbnail:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DownloadApi->download_get_report_thumbnail: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str

Return type

bytearray

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	-
400	Bad id provided	-
402	Subscription is blocked	-
403	Not enough permissions for the operation	-
404	Specified thumbnail was not found or user do not has access to it	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

download_get_reports

bytearray download_get_reports(archive_name, file_ids=file_ids, folder_ids=folder_ids)

Returns a zip archive with selected files

Example

Basic Authentication (ApiKey):
Bearer (JWT) Authentication (JWT):

import fastreport_cloud_sdk
from fastreport_cloud_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = fastreport_cloud_sdk.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: ApiKey
configuration = fastreport_cloud_sdk.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with fastreport_cloud_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = fastreport_cloud_sdk.DownloadApi(api_client)
    archive_name = 'archive_name_example' # str | name of the created archive
    file_ids = 'file_ids_example' # str | ids separated with a ',' sign (optional)
    folder_ids = 'folder_ids_example' # str | ids separated with a ',' sign (optional)

    try:
        # Returns a zip archive with selected files
        api_response = api_instance.download_get_reports(archive_name, file_ids=file_ids, folder_ids=folder_ids)
        print("The response of DownloadApi->download_get_reports:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DownloadApi->download_get_reports: %s\n" % e)

Parameters

Name	Type	Description	Notes
archive_name	str	name of the created archive
file_ids	str	ids separated with a ',' sign	[optional]
folder_ids	str	ids separated with a ',' sign	[optional]

Return type

bytearray

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	Files were downloaded	-
400	Wrong parameters provided	-
402	Subscription is blocked	-
403	You don't have permissions for the operation	-
404	Files were not found	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

download_get_template

bytearray download_get_template(id)

Returns a Template file with specified id

Example

Basic Authentication (ApiKey):
Bearer (JWT) Authentication (JWT):

import fastreport_cloud_sdk
from fastreport_cloud_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = fastreport_cloud_sdk.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: ApiKey
configuration = fastreport_cloud_sdk.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with fastreport_cloud_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = fastreport_cloud_sdk.DownloadApi(api_client)
    id = 'id_example' # str | template id

    try:
        # Returns a Template file with specified id
        api_response = api_instance.download_get_template(id)
        print("The response of DownloadApi->download_get_template:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DownloadApi->download_get_template: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	template id

Return type

bytearray

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	-
400	Bad id provided	-
402	Subscription is blocked	-
403	Not enough permissions	-
404	Specified file was not found or user do not has access to the file	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

download_get_template_thumbnail

bytearray download_get_template_thumbnail(id)

Returns template's thumbnail

Example

Basic Authentication (ApiKey):
Bearer (JWT) Authentication (JWT):

import fastreport_cloud_sdk
from fastreport_cloud_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = fastreport_cloud_sdk.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: ApiKey
configuration = fastreport_cloud_sdk.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with fastreport_cloud_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = fastreport_cloud_sdk.DownloadApi(api_client)
    id = 'id_example' # str | 

    try:
        # Returns template's thumbnail
        api_response = api_instance.download_get_template_thumbnail(id)
        print("The response of DownloadApi->download_get_template_thumbnail:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DownloadApi->download_get_template_thumbnail: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str

Return type

bytearray

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	-
400	Bad id provided	-
402	Subscription is blocked	-
403	Not enough permissions for the operation	-
404	Specified thumbnail was not found or user do not has access to it	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

download_get_templates

bytearray download_get_templates(archive_name, file_ids=file_ids, folder_ids=folder_ids)

Returns a zip archive with selected files

Example

Basic Authentication (ApiKey):
Bearer (JWT) Authentication (JWT):

import fastreport_cloud_sdk
from fastreport_cloud_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = fastreport_cloud_sdk.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: ApiKey
configuration = fastreport_cloud_sdk.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with fastreport_cloud_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = fastreport_cloud_sdk.DownloadApi(api_client)
    archive_name = 'archive_name_example' # str | name of the created archive
    file_ids = 'file_ids_example' # str | ids separated with a ',' sign (optional)
    folder_ids = 'folder_ids_example' # str | ids separated with a ',' sign (optional)

    try:
        # Returns a zip archive with selected files
        api_response = api_instance.download_get_templates(archive_name, file_ids=file_ids, folder_ids=folder_ids)
        print("The response of DownloadApi->download_get_templates:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DownloadApi->download_get_templates: %s\n" % e)

Parameters

Name	Type	Description	Notes
archive_name	str	name of the created archive
file_ids	str	ids separated with a ',' sign	[optional]
folder_ids	str	ids separated with a ',' sign	[optional]

Return type

bytearray

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	Files were downloaded	-
400	Wrong parameters provided	-
402	Subscription is blocked	-
403	You don't have permissions for the operation	-
404	Files were not found	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FilesExpand file tree

DownloadApi.md

Latest commit

History

DownloadApi.md

File metadata and controls

fastreport_cloud_sdk.DownloadApi

download_get_export

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

download_get_export_thumbnail

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

download_get_exports

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

download_get_last_svg_export

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

download_get_report

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

download_get_report_thumbnail

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

download_get_reports

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

download_get_template

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

download_get_template_thumbnail

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

download_get_templates

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details