ExportsApi.md

fastreport_cloud_sdk.ExportsApi

All URIs are relative to http://localhost

Method	HTTP request	Description
export_folder_and_file_clear_recycle_bin	DELETE /api/rp/v1/Exports/{subscriptionId}/ClearRecycleBin	Delete all folders and files from recycle bin
export_folder_and_file_delete_files	POST /api/rp/v1/Exports/{subscriptionId}/DeleteFiles	Delete folders and files
export_folder_and_file_get_count	GET /api/rp/v1/Exports/Folder/{id}/CountFolderAndFiles	Get count of files and folders what contains in a specified folder
export_folder_and_file_get_folders_and_files	GET /api/rp/v1/Exports/Folder/{id}/ListFolderAndFiles	Get all folders and files from specified folder
export_folder_and_file_get_recycle_bin_folders_and_files	GET /api/rp/v1/Exports/{subscriptionId}/ListRecycleBinFolderAndFiles	Get all folders and files from recycle bin
export_folder_and_file_move_files_to_bin	POST /api/rp/v1/Exports/{subscriptionId}/ToBin	Move folders and files to bin
export_folder_and_file_recover_all_from_recycle_bin	POST /api/rp/v1/Exports/{subscriptionId}/RecoverRecycleBin	Recover all folders and files from recycle bin
export_folder_and_file_recover_files	POST /api/rp/v1/Exports/{subscriptionId}/RecoverFiles	Recover folders and files from bin
export_folders_calculate_folder_size	GET /api/rp/v1/Exports/Folder/{id}/size	Get specified folder, calculate it's size
export_folders_copy_folder	POST /api/rp/v1/Exports/Folder/{id}/Copy/{folderId}	Move folder to a specified folder
export_folders_delete_folder	DELETE /api/rp/v1/Exports/Folder/{id}	Delete specified folder
export_folders_get_breadcrumbs	GET /api/rp/v1/Exports/Folder/{id}/Breadcrumbs	Get specified folder breadcrumbs
export_folders_get_folder	GET /api/rp/v1/Exports/Folder/{id}	Get specified folder
export_folders_get_folders	GET /api/rp/v1/Exports/Folder/{id}/ListFolders	Get all folders from specified folder
export_folders_get_folders_count	GET /api/rp/v1/Exports/Folder/{id}/CountFolders	Get count of folders what contains in a specified folder
export_folders_get_or_create	GET /api/rp/v1/Exports/Folder/getOrCreate	Get specified folder
export_folders_get_permissions	GET /api/rp/v1/Exports/Folder/{id}/permissions	Get all folder permissions
export_folders_get_root_folder	GET /api/rp/v1/Exports/Root	Get user's root folder (without parents)
export_folders_move_folder	POST /api/rp/v1/Exports/Folder/{id}/Move/{folderId}	Move folder to a specified folder
export_folders_move_folder_to_bin	DELETE /api/rp/v1/Exports/Folder/{id}/ToBin	Move specified folder to recycle bin
export_folders_post_folder	POST /api/rp/v1/Exports/Folder/{id}/Folder	Create folder
export_folders_recover_folder	POST /api/rp/v1/Exports/Folder/{id}/Recover	Recover specified folder
export_folders_rename_folder	PUT /api/rp/v1/Exports/Folder/{id}/Rename	Rename a folder
export_folders_update_icon	PUT /api/rp/v1/Exports/Folder/{id}/Icon	Update a folder's icon
export_folders_update_permissions	POST /api/rp/v1/Exports/{id}/permissions	Update permissions
export_folders_update_tags	PUT /api/rp/v1/Exports/Folder/{id}/UpdateTags	Update tags
exports_copy_file	POST /api/rp/v1/Exports/File/{id}/Copy/{folderId}	Copy file to a specified folder
exports_delete_file	DELETE /api/rp/v1/Exports/File/{id}	Delete specified file
exports_get_file	GET /api/rp/v1/Exports/File/{id}
exports_get_file_history	GET /api/rp/v1/Exports/File/{id}/History	Returns list of actions, performed on this file
exports_get_files_count	GET /api/rp/v1/Exports/Folder/{id}/CountFiles	Get count of files what contains in a specified folder
exports_get_files_list	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.
exports_get_permissions	GET /api/rp/v1/Exports/File/{id}/permissions	Get all file permissions
exports_move_file	POST /api/rp/v1/Exports/File/{id}/Move/{folderId}	Move file to a specified folder
exports_move_file_to_bin	DELETE /api/rp/v1/Exports/File/{id}/ToBin	Move specified file to recycle bin
exports_recover_file	POST /api/rp/v1/Exports/File/{id}/Recover	Recover specified file from bin
exports_rename_file	PUT /api/rp/v1/Exports/File/{id}/Rename	Rename a file
exports_update_icon	PUT /api/rp/v1/Exports/File/{id}/Icon	Update a files's icon
exports_update_permissions	POST /api/rp/v1/Exports/File/{id}/permissions	Update permissions
exports_update_tags	PUT /api/rp/v1/Exports/File/{id}/UpdateTags	Update tags

export_folder_and_file_clear_recycle_bin

export_folder_and_file_clear_recycle_bin(subscription_id)

Delete all folders and files from recycle bin

User with a Delete RecycleBin permission can access this method.

Example

• Basic Authentication (ApiKey):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    subscription_id = 'subscription_id_example' # str | subscription id

    try:
        # Delete all folders and files from recycle bin
        api_instance.export_folder_and_file_clear_recycle_bin(subscription_id)
    except ApiException as e:
        print("Exception when calling ExportsApi->export_folder_and_file_clear_recycle_bin: %s\n" % e)

• Bearer (JWT) Authentication (JWT):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    subscription_id = 'subscription_id_example' # str | subscription id

    try:
        # Delete all folders and files from recycle bin
        api_instance.export_folder_and_file_clear_recycle_bin(subscription_id)
    except ApiException as e:
        print("Exception when calling ExportsApi->export_folder_and_file_clear_recycle_bin: %s\n" % e)

Parameters

Name	Type	Description	Notes
subscription_id	str	subscription id

Return type

void (empty response body)

Authorization

ApiKey, JWT

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
204	All folders and files in bin have been deleted	-
400	FolderId is null	-
403	You don't have rights for the operation	-
404	File or folder not found	-

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

export_folder_and_file_delete_files

export_folder_and_file_delete_files(subscription_id, selected_files_vm=selected_files_vm)

Delete folders and files

User with a Delete permission can access this method.

Example

• Basic Authentication (ApiKey):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    subscription_id = 'subscription_id_example' # str | id of current subscription
selected_files_vm = fastreport_cloud_sdk.SelectedFilesVM() # SelectedFilesVM | VM with files' ids and params of their destination (optional)

    try:
        # Delete folders and files
        api_instance.export_folder_and_file_delete_files(subscription_id, selected_files_vm=selected_files_vm)
    except ApiException as e:
        print("Exception when calling ExportsApi->export_folder_and_file_delete_files: %s\n" % e)

• Bearer (JWT) Authentication (JWT):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    subscription_id = 'subscription_id_example' # str | id of current subscription
selected_files_vm = fastreport_cloud_sdk.SelectedFilesVM() # SelectedFilesVM | VM with files' ids and params of their destination (optional)

    try:
        # Delete folders and files
        api_instance.export_folder_and_file_delete_files(subscription_id, selected_files_vm=selected_files_vm)
    except ApiException as e:
        print("Exception when calling ExportsApi->export_folder_and_file_delete_files: %s\n" % e)

Parameters

Name	Type	Description	Notes
subscription_id	str	id of current subscription
selected_files_vm	SelectedFilesVM	VM with files' ids and params of their destination	[optional]

Return type

void (empty response body)

Authorization

ApiKey, JWT

HTTP request headers

• Content-Type: application/json, text/json, application/*+json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
204	All folders and files have been deleted	-
400	FolderId is null	-
403	You don't have rights for the operation	-
404	File or folder not found	-

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

export_folder_and_file_get_count

CountVM export_folder_and_file_get_count(id, search_pattern=search_pattern, use_regex=use_regex)

Get count of files and folders what contains in a specified folder

User with a Get Count permission can access this method.

Example

• Basic Authentication (ApiKey):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    id = 'id_example' # str | folder id
search_pattern = 'search_pattern_example' # str | string, that must be incuded in file or folder name to be counted <br />              (leave undefined to count all files and folders) (optional)
use_regex = False # bool | set this to true if you want to use regular expression to search (optional) (default to False)

    try:
        # Get count of files and folders what contains in a specified folder
        api_response = api_instance.export_folder_and_file_get_count(id, search_pattern=search_pattern, use_regex=use_regex)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ExportsApi->export_folder_and_file_get_count: %s\n" % e)

• Bearer (JWT) Authentication (JWT):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    id = 'id_example' # str | folder id
search_pattern = 'search_pattern_example' # str | string, that must be incuded in file or folder name to be counted <br />              (leave undefined to count all files and folders) (optional)
use_regex = False # bool | set this to true if you want to use regular expression to search (optional) (default to False)

    try:
        # Get count of files and folders what contains in a specified folder
        api_response = api_instance.export_folder_and_file_get_count(id, search_pattern=search_pattern, use_regex=use_regex)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ExportsApi->export_folder_and_file_get_count: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	folder id
search_pattern	str	string, that must be incuded in file or folder name to be counted <br /> (leave undefined to count all files and folders)	[optional]
use_regex	bool	set this to true if you want to use regular expression to search	[optional] [default to False]

Return type

CountVM

Authorization

ApiKey, JWT

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Returns count of the files in a specified folder	-
400	FolderId is null	-
403	You don't have rights for the operation	-
404	Folder not found	-

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

export_folder_and_file_get_folders_and_files

FilesVM export_folder_and_file_get_folders_and_files(id, skip=skip, take=take, order_by=order_by, desc=desc, search_pattern=search_pattern, use_regex=use_regex)

Get all folders and files from specified folder

User with a Get Entity permission can access this method.

Example

• Basic Authentication (ApiKey):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    id = 'id_example' # str | folder id
skip = 0 # int | number of folder and files, that have to be skipped (optional) (default to 0)
take = 10 # int | number of folder and files, that have to be returned (optional) (default to 10)
order_by = fastreport_cloud_sdk.FileSorting() # FileSorting | indicates a field to sort by (optional)
desc = False # bool | indicates if sorting is descending (optional) (default to False)
search_pattern = '' # str |  (optional) (default to '')
use_regex = False # bool |  (optional) (default to False)

    try:
        # Get all folders and files from specified folder
        api_response = api_instance.export_folder_and_file_get_folders_and_files(id, skip=skip, take=take, order_by=order_by, desc=desc, search_pattern=search_pattern, use_regex=use_regex)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ExportsApi->export_folder_and_file_get_folders_and_files: %s\n" % e)

• Bearer (JWT) Authentication (JWT):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    id = 'id_example' # str | folder id
skip = 0 # int | number of folder and files, that have to be skipped (optional) (default to 0)
take = 10 # int | number of folder and files, that have to be returned (optional) (default to 10)
order_by = fastreport_cloud_sdk.FileSorting() # FileSorting | indicates a field to sort by (optional)
desc = False # bool | indicates if sorting is descending (optional) (default to False)
search_pattern = '' # str |  (optional) (default to '')
use_regex = False # bool |  (optional) (default to False)

    try:
        # Get all folders and files from specified folder
        api_response = api_instance.export_folder_and_file_get_folders_and_files(id, skip=skip, take=take, order_by=order_by, desc=desc, search_pattern=search_pattern, use_regex=use_regex)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ExportsApi->export_folder_and_file_get_folders_and_files: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	folder id
skip	int	number of folder and files, that have to be skipped	[optional] [default to 0]
take	int	number of folder and files, that have to be returned	[optional] [default to 10]
order_by	FileSorting	indicates a field to sort by	[optional]
desc	bool	indicates if sorting is descending	[optional] [default to False]
search_pattern	str		[optional] [default to '']
use_regex	bool		[optional] [default to False]

Return type

FilesVM

Authorization

ApiKey, JWT

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Returns list of the files from a specified folder	-
400	FolderId is null	-
403	You don't have rights for the operation	-
404	File or folder not found	-

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

export_folder_and_file_get_recycle_bin_folders_and_files

FilesVM export_folder_and_file_get_recycle_bin_folders_and_files(subscription_id, skip=skip, take=take, order_by=order_by, desc=desc, search_pattern=search_pattern, use_regex=use_regex)

Get all folders and files from recycle bin

User with a Get DeletedFiles permission can access this method.

Example

• Basic Authentication (ApiKey):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    subscription_id = 'subscription_id_example' # str | subscription id
skip = 0 # int | number of folder and files, that have to be skipped (optional) (default to 0)
take = 10 # int | number of folder and files, that have to be returned (optional) (default to 10)
order_by = fastreport_cloud_sdk.FileSorting() # FileSorting | indicates a field to sort by (optional)
desc = False # bool | indicates if sorting is descending (optional) (default to False)
search_pattern = '' # str |  (optional) (default to '')
use_regex = False # bool |  (optional) (default to False)

    try:
        # Get all folders and files from recycle bin
        api_response = api_instance.export_folder_and_file_get_recycle_bin_folders_and_files(subscription_id, skip=skip, take=take, order_by=order_by, desc=desc, search_pattern=search_pattern, use_regex=use_regex)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ExportsApi->export_folder_and_file_get_recycle_bin_folders_and_files: %s\n" % e)

• Bearer (JWT) Authentication (JWT):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    subscription_id = 'subscription_id_example' # str | subscription id
skip = 0 # int | number of folder and files, that have to be skipped (optional) (default to 0)
take = 10 # int | number of folder and files, that have to be returned (optional) (default to 10)
order_by = fastreport_cloud_sdk.FileSorting() # FileSorting | indicates a field to sort by (optional)
desc = False # bool | indicates if sorting is descending (optional) (default to False)
search_pattern = '' # str |  (optional) (default to '')
use_regex = False # bool |  (optional) (default to False)

    try:
        # Get all folders and files from recycle bin
        api_response = api_instance.export_folder_and_file_get_recycle_bin_folders_and_files(subscription_id, skip=skip, take=take, order_by=order_by, desc=desc, search_pattern=search_pattern, use_regex=use_regex)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ExportsApi->export_folder_and_file_get_recycle_bin_folders_and_files: %s\n" % e)

Parameters

Name	Type	Description	Notes
subscription_id	str	subscription id
skip	int	number of folder and files, that have to be skipped	[optional] [default to 0]
take	int	number of folder and files, that have to be returned	[optional] [default to 10]
order_by	FileSorting	indicates a field to sort by	[optional]
desc	bool	indicates if sorting is descending	[optional] [default to False]
search_pattern	str		[optional] [default to '']
use_regex	bool		[optional] [default to False]

Return type

FilesVM

Authorization

ApiKey, JWT

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Returns list of the files from a specified folder	-
400	FolderId is null	-
403	You don't have rights for the operation	-
404	File or folder not found	-

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

export_folder_and_file_move_files_to_bin

export_folder_and_file_move_files_to_bin(subscription_id, selected_files_vm=selected_files_vm)

Move folders and files to bin

User with a Delete permission can access this method.

Example

• Basic Authentication (ApiKey):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    subscription_id = 'subscription_id_example' # str | id of current subscription
selected_files_vm = fastreport_cloud_sdk.SelectedFilesVM() # SelectedFilesVM | VM with files' ids and params of their destination (optional)

    try:
        # Move folders and files to bin
        api_instance.export_folder_and_file_move_files_to_bin(subscription_id, selected_files_vm=selected_files_vm)
    except ApiException as e:
        print("Exception when calling ExportsApi->export_folder_and_file_move_files_to_bin: %s\n" % e)

• Bearer (JWT) Authentication (JWT):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    subscription_id = 'subscription_id_example' # str | id of current subscription
selected_files_vm = fastreport_cloud_sdk.SelectedFilesVM() # SelectedFilesVM | VM with files' ids and params of their destination (optional)

    try:
        # Move folders and files to bin
        api_instance.export_folder_and_file_move_files_to_bin(subscription_id, selected_files_vm=selected_files_vm)
    except ApiException as e:
        print("Exception when calling ExportsApi->export_folder_and_file_move_files_to_bin: %s\n" % e)

Parameters

Name	Type	Description	Notes
subscription_id	str	id of current subscription
selected_files_vm	SelectedFilesVM	VM with files' ids and params of their destination	[optional]

Return type

void (empty response body)

Authorization

ApiKey, JWT

HTTP request headers

• Content-Type: application/json, text/json, application/*+json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
204	All folders and files have been moved to bin	-
400	FolderId is null	-
403	You don't have rights for the operation	-
404	File or folder not found	-

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

export_folder_and_file_recover_all_from_recycle_bin

export_folder_and_file_recover_all_from_recycle_bin(subscription_id)

Recover all folders and files from recycle bin

User with a Create RecycleBin permission can access this method.

Example

• Basic Authentication (ApiKey):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    subscription_id = 'subscription_id_example' # str | subscription id

    try:
        # Recover all folders and files from recycle bin
        api_instance.export_folder_and_file_recover_all_from_recycle_bin(subscription_id)
    except ApiException as e:
        print("Exception when calling ExportsApi->export_folder_and_file_recover_all_from_recycle_bin: %s\n" % e)

• Bearer (JWT) Authentication (JWT):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    subscription_id = 'subscription_id_example' # str | subscription id

    try:
        # Recover all folders and files from recycle bin
        api_instance.export_folder_and_file_recover_all_from_recycle_bin(subscription_id)
    except ApiException as e:
        print("Exception when calling ExportsApi->export_folder_and_file_recover_all_from_recycle_bin: %s\n" % e)

Parameters

Name	Type	Description	Notes
subscription_id	str	subscription id

Return type

void (empty response body)

Authorization

ApiKey, JWT

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
204	All folders and files in bin have been restored	-
400	FolderId is null	-
403	You don't have rights for the operation	-
404	File or folder not found	-

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

export_folder_and_file_recover_files

export_folder_and_file_recover_files(subscription_id, selected_files_vm=selected_files_vm)

Recover folders and files from bin

User with a SubscriptionCreate permission can access this method.

Example

• Basic Authentication (ApiKey):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    subscription_id = 'subscription_id_example' # str | id of current subscription
selected_files_vm = fastreport_cloud_sdk.SelectedFilesVM() # SelectedFilesVM | VM with files' ids and params of their destination (optional)

    try:
        # Recover folders and files from bin
        api_instance.export_folder_and_file_recover_files(subscription_id, selected_files_vm=selected_files_vm)
    except ApiException as e:
        print("Exception when calling ExportsApi->export_folder_and_file_recover_files: %s\n" % e)

• Bearer (JWT) Authentication (JWT):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    subscription_id = 'subscription_id_example' # str | id of current subscription
selected_files_vm = fastreport_cloud_sdk.SelectedFilesVM() # SelectedFilesVM | VM with files' ids and params of their destination (optional)

    try:
        # Recover folders and files from bin
        api_instance.export_folder_and_file_recover_files(subscription_id, selected_files_vm=selected_files_vm)
    except ApiException as e:
        print("Exception when calling ExportsApi->export_folder_and_file_recover_files: %s\n" % e)

Parameters

Name	Type	Description	Notes
subscription_id	str	id of current subscription
selected_files_vm	SelectedFilesVM	VM with files' ids and params of their destination	[optional]

Return type

void (empty response body)

Authorization

ApiKey, JWT

HTTP request headers

• Content-Type: application/json, text/json, application/*+json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
204	All folders and files have been recovered	-
400	FolderId is null	-
403	You don't have rights for the operation	-
404	File or folder not found	-

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

export_folders_calculate_folder_size

FolderSizeVM export_folders_calculate_folder_size(id)

Get specified folder, calculate it's size

User with a Get Entity permission can access this method.

Example

• Basic Authentication (ApiKey):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    id = 'id_example' # str | folder id

    try:
        # Get specified folder, calculate it's size
        api_response = api_instance.export_folders_calculate_folder_size(id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ExportsApi->export_folders_calculate_folder_size: %s\n" % e)

• Bearer (JWT) Authentication (JWT):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    id = 'id_example' # str | folder id

    try:
        # Get specified folder, calculate it's size
        api_response = api_instance.export_folders_calculate_folder_size(id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ExportsApi->export_folders_calculate_folder_size: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	folder id

Return type

FolderSizeVM

Authorization

ApiKey, JWT

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Returns specified folder	-
400	Id is null	-
403	You don't have rights for the operation	-
404	Folder not found	-

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

export_folders_copy_folder

FileVM export_folders_copy_folder(id, folder_id)

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

• Basic Authentication (ApiKey):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    id = 'id_example' # str | moving folder id
folder_id = 'folder_id_example' # str | destination folder id

    try:
        # Move folder to a specified folder
        api_response = api_instance.export_folders_copy_folder(id, folder_id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ExportsApi->export_folders_copy_folder: %s\n" % e)

• Bearer (JWT) Authentication (JWT):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    id = 'id_example' # str | moving folder id
folder_id = 'folder_id_example' # str | destination folder id

    try:
        # Move folder to a specified folder
        api_response = api_instance.export_folders_copy_folder(id, folder_id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ExportsApi->export_folders_copy_folder: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	moving folder id
folder_id	str	destination folder id

Return type

FileVM

Authorization

ApiKey, JWT

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Folder has been moved to a specified folder	-
400	folderId or parentFolderId is null	-
403	You don't have rights for the operation	-
402	Subscription is outdated	-
404	Folder not found	-

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

export_folders_delete_folder

export_folders_delete_folder(id)

Delete specified folder

User with a Delete Entity permission can access this method.

Example

• Basic Authentication (ApiKey):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    id = 'id_example' # str | folder id

    try:
        # Delete specified folder
        api_instance.export_folders_delete_folder(id)
    except ApiException as e:
        print("Exception when calling ExportsApi->export_folders_delete_folder: %s\n" % e)

• Bearer (JWT) Authentication (JWT):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    id = 'id_example' # str | folder id

    try:
        # Delete specified folder
        api_instance.export_folders_delete_folder(id)
    except ApiException as e:
        print("Exception when calling ExportsApi->export_folders_delete_folder: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	folder id

Return type

void (empty response body)

Authorization

ApiKey, JWT

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
204	Folder succesfully deleted	-
400	Id is null	-
403	You don't have rights for the operation	-
402	Subscription is outdated	-
404	Folder not found	-

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

export_folders_get_breadcrumbs

BreadcrumbsVM export_folders_get_breadcrumbs(id)

Get specified folder breadcrumbs

User with a Get Entity permission can access this method.

Example

• Basic Authentication (ApiKey):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    id = 'id_example' # str | folder id

    try:
        # Get specified folder breadcrumbs
        api_response = api_instance.export_folders_get_breadcrumbs(id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ExportsApi->export_folders_get_breadcrumbs: %s\n" % e)

• Bearer (JWT) Authentication (JWT):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    id = 'id_example' # str | folder id

    try:
        # Get specified folder breadcrumbs
        api_response = api_instance.export_folders_get_breadcrumbs(id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ExportsApi->export_folders_get_breadcrumbs: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	folder id

Return type

BreadcrumbsVM

Authorization

ApiKey, JWT

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Returns breadcrumbs parents list (starts from root folder)	-
400	folderId is null	-
403	You don't have rights for the operation	-
404	Folder not found	-

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

export_folders_get_folder

FileVM export_folders_get_folder(id)

Get specified folder

User with a Get Entity permission can access this method.

Example

• Basic Authentication (ApiKey):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    id = 'id_example' # str | folder id

    try:
        # Get specified folder
        api_response = api_instance.export_folders_get_folder(id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ExportsApi->export_folders_get_folder: %s\n" % e)

• Bearer (JWT) Authentication (JWT):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    id = 'id_example' # str | folder id

    try:
        # Get specified folder
        api_response = api_instance.export_folders_get_folder(id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ExportsApi->export_folders_get_folder: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	folder id

Return type

FileVM

Authorization

ApiKey, JWT

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Returns specified folder	-
400	Id is null	-
403	You don't have rights for the operation	-
404	Folder not found	-

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

export_folders_get_folders

FilesVM export_folders_get_folders(id, skip=skip, take=take, order_by=order_by, desc=desc, search_pattern=search_pattern, use_regex=use_regex)

Get all folders from specified folder

User with a Get Entity permission can access this method.

Example

• Basic Authentication (ApiKey):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    id = 'id_example' # str | folder id
skip = 0 # int | number of files, that have to be skipped (optional) (default to 0)
take = 10 # int | number of files, that have to be returned (optional) (default to 10)
order_by = fastreport_cloud_sdk.FileSorting() # FileSorting |  (optional)
desc = False # bool |  (optional) (default to False)
search_pattern = '' # str |  (optional) (default to '')
use_regex = False # bool |  (optional) (default to False)

    try:
        # Get all folders from specified folder
        api_response = api_instance.export_folders_get_folders(id, skip=skip, take=take, order_by=order_by, desc=desc, search_pattern=search_pattern, use_regex=use_regex)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ExportsApi->export_folders_get_folders: %s\n" % e)

• Bearer (JWT) Authentication (JWT):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    id = 'id_example' # str | folder id
skip = 0 # int | number of files, that have to be skipped (optional) (default to 0)
take = 10 # int | number of files, that have to be returned (optional) (default to 10)
order_by = fastreport_cloud_sdk.FileSorting() # FileSorting |  (optional)
desc = False # bool |  (optional) (default to False)
search_pattern = '' # str |  (optional) (default to '')
use_regex = False # bool |  (optional) (default to False)

    try:
        # Get all folders from specified folder
        api_response = api_instance.export_folders_get_folders(id, skip=skip, take=take, order_by=order_by, desc=desc, search_pattern=search_pattern, use_regex=use_regex)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ExportsApi->export_folders_get_folders: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	folder id
skip	int	number of files, that have to be skipped	[optional] [default to 0]
take	int	number of files, that have to be returned	[optional] [default to 10]
order_by	FileSorting		[optional]
desc	bool		[optional] [default to False]
search_pattern	str		[optional] [default to '']
use_regex	bool		[optional] [default to False]

Return type

FilesVM

Authorization

ApiKey, JWT

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Gets all folders from a specified folder	-
400	folderId is null	-
403	You don't have rights for the operation	-
404	Folder not found	-

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

export_folders_get_folders_count

CountVM export_folders_get_folders_count(id)

Get count of folders what contains in a specified folder

User with a Get Count permission can access this method.

Example

• Basic Authentication (ApiKey):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    id = 'id_example' # str | folder id

    try:
        # Get count of folders what contains in a specified folder
        api_response = api_instance.export_folders_get_folders_count(id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ExportsApi->export_folders_get_folders_count: %s\n" % e)

• Bearer (JWT) Authentication (JWT):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    id = 'id_example' # str | folder id

    try:
        # Get count of folders what contains in a specified folder
        api_response = api_instance.export_folders_get_folders_count(id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ExportsApi->export_folders_get_folders_count: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	folder id

Return type

CountVM

Authorization

ApiKey, JWT

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Returns count of folders in a specified folder	-
400	folderId is null	-
403	You don't have rights for the operation	-
404	Folder not found	-

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

export_folders_get_or_create

FileVM export_folders_get_or_create(name=name, subscription_id=subscription_id, parent_id=parent_id)

Get specified folder

User with a Get Entity permission can access this method.

Example

• Basic Authentication (ApiKey):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    name = 'name_example' # str | folder name (optional)
subscription_id = 'subscription_id_example' # str | subscriptionId (optional)
parent_id = 'parent_id_example' # str | parent folder id (optional)

    try:
        # Get specified folder
        api_response = api_instance.export_folders_get_or_create(name=name, subscription_id=subscription_id, parent_id=parent_id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ExportsApi->export_folders_get_or_create: %s\n" % e)

• Bearer (JWT) Authentication (JWT):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    name = 'name_example' # str | folder name (optional)
subscription_id = 'subscription_id_example' # str | subscriptionId (optional)
parent_id = 'parent_id_example' # str | parent folder id (optional)

    try:
        # Get specified folder
        api_response = api_instance.export_folders_get_or_create(name=name, subscription_id=subscription_id, parent_id=parent_id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ExportsApi->export_folders_get_or_create: %s\n" % e)

Parameters

Name	Type	Description	Notes
name	str	folder name	[optional]
subscription_id	str	subscriptionId	[optional]
parent_id	str	parent folder id	[optional]

Return type

FileVM

Authorization

ApiKey, JWT

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Returns specified folder	-
400	Id is null	-
403	You don't have rights for the operation	-
404	Folder not found	-

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

export_folders_get_permissions

FilePermissionsVM export_folders_get_permissions(id)

Get all folder permissions

Example

• Basic Authentication (ApiKey):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    id = 'id_example' # str | 

    try:
        # Get all folder permissions
        api_response = api_instance.export_folders_get_permissions(id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ExportsApi->export_folders_get_permissions: %s\n" % e)

• Bearer (JWT) Authentication (JWT):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    id = 'id_example' # str | 

    try:
        # Get all folder permissions
        api_response = api_instance.export_folders_get_permissions(id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ExportsApi->export_folders_get_permissions: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str

Return type

FilePermissionsVM

Authorization

ApiKey, JWT

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	returned permissions	-
400	id is not valid	-
403	You don't have rights for the operation	-
404	folder is not found	-

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

export_folders_get_root_folder

FileVM export_folders_get_root_folder(subscription_id=subscription_id)

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

• Basic Authentication (ApiKey):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    subscription_id = 'subscription_id_example' # str |  (optional)

    try:
        # Get user's root folder (without parents)
        api_response = api_instance.export_folders_get_root_folder(subscription_id=subscription_id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ExportsApi->export_folders_get_root_folder: %s\n" % e)

• Bearer (JWT) Authentication (JWT):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    subscription_id = 'subscription_id_example' # str |  (optional)

    try:
        # Get user's root folder (without parents)
        api_response = api_instance.export_folders_get_root_folder(subscription_id=subscription_id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ExportsApi->export_folders_get_root_folder: %s\n" % e)

Parameters

Name	Type	Description	Notes
subscription_id	str		[optional]

Return type

FileVM

Authorization

ApiKey, JWT

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Gets user's root folder (without parents)	-
400	Error with the request.	-
404	Not found subscription	-
403	No permissions to get root folder	-

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

export_folders_move_folder

FileVM export_folders_move_folder(id, folder_id)

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

• Basic Authentication (ApiKey):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    id = 'id_example' # str | moving folder id
folder_id = 'folder_id_example' # str | destination folder id

    try:
        # Move folder to a specified folder
        api_response = api_instance.export_folders_move_folder(id, folder_id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ExportsApi->export_folders_move_folder: %s\n" % e)

• Bearer (JWT) Authentication (JWT):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    id = 'id_example' # str | moving folder id
folder_id = 'folder_id_example' # str | destination folder id

    try:
        # Move folder to a specified folder
        api_response = api_instance.export_folders_move_folder(id, folder_id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ExportsApi->export_folders_move_folder: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	moving folder id
folder_id	str	destination folder id

Return type

FileVM

Authorization

ApiKey, JWT

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Folder has been moved to a specified folder	-
400	folderId or parentFolderId is null	-
403	You don't have rights for the operation	-
402	Subscription is outdated	-
404	Folder not found	-

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

export_folders_move_folder_to_bin

export_folders_move_folder_to_bin(id)

Move specified folder to recycle bin

User with a Delete Entity permission can access this method.

Example

• Basic Authentication (ApiKey):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    id = 'id_example' # str | folder id

    try:
        # Move specified folder to recycle bin
        api_instance.export_folders_move_folder_to_bin(id)
    except ApiException as e:
        print("Exception when calling ExportsApi->export_folders_move_folder_to_bin: %s\n" % e)

• Bearer (JWT) Authentication (JWT):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    id = 'id_example' # str | folder id

    try:
        # Move specified folder to recycle bin
        api_instance.export_folders_move_folder_to_bin(id)
    except ApiException as e:
        print("Exception when calling ExportsApi->export_folders_move_folder_to_bin: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	folder id

Return type

void (empty response body)

Authorization

ApiKey, JWT

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
204	Folder succesfully deleted	-
400	Id is null	-
403	You don't have rights for the operation	-
402	Subscription is outdated	-
404	Folder not found	-

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

export_folders_post_folder

FileVM export_folders_post_folder(id, export_folder_create_vm=export_folder_create_vm)

Create folder

User with a Create Entity permisison can access this method.

Example

• Basic Authentication (ApiKey):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    id = 'id_example' # str | Identifier of parent folder id
export_folder_create_vm = fastreport_cloud_sdk.ExportFolderCreateVM() # ExportFolderCreateVM | create VM (optional)

    try:
        # Create folder
        api_response = api_instance.export_folders_post_folder(id, export_folder_create_vm=export_folder_create_vm)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ExportsApi->export_folders_post_folder: %s\n" % e)

• Bearer (JWT) Authentication (JWT):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    id = 'id_example' # str | Identifier of parent folder id
export_folder_create_vm = fastreport_cloud_sdk.ExportFolderCreateVM() # ExportFolderCreateVM | create VM (optional)

    try:
        # Create folder
        api_response = api_instance.export_folders_post_folder(id, export_folder_create_vm=export_folder_create_vm)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ExportsApi->export_folders_post_folder: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	Identifier of parent folder id
export_folder_create_vm	ExportFolderCreateVM	create VM	[optional]

Return type

FileVM

Authorization

ApiKey, JWT

HTTP request headers

• Content-Type: application/json, text/json, application/*+json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	New folder has been created)	-
400	Parent folder id is null	-
403	You don't have rights for the operation	-
402	subscription is outdated	-
404	parent folder/subscription not found	-

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

export_folders_recover_folder

export_folders_recover_folder(id, recovery_path=recovery_path)

Recover specified folder

User with a Delete Entity permission can access this method.

Example

• Basic Authentication (ApiKey):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    id = 'id_example' # str | folder id
recovery_path = 'recovery_path_example' # str |  (optional)

    try:
        # Recover specified folder
        api_instance.export_folders_recover_folder(id, recovery_path=recovery_path)
    except ApiException as e:
        print("Exception when calling ExportsApi->export_folders_recover_folder: %s\n" % e)

• Bearer (JWT) Authentication (JWT):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    id = 'id_example' # str | folder id
recovery_path = 'recovery_path_example' # str |  (optional)

    try:
        # Recover specified folder
        api_instance.export_folders_recover_folder(id, recovery_path=recovery_path)
    except ApiException as e:
        print("Exception when calling ExportsApi->export_folders_recover_folder: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	folder id
recovery_path	str		[optional]

Return type

void (empty response body)

Authorization

ApiKey, JWT

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
204	Folder succesfully restored from bin	-
400	Id is null	-
403	You don't have rights for the operation	-
402	Subscription is outdated	-
404	Folder not found	-

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

export_folders_rename_folder

FileVM export_folders_rename_folder(id, folder_rename_vm=folder_rename_vm)

Rename a folder

User with a Update Name permision can access this method.

Example

• Basic Authentication (ApiKey):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    id = 'id_example' # str | 
folder_rename_vm = fastreport_cloud_sdk.FolderRenameVM() # FolderRenameVM |  (optional)

    try:
        # Rename a folder
        api_response = api_instance.export_folders_rename_folder(id, folder_rename_vm=folder_rename_vm)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ExportsApi->export_folders_rename_folder: %s\n" % e)

• Bearer (JWT) Authentication (JWT):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    id = 'id_example' # str | 
folder_rename_vm = fastreport_cloud_sdk.FolderRenameVM() # FolderRenameVM |  (optional)

    try:
        # Rename a folder
        api_response = api_instance.export_folders_rename_folder(id, folder_rename_vm=folder_rename_vm)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ExportsApi->export_folders_rename_folder: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
folder_rename_vm	FolderRenameVM		[optional]

Return type

FileVM

Authorization

ApiKey, JWT

HTTP request headers

• Content-Type: application/json, text/json, application/*+json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Folder name has been updated	-
400	folderId is null	-
403	You don't have rights for the operation	-
402	subscription is outdated	-
404	Folder not found	-

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

export_folders_update_icon

FileVM export_folders_update_icon(id, folder_icon_vm=folder_icon_vm)

Update a folder's icon

User with a Update Icon permission can access this method.

Example

• Basic Authentication (ApiKey):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    id = 'id_example' # str | Identifier of folder
folder_icon_vm = fastreport_cloud_sdk.FolderIconVM() # FolderIconVM | Update icon model (optional)

    try:
        # Update a folder's icon
        api_response = api_instance.export_folders_update_icon(id, folder_icon_vm=folder_icon_vm)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ExportsApi->export_folders_update_icon: %s\n" % e)

• Bearer (JWT) Authentication (JWT):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    id = 'id_example' # str | Identifier of folder
folder_icon_vm = fastreport_cloud_sdk.FolderIconVM() # FolderIconVM | Update icon model (optional)

    try:
        # Update a folder's icon
        api_response = api_instance.export_folders_update_icon(id, folder_icon_vm=folder_icon_vm)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ExportsApi->export_folders_update_icon: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	Identifier of folder
folder_icon_vm	FolderIconVM	Update icon model	[optional]

Return type

FileVM

Authorization

ApiKey, JWT

HTTP request headers

• Content-Type: application/json, text/json, application/*+json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Folder's icon has been updated	-
400	folderId is null	-
403	You don't have rights for the operation	-
402	subscription is outdated	-
404	Folder not found	-

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

export_folders_update_permissions

export_folders_update_permissions(id, update_file_permissions_vm=update_file_permissions_vm)

Update permissions

Example

• Basic Authentication (ApiKey):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    id = 'id_example' # str | 
update_file_permissions_vm = fastreport_cloud_sdk.UpdateFilePermissionsVM() # UpdateFilePermissionsVM |  (optional)

    try:
        # Update permissions
        api_instance.export_folders_update_permissions(id, update_file_permissions_vm=update_file_permissions_vm)
    except ApiException as e:
        print("Exception when calling ExportsApi->export_folders_update_permissions: %s\n" % e)

• Bearer (JWT) Authentication (JWT):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    id = 'id_example' # str | 
update_file_permissions_vm = fastreport_cloud_sdk.UpdateFilePermissionsVM() # UpdateFilePermissionsVM |  (optional)

    try:
        # Update permissions
        api_instance.export_folders_update_permissions(id, update_file_permissions_vm=update_file_permissions_vm)
    except ApiException as e:
        print("Exception when calling ExportsApi->export_folders_update_permissions: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
update_file_permissions_vm	UpdateFilePermissionsVM		[optional]

Return type

void (empty response body)

Authorization

ApiKey, JWT

HTTP request headers

• Content-Type: application/json, text/json, application/*+json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
204	No Content	-
400	Bad Request	-
402	Client Error	-
403	Forbidden	-
404	Not Found	-
500	Server Error	-

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

export_folders_update_tags

FileVM export_folders_update_tags(id, folder_tags_update_vm=folder_tags_update_vm)

Update tags

User with a Update Tags permission can access this method.

Example

• Basic Authentication (ApiKey):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    id = 'id_example' # str | 
folder_tags_update_vm = fastreport_cloud_sdk.FolderTagsUpdateVM() # FolderTagsUpdateVM |  (optional)

    try:
        # Update tags
        api_response = api_instance.export_folders_update_tags(id, folder_tags_update_vm=folder_tags_update_vm)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ExportsApi->export_folders_update_tags: %s\n" % e)

• Bearer (JWT) Authentication (JWT):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    id = 'id_example' # str | 
folder_tags_update_vm = fastreport_cloud_sdk.FolderTagsUpdateVM() # FolderTagsUpdateVM |  (optional)

    try:
        # Update tags
        api_response = api_instance.export_folders_update_tags(id, folder_tags_update_vm=folder_tags_update_vm)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ExportsApi->export_folders_update_tags: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
folder_tags_update_vm	FolderTagsUpdateVM		[optional]

Return type

FileVM

Authorization

ApiKey, JWT

HTTP request headers

• Content-Type: application/json, text/json, application/*+json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Tags has been updated	-
400	folderId or Tags is null	-
403	You don't have rights for the operation	-
402	subscription is outdated	-
404	Folder not found	-

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

exports_copy_file

ExportVM exports_copy_file(id, folder_id)

Copy file to a specified folder

Example

• Basic Authentication (ApiKey):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    id = 'id_example' # str | file id
folder_id = 'folder_id_example' # str | folder id

    try:
        # Copy file to a specified folder
        api_response = api_instance.exports_copy_file(id, folder_id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ExportsApi->exports_copy_file: %s\n" % e)

• Bearer (JWT) Authentication (JWT):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    id = 'id_example' # str | file id
folder_id = 'folder_id_example' # str | folder id

    try:
        # Copy file to a specified folder
        api_response = api_instance.exports_copy_file(id, folder_id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ExportsApi->exports_copy_file: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	file id
folder_id	str	folder id

Return type

ExportVM

Authorization

ApiKey, JWT

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	File has been copied	-
400	fileId or folderId is null	-
403	You don't have rights for the operation	-
402	Subscription is outdated	-
404	File or folder not found	-
500	Exception thrown	-

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

exports_delete_file

exports_delete_file(id)

Delete specified file

User with Delete permission can access the method.

Example

• Basic Authentication (ApiKey):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    id = 'id_example' # str | file id

    try:
        # Delete specified file
        api_instance.exports_delete_file(id)
    except ApiException as e:
        print("Exception when calling ExportsApi->exports_delete_file: %s\n" % e)

• Bearer (JWT) Authentication (JWT):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    id = 'id_example' # str | file id

    try:
        # Delete specified file
        api_instance.exports_delete_file(id)
    except ApiException as e:
        print("Exception when calling ExportsApi->exports_delete_file: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	file id

Return type

void (empty response body)

Authorization

ApiKey, JWT

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
204	File succesfully deleted	-
400	Id is null	-
403	You don't have rights for the operation	-
402	Subscription is outdated	-
404	File not found	-
500	Exception thrown	-

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

exports_get_file

ExportVM exports_get_file(id)

Example

• Basic Authentication (ApiKey):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    id = 'id_example' # str | 

    try:
        api_response = api_instance.exports_get_file(id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ExportsApi->exports_get_file: %s\n" % e)

• Bearer (JWT) Authentication (JWT):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    id = 'id_example' # str | 

    try:
        api_response = api_instance.exports_get_file(id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ExportsApi->exports_get_file: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str

Return type

ExportVM

Authorization

ApiKey, JWT

HTTP request headers

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

HTTP response details

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

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

exports_get_file_history

AuditActionsVM exports_get_file_history(id, skip=skip, take=take)

Returns list of actions, performed on this file

Example

• Basic Authentication (ApiKey):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    id = 'id_example' # str | 
skip = 0 # int |  (optional) (default to 0)
take = 10 # int |  (optional) (default to 10)

    try:
        # Returns list of actions, performed on this file
        api_response = api_instance.exports_get_file_history(id, skip=skip, take=take)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ExportsApi->exports_get_file_history: %s\n" % e)

• Bearer (JWT) Authentication (JWT):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    id = 'id_example' # str | 
skip = 0 # int |  (optional) (default to 0)
take = 10 # int |  (optional) (default to 10)

    try:
        # Returns list of actions, performed on this file
        api_response = api_instance.exports_get_file_history(id, skip=skip, take=take)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ExportsApi->exports_get_file_history: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
skip	int		[optional] [default to 0]
take	int		[optional] [default to 10]

Return type

AuditActionsVM

Authorization

ApiKey, JWT

HTTP request headers

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

HTTP response details

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

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

exports_get_files_count

CountVM exports_get_files_count(id)

Get count of files what contains in a specified folder

User with Get Count permission can access this method.

Example

• Basic Authentication (ApiKey):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    id = 'id_example' # str | folder id

    try:
        # Get count of files what contains in a specified folder
        api_response = api_instance.exports_get_files_count(id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ExportsApi->exports_get_files_count: %s\n" % e)

• Bearer (JWT) Authentication (JWT):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    id = 'id_example' # str | folder id

    try:
        # Get count of files what contains in a specified folder
        api_response = api_instance.exports_get_files_count(id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ExportsApi->exports_get_files_count: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	folder id

Return type

CountVM

Authorization

ApiKey, JWT

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Returns count of the files in a specified folder	-
400	FolderId is null	-
403	You don't have rights for the operation	-
404	Folder not found	-
500	Exception thrown	-

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

exports_get_files_list

ExportsVM exports_get_files_list(id, skip=skip, take=take, search_pattern=search_pattern, order_by=order_by, desc=desc, use_regex=use_regex)

Get all files from specified folder.
User with Get Entity permission can access this method.
The method will returns minimal infomration about the file:
id, name, size, editedTime, createdTime, tags, status, statusReason.

Example

• Basic Authentication (ApiKey):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    id = 'id_example' # str | folder id
skip = 0 # int | number of files, that have to be skipped (optional) (default to 0)
take = 10 # int | number of files, that have to be returned (optional) (default to 10)
search_pattern = 'search_pattern_example' # str |  (optional)
order_by = fastreport_cloud_sdk.FileSorting() # FileSorting |  (optional)
desc = False # bool |  (optional) (default to False)
use_regex = False # bool |  (optional) (default to False)

    try:
        # 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.
        api_response = api_instance.exports_get_files_list(id, skip=skip, take=take, search_pattern=search_pattern, order_by=order_by, desc=desc, use_regex=use_regex)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ExportsApi->exports_get_files_list: %s\n" % e)

• Bearer (JWT) Authentication (JWT):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    id = 'id_example' # str | folder id
skip = 0 # int | number of files, that have to be skipped (optional) (default to 0)
take = 10 # int | number of files, that have to be returned (optional) (default to 10)
search_pattern = 'search_pattern_example' # str |  (optional)
order_by = fastreport_cloud_sdk.FileSorting() # FileSorting |  (optional)
desc = False # bool |  (optional) (default to False)
use_regex = False # bool |  (optional) (default to False)

    try:
        # 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.
        api_response = api_instance.exports_get_files_list(id, skip=skip, take=take, search_pattern=search_pattern, order_by=order_by, desc=desc, use_regex=use_regex)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ExportsApi->exports_get_files_list: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	folder id
skip	int	number of files, that have to be skipped	[optional] [default to 0]
take	int	number of files, that have to be returned	[optional] [default to 10]
search_pattern	str		[optional]
order_by	FileSorting		[optional]
desc	bool		[optional] [default to False]
use_regex	bool		[optional] [default to False]

Return type

ExportsVM

Authorization

ApiKey, JWT

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Returns list of the files from a specified folder	-
400	FolderId is null	-
403	You don't have rights for the operation	-
404	File or folder not found	-
500	Exception thrown	-

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

exports_get_permissions

FilePermissionsVM exports_get_permissions(id)

Get all file permissions

Example

• Basic Authentication (ApiKey):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    id = 'id_example' # str | 

    try:
        # Get all file permissions
        api_response = api_instance.exports_get_permissions(id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ExportsApi->exports_get_permissions: %s\n" % e)

• Bearer (JWT) Authentication (JWT):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    id = 'id_example' # str | 

    try:
        # Get all file permissions
        api_response = api_instance.exports_get_permissions(id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ExportsApi->exports_get_permissions: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str

Return type

FilePermissionsVM

Authorization

ApiKey, JWT

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	got permissions successfully	-
400	id is not valid	-
403	You don't have rights for the operation	-
404	file is not found	-

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

exports_move_file

ExportVM exports_move_file(id, folder_id)

Move file to a specified folder

User with Update Place permission can access this method.

Example

• Basic Authentication (ApiKey):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    id = 'id_example' # str | file id
folder_id = 'folder_id_example' # str | folder id

    try:
        # Move file to a specified folder
        api_response = api_instance.exports_move_file(id, folder_id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ExportsApi->exports_move_file: %s\n" % e)

• Bearer (JWT) Authentication (JWT):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    id = 'id_example' # str | file id
folder_id = 'folder_id_example' # str | folder id

    try:
        # Move file to a specified folder
        api_response = api_instance.exports_move_file(id, folder_id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ExportsApi->exports_move_file: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	file id
folder_id	str	folder id

Return type

ExportVM

Authorization

ApiKey, JWT

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	File has been moved	-
400	fileId or folderId is null	-
403	You don't have rights for the operation	-
402	Subscription is outdated	-
404	File or folder not found	-
500	Exception thrown	-

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

exports_move_file_to_bin

exports_move_file_to_bin(id)

Move specified file to recycle bin

User with Delete permission can access the method.

Example

• Basic Authentication (ApiKey):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    id = 'id_example' # str | file id

    try:
        # Move specified file to recycle bin
        api_instance.exports_move_file_to_bin(id)
    except ApiException as e:
        print("Exception when calling ExportsApi->exports_move_file_to_bin: %s\n" % e)

• Bearer (JWT) Authentication (JWT):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    id = 'id_example' # str | file id

    try:
        # Move specified file to recycle bin
        api_instance.exports_move_file_to_bin(id)
    except ApiException as e:
        print("Exception when calling ExportsApi->exports_move_file_to_bin: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	file id

Return type

void (empty response body)

Authorization

ApiKey, JWT

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
204	File succesfully deleted	-
400	Id is null	-
403	You don't have rights for the operation	-
402	Subscription is outdated	-
404	File not found	-
500	Exception thrown	-

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

exports_recover_file

exports_recover_file(id, recovery_path=recovery_path)

Recover specified file from bin

User with Delete permission can access the method.

Example

• Basic Authentication (ApiKey):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    id = 'id_example' # str | file id
recovery_path = 'recovery_path_example' # str |  (optional)

    try:
        # Recover specified file from bin
        api_instance.exports_recover_file(id, recovery_path=recovery_path)
    except ApiException as e:
        print("Exception when calling ExportsApi->exports_recover_file: %s\n" % e)

• Bearer (JWT) Authentication (JWT):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    id = 'id_example' # str | file id
recovery_path = 'recovery_path_example' # str |  (optional)

    try:
        # Recover specified file from bin
        api_instance.exports_recover_file(id, recovery_path=recovery_path)
    except ApiException as e:
        print("Exception when calling ExportsApi->exports_recover_file: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	file id
recovery_path	str		[optional]

Return type

void (empty response body)

Authorization

ApiKey, JWT

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
204	File succesfully recovered	-
400	Id is null	-
403	You don't have rights for the operation	-
402	Subscription is outdated	-
404	File not found	-
500	Exception thrown	-

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

exports_rename_file

ExportVM exports_rename_file(id, file_rename_vm=file_rename_vm)

Rename a file

User with Update Name permission can access this method.

Example

• Basic Authentication (ApiKey):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    id = 'id_example' # str | 
file_rename_vm = fastreport_cloud_sdk.FileRenameVM() # FileRenameVM |  (optional)

    try:
        # Rename a file
        api_response = api_instance.exports_rename_file(id, file_rename_vm=file_rename_vm)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ExportsApi->exports_rename_file: %s\n" % e)

• Bearer (JWT) Authentication (JWT):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    id = 'id_example' # str | 
file_rename_vm = fastreport_cloud_sdk.FileRenameVM() # FileRenameVM |  (optional)

    try:
        # Rename a file
        api_response = api_instance.exports_rename_file(id, file_rename_vm=file_rename_vm)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ExportsApi->exports_rename_file: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
file_rename_vm	FileRenameVM		[optional]

Return type

ExportVM

Authorization

ApiKey, JWT

HTTP request headers

• Content-Type: application/json, text/json, application/*+json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	File name has been updated	-
400	FileId is null	-
403	You don't have rights for the operation	-
402	Subscription is outdated	-
404	File not found	-
500	Exception thrown	-

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

exports_update_icon

ExportVM exports_update_icon(id, file_icon_vm=file_icon_vm)

Update a files's icon

User with Update Icon permission can access this method.

Example

• Basic Authentication (ApiKey):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    id = 'id_example' # str | 
file_icon_vm = fastreport_cloud_sdk.FileIconVM() # FileIconVM |  (optional)

    try:
        # Update a files's icon
        api_response = api_instance.exports_update_icon(id, file_icon_vm=file_icon_vm)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ExportsApi->exports_update_icon: %s\n" % e)

• Bearer (JWT) Authentication (JWT):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    id = 'id_example' # str | 
file_icon_vm = fastreport_cloud_sdk.FileIconVM() # FileIconVM |  (optional)

    try:
        # Update a files's icon
        api_response = api_instance.exports_update_icon(id, file_icon_vm=file_icon_vm)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ExportsApi->exports_update_icon: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
file_icon_vm	FileIconVM		[optional]

Return type

ExportVM

Authorization

ApiKey, JWT

HTTP request headers

• Content-Type: application/json, text/json, application/*+json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	File's icon has been updated	-
400	FileId is null	-
403	You don't have rights for the operation	-
402	Subscription is outdated	-
404	File not found	-
500	Exception thrown	-

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

exports_update_permissions

exports_update_permissions(id, update_file_permissions_vm=update_file_permissions_vm)

Update permissions

Example

• Basic Authentication (ApiKey):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    id = 'id_example' # str | 
update_file_permissions_vm = fastreport_cloud_sdk.UpdateFilePermissionsVM() # UpdateFilePermissionsVM |  (optional)

    try:
        # Update permissions
        api_instance.exports_update_permissions(id, update_file_permissions_vm=update_file_permissions_vm)
    except ApiException as e:
        print("Exception when calling ExportsApi->exports_update_permissions: %s\n" % e)

• Bearer (JWT) Authentication (JWT):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    id = 'id_example' # str | 
update_file_permissions_vm = fastreport_cloud_sdk.UpdateFilePermissionsVM() # UpdateFilePermissionsVM |  (optional)

    try:
        # Update permissions
        api_instance.exports_update_permissions(id, update_file_permissions_vm=update_file_permissions_vm)
    except ApiException as e:
        print("Exception when calling ExportsApi->exports_update_permissions: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
update_file_permissions_vm	UpdateFilePermissionsVM		[optional]

Return type

void (empty response body)

Authorization

ApiKey, JWT

HTTP request headers

• Content-Type: application/json, text/json, application/*+json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
204	No Content	-
400	Bad Request	-
402	Client Error	-
403	Forbidden	-
404	Not Found	-
500	Server Error	-

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

exports_update_tags

ExportVM exports_update_tags(id, file_tags_update_vm=file_tags_update_vm)

Update tags

User with Update Tags permission can access this method.

Example

• Basic Authentication (ApiKey):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    id = 'id_example' # str | 
file_tags_update_vm = fastreport_cloud_sdk.FileTagsUpdateVM() # FileTagsUpdateVM |  (optional)

    try:
        # Update tags
        api_response = api_instance.exports_update_tags(id, file_tags_update_vm=file_tags_update_vm)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ExportsApi->exports_update_tags: %s\n" % e)

• Bearer (JWT) Authentication (JWT):

from __future__ import print_function
import time
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 = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = 'YOUR_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.ExportsApi(api_client)
    id = 'id_example' # str | 
file_tags_update_vm = fastreport_cloud_sdk.FileTagsUpdateVM() # FileTagsUpdateVM |  (optional)

    try:
        # Update tags
        api_response = api_instance.exports_update_tags(id, file_tags_update_vm=file_tags_update_vm)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ExportsApi->exports_update_tags: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
file_tags_update_vm	FileTagsUpdateVM		[optional]

Return type

ExportVM

Authorization

ApiKey, JWT

HTTP request headers

• Content-Type: application/json, text/json, application/*+json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Tags has been updated	-
400	FileId is null	-
403	You don't have rights for the operation	-
402	Subscription is outdated	-
404	File not found	-
500	Exception thrown	-

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