Skip to content

Repository files navigation

fastreport-cloud-sdk

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: v1
  • Package version: 2025.2.21
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.7+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/fastreports/FastReport-Cloud-Python.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/fastreports/FastReport-Cloud-Python.git)

Then import the package:

importfastreport_cloud_sdk

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

importfastreport_cloud_sdk

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

importfastreport_cloud_sdkfromfastreport_cloud_sdk.restimportApiExceptionfrompprintimportpprint# 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: ApiKeyconfiguration=fastreport_cloud_sdk.Configuration(
username=os.environ["USERNAME"],
password=os.environ["PASSWORD"]
)
# Configure Bearer authorization (JWT): JWTconfiguration=fastreport_cloud_sdk.Configuration(
access_token=os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API clientwithfastreport_cloud_sdk.ApiClient(configuration) asapi_client:
# Create an instance of the API classapi_instance=fastreport_cloud_sdk.ApiKeysApi(api_client)
create_api_key_vm=fastreport_cloud_sdk.CreateApiKeyVM() # CreateApiKeyVM | try:
# Create a new apikey, 5 apikeys for user. Hardcoded for ddos.api_response=api_instance.api_keys_create_api_key(create_api_key_vm)
print("The response of ApiKeysApi->api_keys_create_api_key:\n")
pprint(api_response)
exceptApiExceptionase:
print("Exception when calling ApiKeysApi->api_keys_create_api_key: %s\n"%e)

Documentation for API Endpoints

All URIs are relative to http://localhost

ClassMethodHTTP requestDescription
ApiKeysApiapi_keys_create_api_keyPOST /api/manage/v1/ApiKeysCreate a new apikey, 5 apikeys for user. Hardcoded for ddos.
ApiKeysApiapi_keys_delete_api_keyDELETE /api/manage/v1/ApiKeysDelete an apikey
ApiKeysApiapi_keys_get_api_keysGET /api/manage/v1/ApiKeysReturns list with all apikeys of current user
ConfigurationApiconfiguration_getGET /api/v1/Configurationreturns information about server configuration
ContactGroupsApicontact_groups_createPOST /api/v1/ContactGroups/groupCreates contact group
ContactGroupsApicontact_groups_deleteDELETE /api/v1/ContactGroups/{id}Removes contact by id
ContactGroupsApicontact_groups_getGET /api/v1/ContactGroups/{id}Returns contact group by id
ContactGroupsApicontact_groups_get_listGET /api/v1/ContactGroups/subscription/{subscriptionId}/groupsReturns contact groups by subscriptionId
ContactGroupsApicontact_groups_updatePUT /api/v1/ContactGroups/{id}Updates contact group by id
ContactsApicontacts_createPOST /api/v1/Contacts/contactCreates new contact
ContactsApicontacts_deleteDELETE /api/v1/Contacts/{id}Removes contact by id
ContactsApicontacts_getGET /api/v1/Contacts/{id}Returns contact group by id
ContactsApicontacts_get_by_groupGET /api/v1/Contacts/group/{groupId}/contactsReturns contacts by group id
ContactsApicontacts_get_listGET /api/v1/Contacts/subscription/{subscriptionId}/contactsAllows to search for contacts
ContactsApicontacts_updatePUT /api/v1/Contacts/{id}Updates contact by id
DataSourcesApidata_sources_count_data_sources_asyncGET /api/data/v1/DataSources/{subscriptionId}/countReturns a number of data sources in subscription
DataSourcesApidata_sources_create_data_sourcePOST /api/data/v1/DataSourcesCreate new data source
DataSourcesApidata_sources_delete_data_sourceDELETE /api/data/v1/DataSources/{id}Delete data source by id
DataSourcesApidata_sources_fetch_dataGET /api/data/v1/DataSources/{id}/fetchThis should connect to a database and set data structure
DataSourcesApidata_sources_get_available_data_sourcesGET /api/data/v1/DataSourcesReturns all of the data sources, that current user have permission for in a subscription <br /> The method will return minimal infomration about the datasources: <br /> id, name, editedTime, status.
DataSourcesApidata_sources_get_data_sourceGET /api/data/v1/DataSources/{id}Get data source by id
DataSourcesApidata_sources_get_my_permissionsGET /api/data/v1/DataSources/{id}/mypermissionsGet current user's permissions to Data source
DataSourcesApidata_sources_get_parameter_typesGET /api/data/v1/DataSources/parameterTypes/{dataSourceType}Get data source parameter DataType's
DataSourcesApidata_sources_get_permissionsGET /api/data/v1/DataSources/{id}/permissionsGet all Data source permissions
DataSourcesApidata_sources_rename_data_sourcePUT /api/data/v1/DataSources/{id}/renameRename data source by id
DataSourcesApidata_sources_update_connection_stringPUT /api/data/v1/DataSources/{id}/connectionStringUpdate data source's connection string by id
DataSourcesApidata_sources_update_permissionsPOST /api/data/v1/DataSources/{id}/permissionsUpdate permissions
DataSourcesApidata_sources_update_select_commandsPUT /api/data/v1/DataSources/{id}/selectCommandsUpdate data source's select commands by id
DataSourcesApidata_sources_update_subscription_data_sourcePUT /api/data/v1/DataSources/{id}/updateSubscriptionUpdate data source's subscription
DownloadApidownload_get_exportGET /download/e/{id}Returns a export file with specified id
DownloadApidownload_get_export_thumbnailGET /download/e/{id}/thumbnailReturns export's thumbnail
DownloadApidownload_get_exportsGET /download/es/{archiveName}Returns a zip archive with selected ids
DownloadApidownload_get_last_svg_exportGET /download/lastPreview/{reportId}returns export, that was created from report with specified id. INTERNAL USAGE ONLY!
DownloadApidownload_get_reportGET /download/r/{id}Returns a prepared file with specified id
DownloadApidownload_get_report_thumbnailGET /download/r/{id}/thumbnailReturns report's thumbnail
DownloadApidownload_get_reportsGET /download/rs/{archiveName}Returns a zip archive with selected files
DownloadApidownload_get_templateGET /download/t/{id}Returns a Template file with specified id
DownloadApidownload_get_template_thumbnailGET /download/t/{id}/thumbnailReturns template's thumbnail
DownloadApidownload_get_templatesGET /download/ts/{archiveName}Returns a zip archive with selected files
ExportsApiexport_folder_and_file_clear_recycle_binDELETE /api/rp/v1/Exports/{subscriptionId}/ClearRecycleBinDelete all folders and files from recycle bin
ExportsApiexport_folder_and_file_copy_filesPOST /api/rp/v1/Exports/{subscriptionId}/CopyFilesCopy folders and files to a specified folder
ExportsApiexport_folder_and_file_count_recycle_bin_folders_and_filesGET /api/rp/v1/Exports/{subscriptionId}/CountRecycleBinFolderAndFilesCount all folders and files from recycle bin
ExportsApiexport_folder_and_file_delete_filesPOST /api/rp/v1/Exports/{subscriptionId}/DeleteFilesDelete folders and files from a folder or the recycle bin
ExportsApiexport_folder_and_file_get_countGET /api/rp/v1/Exports/Folder/{id}/CountFolderAndFilesCount folders and files in a folder
ExportsApiexport_folder_and_file_get_folders_and_filesGET /api/rp/v1/Exports/Folder/{id}/ListFolderAndFilesGet all folders and files from specified folder
ExportsApiexport_folder_and_file_get_recycle_bin_folders_and_filesGET /api/rp/v1/Exports/{subscriptionId}/ListRecycleBinFolderAndFilesGet all folders and files from recycle bin
ExportsApiexport_folder_and_file_move_filesPOST /api/rp/v1/Exports/{subscriptionId}/MoveFilesMove folders and files to a specified folder
ExportsApiexport_folder_and_file_move_files_to_binPOST /api/rp/v1/Exports/{subscriptionId}/ToBinMove folders and files to the recycle bin
ExportsApiexport_folder_and_file_recover_all_from_recycle_binPOST /api/rp/v1/Exports/{subscriptionId}/RecoverRecycleBinRecover all folders and files from recycle bin
ExportsApiexport_folder_and_file_recover_filesPOST /api/rp/v1/Exports/{subscriptionId}/RecoverFilesRecover folders and files from the recycle bin
ExportsApiexport_folders_calculate_folder_sizeGET /api/rp/v1/Exports/Folder/{id}/sizeGet specified folder, calculate it's size
ExportsApiexport_folders_copy_folderPOST /api/rp/v1/Exports/Folder/{id}/Copy/{folderId}Move folder to a specified folder
ExportsApiexport_folders_delete_folderDELETE /api/rp/v1/Exports/Folder/{id}Delete specified folder
ExportsApiexport_folders_get_breadcrumbsGET /api/rp/v1/Exports/Folder/{id}/BreadcrumbsGet specified folder breadcrumbs
ExportsApiexport_folders_get_folderGET /api/rp/v1/Exports/Folder/{id}Get specified folder
ExportsApiexport_folders_get_foldersGET /api/rp/v1/Exports/Folder/{id}/ListFoldersGet all folders from specified folder
ExportsApiexport_folders_get_folders_countGET /api/rp/v1/Exports/Folder/{id}/CountFoldersGet count of folders what contains in a specified folder
ExportsApiexport_folders_get_my_permissionsGET /api/rp/v1/Exports/Folder/{folderId}/mypermissionsGet user's permissions for a folder by id
ExportsApiexport_folders_get_or_createGET /api/rp/v1/Exports/Folder/getOrCreateGet specified folder
ExportsApiexport_folders_get_permissionsGET /api/rp/v1/Exports/Folder/{id}/permissionsGet all folder permissions
ExportsApiexport_folders_get_root_folderGET /api/rp/v1/Exports/RootGet workspace's root folder
ExportsApiexport_folders_move_folderPOST /api/rp/v1/Exports/Folder/{id}/Move/{folderId}Move folder into a specified folder
ExportsApiexport_folders_move_folder_to_binDELETE /api/rp/v1/Exports/Folder/{id}/ToBinMove specified folder to recycle bin
ExportsApiexport_folders_post_folderPOST /api/rp/v1/Exports/Folder/{id}/FolderCreate folder
ExportsApiexport_folders_recover_folderPOST /api/rp/v1/Exports/Folder/{id}/RecoverRecover specified folder
ExportsApiexport_folders_rename_folderPUT /api/rp/v1/Exports/Folder/{id}/RenameRename a folder
ExportsApiexport_folders_update_iconPUT /api/rp/v1/Exports/Folder/{id}/IconUpdate a folder's icon
ExportsApiexport_folders_update_permissionsPOST /api/rp/v1/Exports/{id}/permissionsUpdate permissions
ExportsApiexport_folders_update_tagsPUT /api/rp/v1/Exports/Folder/{id}/UpdateTagsUpdate tags
ExportsApiexports_copy_filePOST /api/rp/v1/Exports/File/{id}/Copy/{folderId}Copy a file into a specified folder
ExportsApiexports_create_sharing_keyPOST /api/rp/v1/Exports/File/{id}/sharingKeyCreate a new key, that can be used to share access to a file <br /> (You need Administrate.Anon permission to create a new key)
ExportsApiexports_delete_fileDELETE /api/rp/v1/Exports/File/{id}Delete specified file
ExportsApiexports_delete_sharing_keyDELETE /api/rp/v1/Exports/File/{id}/sharingKeyDeletes a sharing key, making links, that utilizing it no longer work
ExportsApiexports_get_by_task_idGET /api/rp/v1/Exports/File/Task/{taskId}Get exports by specified task id
ExportsApiexports_get_by_task_message_idGET /api/rp/v1/Exports/File/TaskMessage/{taskMessageId}Get export by specified task message id
ExportsApiexports_get_fileGET /api/rp/v1/Exports/File/{id}Get export by specified id
ExportsApiexports_get_file_historyGET /api/rp/v1/Exports/File/{id}/HistoryReturns list of actions, performed on this file
ExportsApiexports_get_files_countGET /api/rp/v1/Exports/Folder/{id}/CountFilesGet count of files what contains in a specified folder
ExportsApiexports_get_files_listGET /api/rp/v1/Exports/Folder/{id}/ListFilesGet files from the specified folder
ExportsApiexports_get_my_permissionsGET /api/rp/v1/Exports/File/{id}/mypermissionsGet current user's permissions to a file
ExportsApiexports_get_permissionsGET /api/rp/v1/Exports/File/{id}/permissionsGet all permissions from a file. <br />
ExportsApiexports_get_sharing_keysGET /api/rp/v1/Exports/File/{id}/sharingKeysReturns all sharing keys, associated with the file
ExportsApiexports_move_filePOST /api/rp/v1/Exports/File/{id}/Move/{folderId}Move file to a specified folder
ExportsApiexports_move_file_to_binDELETE /api/rp/v1/Exports/File/{id}/ToBinMove specified file to recycle bin
ExportsApiexports_recover_filePOST /api/rp/v1/Exports/File/{id}/RecoverRecover specified file from bin
ExportsApiexports_rename_filePUT /api/rp/v1/Exports/File/{id}/RenameRename a file
ExportsApiexports_update_iconPUT /api/rp/v1/Exports/File/{id}/IconUpdate a files's icon
ExportsApiexports_update_permissionsPOST /api/rp/v1/Exports/File/{id}/permissionsUpdate permissions
ExportsApiexports_update_tagsPUT /api/rp/v1/Exports/File/{id}/UpdateTagsUpdate tags
FontsApifonts_add_public_fontPOST /api/v1/fonts/addAllows user to add a font from a list of public fonts to their subscription
FontsApifonts_count_fonts_asyncGET /api/v1/fonts/countReturns a number of fonts in a subscription
FontsApifonts_count_occupied_spaceGET /api/v1/fonts/counttotalsizebysubscriptionreturns storage space occupied by fonts in the subscription
FontsApifonts_count_public_fonts_asyncGET /api/v1/fonts/public/countReturns a number of pulbic fonts
FontsApifonts_delete_fontDELETE /api/v1/fonts/{id}deletes a font from the subscirption by id
FontsApifonts_download_fontGET /api/v1/fonts/{id}/downloadDownloads font by it's id
FontsApifonts_download_public_fontGET /api/v1/fonts/public/{id}/downloadDownloads a public font by it's id
FontsApifonts_get_font_familiesGET /api/v1/fonts/familiesReturns distinct font names from public and private font lists (excluding disabled fonts)
FontsApifonts_get_fontsGET /api/v1/fonts/listreturns a list of fonts in the subscription
FontsApifonts_get_fonts_by_reportGET /api/v1/fonts/ListByReport/{reportId}Returns a list of fonts in the subscription by report id.
FontsApifonts_get_fonts_by_templateGET /api/v1/fonts/ListByTemplate/{templateId}Returns a list of fonts in the subscription by report id.
FontsApifonts_get_fonts_cssGET /api/v1/fonts/cssCreates a css stylesheet for a public font
FontsApifonts_get_fonts_css_by_reportGET /api/v1/fonts/CssByReport/{reportId}Creates a css stylesheet for a public fonts by report.
FontsApifonts_get_fonts_css_by_templateGET /api/v1/fonts/CssByTemplate/{templateId}Creates a css stylesheet for a public font by template.
FontsApifonts_get_my_permissionsGET /api/v1/fonts/{id}/mypermissionsGet current user's permissions to a font
FontsApifonts_get_permissionsGET /api/v1/fonts/{id}/permissionsGet font's permissions
FontsApifonts_get_public_fontsGET /api/v1/fonts/public/listReturns a list of public fonts
FontsApifonts_get_public_fonts_cssGET /api/v1/fonts/public/cssCreates a css stylesheet for a public font
FontsApifonts_update_fontPUT /api/v1/fonts/{id}updates a user font model
FontsApifonts_update_permissionsPUT /api/v1/fonts/{id}/permissionsUpdate permissions
FontsApifonts_upload_fontPOST /api/v1/fonts/uploadAllows user to upload a new truetype font to their subscription
GroupUsersApigroup_users_add_user_to_groupPUT /api/manage/v1/Groups/{id}/Users/{userId}Add user to the group by identifier
GroupUsersApigroup_users_get_users_in_groupGET /api/manage/v1/Groups/{id}/UsersReturns users in the group by identifier
GroupUsersApigroup_users_leave_from_groupDELETE /api/manage/v1/Groups/{id}/leaveLeave from the group
GroupUsersApigroup_users_remove_from_groupDELETE /api/manage/v1/Groups/{id}/Users/{userId}Remove user from the group by identifier
GroupsApigroups_create_groupPOST /api/manage/v1/GroupsCreate a new user group
GroupsApigroups_delete_groupDELETE /api/manage/v1/Groups/{id}Delete group by identifier
GroupsApigroups_get_groupGET /api/manage/v1/Groups/{id}Gets group by identifier
GroupsApigroups_get_group_listGET /api/manage/v1/GroupsReturns a list of current user's groups<br /> This method will return following data about groups : <br /> Id, Name, Created time (UTC), Edited time (UTC), creator id, <br /> editor id, subscription id
GroupsApigroups_get_my_permissionsGET /api/manage/v1/Groups/{id}/mypermissionsGet current user's permissions to group
GroupsApigroups_get_permissionsGET /api/manage/v1/Groups/{id}/permissionsGets group permissions by identifier
GroupsApigroups_rename_groupPUT /api/manage/v1/Groups/{id}/renameRename group by identifier
GroupsApigroups_update_permissionsPOST /api/manage/v1/Groups/{id}/permissionsUpdate permissions
HealthCheckApihealth_check_data_getGET /api/backend/v1/HealthCheckhealthcheck
ReportsApireport_folder_and_file_clear_recycle_binDELETE /api/rp/v1/Reports/{subscriptionId}/ClearRecycleBinDelete all folders and files from recycle bin
ReportsApireport_folder_and_file_copy_filesPOST /api/rp/v1/Reports/{subscriptionId}/CopyFilesCopy folders and files to a specified folder
ReportsApireport_folder_and_file_count_recycle_bin_folders_and_filesGET /api/rp/v1/Reports/{subscriptionId}/CountRecycleBinFolderAndFilesCount all folders and files from recycle bin
ReportsApireport_folder_and_file_delete_filesPOST /api/rp/v1/Reports/{subscriptionId}/DeleteFilesDelete folders and files from a folder or the recycle bin
ReportsApireport_folder_and_file_get_countGET /api/rp/v1/Reports/Folder/{id}/CountFolderAndFilesCount folders and files in a folder
ReportsApireport_folder_and_file_get_folders_and_filesGET /api/rp/v1/Reports/Folder/{id}/ListFolderAndFilesGet all folders and files from specified folder
ReportsApireport_folder_and_file_get_recycle_bin_folders_and_filesGET /api/rp/v1/Reports/{subscriptionId}/ListRecycleBinFolderAndFilesGet all folders and files from recycle bin
ReportsApireport_folder_and_file_move_filesPOST /api/rp/v1/Reports/{subscriptionId}/MoveFilesMove folders and files to a specified folder
ReportsApireport_folder_and_file_move_files_to_binPOST /api/rp/v1/Reports/{subscriptionId}/ToBinMove folders and files to the recycle bin
ReportsApireport_folder_and_file_recover_all_from_recycle_binPOST /api/rp/v1/Reports/{subscriptionId}/RecoverRecycleBinRecover all folders and files from recycle bin
ReportsApireport_folder_and_file_recover_filesPOST /api/rp/v1/Reports/{subscriptionId}/RecoverFilesRecover folders and files from the recycle bin
ReportsApireport_folders_calculate_folder_sizeGET /api/rp/v1/Reports/Folder/{id}/sizeGet specified folder, calculate it's size
ReportsApireport_folders_copy_folderPOST /api/rp/v1/Reports/Folder/{id}/Copy/{folderId}Move folder to a specified folder
ReportsApireport_folders_delete_folderDELETE /api/rp/v1/Reports/Folder/{id}Delete specified folder
ReportsApireport_folders_exportPOST /api/rp/v1/Reports/Folder/{id}/ExportExport specified report folder to a specified format
ReportsApireport_folders_get_breadcrumbsGET /api/rp/v1/Reports/Folder/{id}/BreadcrumbsGet specified folder breadcrumbs
ReportsApireport_folders_get_folderGET /api/rp/v1/Reports/Folder/{id}Get specified folder
ReportsApireport_folders_get_foldersGET /api/rp/v1/Reports/Folder/{id}/ListFoldersGet all folders from specified folder
ReportsApireport_folders_get_folders_countGET /api/rp/v1/Reports/Folder/{id}/CountFoldersGet count of folders what contains in a specified folder
ReportsApireport_folders_get_my_permissionsGET /api/rp/v1/Reports/Folder/{folderId}/mypermissionsGet user's permissions for a folder by id
ReportsApireport_folders_get_or_createGET /api/rp/v1/Reports/Folder/getOrCreateGet specified folder
ReportsApireport_folders_get_permissionsGET /api/rp/v1/Reports/Folder/{id}/permissionsGet all folder permissions
ReportsApireport_folders_get_root_folderGET /api/rp/v1/Reports/RootGet workspace's root folder
ReportsApireport_folders_move_folderPOST /api/rp/v1/Reports/Folder/{id}/Move/{folderId}Move folder into a specified folder
ReportsApireport_folders_move_folder_to_binDELETE /api/rp/v1/Reports/Folder/{id}/ToBinMove specified folder to recycle bin
ReportsApireport_folders_post_folderPOST /api/rp/v1/Reports/Folder/{id}/FolderCreate folder
ReportsApireport_folders_recover_folderPOST /api/rp/v1/Reports/Folder/{id}/RecoverRecover specified folder
ReportsApireport_folders_rename_folderPUT /api/rp/v1/Reports/Folder/{id}/RenameRename a folder
ReportsApireport_folders_update_iconPUT /api/rp/v1/Reports/Folder/{id}/IconUpdate a folder's icon
ReportsApireport_folders_update_permissionsPOST /api/rp/v1/Reports/{id}/permissionsUpdate permissions
ReportsApireport_folders_update_tagsPUT /api/rp/v1/Reports/Folder/{id}/UpdateTagsUpdate tags
ReportsApireports_copy_filePOST /api/rp/v1/Reports/File/{id}/Copy/{folderId}Copy a file into a specified folder
ReportsApireports_create_sharing_keyPOST /api/rp/v1/Reports/File/{id}/sharingKeyCreate a new key, that can be used to share access to a file <br /> (You need Administrate.Anon permission to create a new key)
ReportsApireports_delete_fileDELETE /api/rp/v1/Reports/File/{id}Delete specified file
ReportsApireports_delete_sharing_keyDELETE /api/rp/v1/Reports/File/{id}/sharingKeyDeletes a sharing key, making links, that utilizing it no longer work
ReportsApireports_exportPOST /api/rp/v1/Reports/File/{id}/ExportExport specified report to a specified format
ReportsApireports_get_by_task_idGET /api/rp/v1/Reports/File/Task/{taskId}Get reports by specified task id
ReportsApireports_get_by_task_message_idGET /api/rp/v1/Reports/File/TaskMessage/{taskMessageId}Get report by specified task message id
ReportsApireports_get_fileGET /api/rp/v1/Reports/File/{id}Get specified file
ReportsApireports_get_file_historyGET /api/rp/v1/Reports/File/{id}/HistoryReturns list of actions, performed on this file
ReportsApireports_get_files_countGET /api/rp/v1/Reports/Folder/{id}/CountFilesGet count of files what contains in a specified folder
ReportsApireports_get_files_listGET /api/rp/v1/Reports/Folder/{id}/ListFilesGet files from the specified folder
ReportsApireports_get_my_permissionsGET /api/rp/v1/Reports/File/{id}/mypermissionsGet current user's permissions to a file
ReportsApireports_get_permissionsGET /api/rp/v1/Reports/File/{id}/permissionsGet all permissions from a file. <br />
ReportsApireports_get_sharing_keysGET /api/rp/v1/Reports/File/{id}/sharingKeysReturns all sharing keys, associated with the file
ReportsApireports_move_filePOST /api/rp/v1/Reports/File/{id}/Move/{folderId}Move file to a specified folder
ReportsApireports_move_file_to_binDELETE /api/rp/v1/Reports/File/{id}/ToBinMove specified file to recycle bin
ReportsApireports_recover_filePOST /api/rp/v1/Reports/File/{id}/RecoverRecover specified file from bin
ReportsApireports_rename_filePUT /api/rp/v1/Reports/File/{id}/RenameRename a file
ReportsApireports_static_previewPOST /api/rp/v1/Reports/File/{id}/StaticPreviewMake preview for the report. Generate a new or return exist prepared svg files. If template was changed will be returned a new. Pass the `` parameter to check prepared timestamp
ReportsApireports_update_iconPUT /api/rp/v1/Reports/File/{id}/IconUpdate a files's icon
ReportsApireports_update_permissionsPOST /api/rp/v1/Reports/File/{id}/permissionsUpdate permissions
ReportsApireports_update_tagsPUT /api/rp/v1/Reports/File/{id}/UpdateTagsUpdate tags
ReportsApireports_upload_filePOST /api/rp/v1/Reports/Folder/{id}/FileUpload a file to the specified folder. The method is deprecated, use the UploadFileV2 method instead!
ReportsApireports_upload_file_v2POST /api/rp/v2/Reports/Folder/{id}/FileAlternative api for upload a file to the specified folder!
SubscriptionGroupsApisubscription_groups_count_groups_asyncGET /api/manage/v1/Subscriptions/{subscriptionId}/countReturns a number of groups in subscription
SubscriptionGroupsApisubscription_groups_get_groups_listGET /api/manage/v1/Subscriptions/{subscriptionId}/groupsreturns groups of the subscription or subscription user
SubscriptionInvitesApisubscription_invites_accept_inviteGET /api/manage/v1/Subscriptions/{subscriptionId}/invite/{accessToken}/acceptAdd the current user to the subscription using invite,
SubscriptionInvitesApisubscription_invites_create_invitePOST /api/manage/v1/Subscriptions/{subscriptionId}/inviteCreate invite to subscription
SubscriptionInvitesApisubscription_invites_delete_inviteDELETE /api/manage/v1/Subscriptions/{subscriptionId}/invite/{accesstoken}Delete invite with specified token
SubscriptionInvitesApisubscription_invites_get_invitesGET /api/manage/v1/Subscriptions/{subscriptionId}/invitesGet list of invites in a subscription, the added users will be displayed in the list of users of the subscription, and these users will also have an active subscription.
SubscriptionPlansApisubscription_plans_get_subscription_planGET /api/manage/v1/SubscriptionPlans/{id}Returns a subscription plan. Not all subscriptions can be issued for customer.
SubscriptionPlansApisubscription_plans_get_subscription_plansGET /api/manage/v1/SubscriptionPlansReturns a list of active subscription plans that can be issued to the user.
SubscriptionUsersApisubscription_users_add_userPUT /api/manage/v1/Subscriptions/{subscriptionId}/users/{userId}Add a user to the subscription, the added users will be displayed in the list of users of the subscription, and these users will also have an active subscription.
SubscriptionUsersApisubscription_users_count_users_asyncGET /api/manage/v1/Subscriptions/{subscriptionId}/UsersCountReturns a number of users in subscription
SubscriptionUsersApisubscription_users_get_usersGET /api/manage/v1/Subscriptions/{subscriptionId}/usersReturns all users of subscription
SubscriptionUsersApisubscription_users_leave_subscripitonDELETE /api/manage/v1/Subscriptions/{subscriptionId}/leaveAllows user to leave subscription,.
SubscriptionUsersApisubscription_users_remove_userDELETE /api/manage/v1/Subscriptions/{subscriptionId}/users/{userId}Delete a user from the subscription,
SubscriptionsApisubscriptions_get_default_permissionsGET /api/manage/v1/Subscriptions/{subscriptionId}/defaultPermissionsGet subscription's default permissions for new entities
SubscriptionsApisubscriptions_get_my_permissionsGET /api/manage/v1/Subscriptions/{subId}/mypermissionsGet user's permissions for a subscription by id
SubscriptionsApisubscriptions_get_permissionsGET /api/manage/v1/Subscriptions/{id}/permissionsGet permissions for a subscription by id
SubscriptionsApisubscriptions_get_subscriptionGET /api/manage/v1/Subscriptions/{id}Returns the subscription by id
SubscriptionsApisubscriptions_get_subscriptionsGET /api/manage/v1/SubscriptionsReturns a list of all subscriptions of current user
SubscriptionsApisubscriptions_rename_subscriptionPUT /api/manage/v1/Subscriptions/{subscriptionId}/renameRename subscription
SubscriptionsApisubscriptions_update_default_permissionsPUT /api/manage/v1/Subscriptions/{subscriptionId}/defaultPermissionsChange subscription's default permissions for new entities
SubscriptionsApisubscriptions_update_localePUT /api/manage/v1/Subscriptions/{subscriptionId}/LocaleUpdate subscription's default locale
SubscriptionsApisubscriptions_update_permissionsPOST /api/manage/v1/Subscriptions/{id}/permissionsUpdate permissions
SubscriptionsApisubscriptions_update_preview_typePUT /api/manage/v1/Subscriptions/{subscriptionId}/PreviewTypeUpdate subscription's preview type
SubscriptionsApisubscriptions_update_subscription_domainsPUT /api/manage/v1/Subscriptions/{subscriptionId}/DomainsUpdate subscription's allowed domains
TasksApitasks_create_taskPOST /api/tasks/v1/TasksCreate a new task
TasksApitasks_delete_taskDELETE /api/tasks/v1/Tasks/{taskId}Delete a task from a storage
TasksApitasks_getGET /api/tasks/v1/Tasks/{taskId}Get a task by a specified id
TasksApitasks_get_listGET /api/tasks/v1/TasksGet tasks list
TasksApitasks_get_my_permissionsGET /api/tasks/v1/Tasks/{id}/mypermissionsGet current user's permissions to Task
TasksApitasks_get_permissionsGET /api/tasks/v1/Tasks/{id}/permissionsGet all Task permissions
TasksApitasks_rename_taskPUT /api/tasks/v1/Tasks/{taskId}/renameRename a task
TasksApitasks_run_taskPOST /api/tasks/v1/Tasks/runRun a task from request body
TasksApitasks_run_task_by_idPOST /api/tasks/v1/Tasks/{taskId}/runRun a task by id
TasksApitasks_update_permissionsPOST /api/tasks/v1/Tasks/{id}/permissionsUpdate permissions
TasksApitasks_update_taskPUT /api/tasks/v1/Tasks/{taskId}Update a task
TemplatesApitemplate_folder_and_file_clear_recycle_binDELETE /api/rp/v1/Templates/{subscriptionId}/ClearRecycleBinDelete all folders and files from recycle bin
TemplatesApitemplate_folder_and_file_copy_filesPOST /api/rp/v1/Templates/{subscriptionId}/CopyFilesCopy folders and files to a specified folder
TemplatesApitemplate_folder_and_file_count_recycle_bin_folders_and_filesGET /api/rp/v1/Templates/{subscriptionId}/CountRecycleBinFolderAndFilesCount all folders and files from recycle bin
TemplatesApitemplate_folder_and_file_delete_filesPOST /api/rp/v1/Templates/{subscriptionId}/DeleteFilesDelete folders and files from a folder or the recycle bin
TemplatesApitemplate_folder_and_file_get_countGET /api/rp/v1/Templates/Folder/{id}/CountFolderAndFilesCount folders and files in a folder
TemplatesApitemplate_folder_and_file_get_folders_and_filesGET /api/rp/v1/Templates/Folder/{id}/ListFolderAndFilesGet all folders and files from specified folder
TemplatesApitemplate_folder_and_file_get_recycle_bin_folders_and_filesGET /api/rp/v1/Templates/{subscriptionId}/ListRecycleBinFolderAndFilesGet all folders and files from recycle bin
TemplatesApitemplate_folder_and_file_move_filesPOST /api/rp/v1/Templates/{subscriptionId}/MoveFilesMove folders and files to a specified folder
TemplatesApitemplate_folder_and_file_move_files_to_binPOST /api/rp/v1/Templates/{subscriptionId}/ToBinMove folders and files to the recycle bin
TemplatesApitemplate_folder_and_file_recover_all_from_recycle_binPOST /api/rp/v1/Templates/{subscriptionId}/RecoverRecycleBinRecover all folders and files from recycle bin
TemplatesApitemplate_folder_and_file_recover_filesPOST /api/rp/v1/Templates/{subscriptionId}/RecoverFilesRecover folders and files from the recycle bin
TemplatesApitemplate_folders_calculate_folder_sizeGET /api/rp/v1/Templates/Folder/{id}/sizeGet specified folder, calculate it's size
TemplatesApitemplate_folders_copy_folderPOST /api/rp/v1/Templates/Folder/{id}/Copy/{folderId}Move folder to a specified folder
TemplatesApitemplate_folders_delete_folderDELETE /api/rp/v1/Templates/Folder/{id}Delete specified folder
TemplatesApitemplate_folders_exportPOST /api/rp/v1/Templates/Folder/{id}/ExportExport specified template folder to a specified format
TemplatesApitemplate_folders_get_breadcrumbsGET /api/rp/v1/Templates/Folder/{id}/BreadcrumbsGet specified folder breadcrumbs
TemplatesApitemplate_folders_get_folderGET /api/rp/v1/Templates/Folder/{id}Get specified folder
TemplatesApitemplate_folders_get_foldersGET /api/rp/v1/Templates/Folder/{id}/ListFoldersGet all folders from specified folder
TemplatesApitemplate_folders_get_folders_countGET /api/rp/v1/Templates/Folder/{id}/CountFoldersGet count of folders what contains in a specified folder
TemplatesApitemplate_folders_get_my_permissionsGET /api/rp/v1/Templates/Folder/{folderId}/mypermissionsGet user's permissions for a folder by id
TemplatesApitemplate_folders_get_or_createGET /api/rp/v1/Templates/Folder/getOrCreateGet specified folder
TemplatesApitemplate_folders_get_permissionsGET /api/rp/v1/Templates/Folder/{id}/permissionsGet all folder permissions
TemplatesApitemplate_folders_get_root_folderGET /api/rp/v1/Templates/RootGet workspace's root folder
TemplatesApitemplate_folders_move_folderPOST /api/rp/v1/Templates/Folder/{id}/Move/{folderId}Move folder into a specified folder
TemplatesApitemplate_folders_move_folder_to_binDELETE /api/rp/v1/Templates/Folder/{id}/ToBinMove specified folder to recycle bin
TemplatesApitemplate_folders_post_folderPOST /api/rp/v1/Templates/Folder/{id}/FolderCreate folder
TemplatesApitemplate_folders_preparePOST /api/rp/v1/Templates/Folder/{id}/PreparePrepare specified template folder to report folder
TemplatesApitemplate_folders_recover_folderPOST /api/rp/v1/Templates/Folder/{id}/RecoverRecover specified folder
TemplatesApitemplate_folders_rename_folderPUT /api/rp/v1/Templates/Folder/{id}/RenameRename a folder
TemplatesApitemplate_folders_update_iconPUT /api/rp/v1/Templates/Folder/{id}/IconUpdate a folder's icon
TemplatesApitemplate_folders_update_permissionsPOST /api/rp/v1/Templates/{id}/permissionsUpdate permissions
TemplatesApitemplate_folders_update_tagsPUT /api/rp/v1/Templates/Folder/{id}/UpdateTagsUpdate tags
TemplatesApitemplates_copy_filePOST /api/rp/v1/Templates/File/{id}/Copy/{folderId}Copy a file into a specified folder
TemplatesApitemplates_create_sharing_keyPOST /api/rp/v1/Templates/File/{id}/sharingKeyCreate a new key, that can be used to share access to a file <br /> (You need Administrate.Anon permission to create a new key)
TemplatesApitemplates_delete_fileDELETE /api/rp/v1/Templates/File/{id}Delete specified file
TemplatesApitemplates_delete_sharing_keyDELETE /api/rp/v1/Templates/File/{id}/sharingKeyDeletes a sharing key, making links, that utilizing it no longer work
TemplatesApitemplates_exportPOST /api/rp/v1/Templates/File/{id}/ExportExport specified report template to a specified format
TemplatesApitemplates_get_fileGET /api/rp/v1/Templates/File/{id}Get specified file
TemplatesApitemplates_get_file_historyGET /api/rp/v1/Templates/File/{id}/HistoryReturns list of actions, performed on this file
TemplatesApitemplates_get_files_countGET /api/rp/v1/Templates/Folder/{id}/CountFilesGet count of files what contains in a specified folder
TemplatesApitemplates_get_files_listGET /api/rp/v1/Templates/Folder/{id}/ListFilesGet files from the specified folder
TemplatesApitemplates_get_my_permissionsGET /api/rp/v1/Templates/File/{id}/mypermissionsGet current user's permissions to a file
TemplatesApitemplates_get_permissionsGET /api/rp/v1/Templates/File/{id}/permissionsGet all permissions from a file. <br />
TemplatesApitemplates_get_sharing_keysGET /api/rp/v1/Templates/File/{id}/sharingKeysReturns all sharing keys, associated with the file
TemplatesApitemplates_move_filePOST /api/rp/v1/Templates/File/{id}/Move/{folderId}Move file to a specified folder
TemplatesApitemplates_move_file_to_binDELETE /api/rp/v1/Templates/File/{id}/ToBinMove specified file to recycle bin
TemplatesApitemplates_preparePOST /api/rp/v1/Templates/File/{id}/PreparePrepare specified template to report
TemplatesApitemplates_recover_filePOST /api/rp/v1/Templates/File/{id}/RecoverRecover specified file from bin
TemplatesApitemplates_rename_filePUT /api/rp/v1/Templates/File/{id}/RenameRename a file
TemplatesApitemplates_static_previewPOST /api/rp/v1/Templates/File/{id}/StaticPreviewMake preview for the report. Generate a new or return exist prepared svg files. If template was changed will be returned a new. Pass the `` parameter to check prepared timestamp
TemplatesApitemplates_update_contentPUT /api/rp/v1/Templates/File/{id}/ContentUpdates contnet of the template. The method is deprecated, use the UpdateContentV2 method instead!
TemplatesApitemplates_update_content_v2PUT /api/rp/v2/Templates/File/{id}/ContentUpdates contnet of the template.
TemplatesApitemplates_update_iconPUT /api/rp/v1/Templates/File/{id}/IconUpdate a files's icon
TemplatesApitemplates_update_parametersPUT /api/rp/v1/Templates/File/{id}/parameters
TemplatesApitemplates_update_permissionsPOST /api/rp/v1/Templates/File/{id}/permissionsUpdate permissions
TemplatesApitemplates_update_tagsPUT /api/rp/v1/Templates/File/{id}/UpdateTagsUpdate tags
TemplatesApitemplates_upload_filePOST /api/rp/v1/Templates/Folder/{id}/FileUpload a file to the specified folder. The method is deprecated, use the UploadFileV2 method instead!
TemplatesApitemplates_upload_file_v2POST /api/rp/v2/Templates/Folder/{id}/FileAlternative api for upload a file to the specified folder!
TemplatesApitemplates_wasm_static_previewPOST /api/rp/v1/Templates/File/{id}/WasmStaticPreviewMake preview for the report (template). Generate a new or return exist prepared fpx file. If template was changed will be returned a new.
UserNotificationsApiuser_notifications_clear_notificationsDELETE /api/manage/v1/notificationsUse this endpoint to &quot;clear&quot; your notifications
UserNotificationsApiuser_notifications_get_notificationsGET /api/manage/v1/notificationsUse this endpoint to recieve notifications
UserProfileApiuser_profile_get_my_profileGET /api/manage/v1/UserProfileReturn current profile of the current user
UserProfileApiuser_profile_get_user_profileGET /api/manage/v1/UserProfile/{userId}Return user profile by user identifier. If the user did not provide information about himself or blocked, then the endpoint will return an empty model. (only id)
UserProfileApiuser_profile_update_my_profilePUT /api/manage/v1/UserProfileUpdate profile of the current user
UserSettingsApiuser_settings_accept_agreementsPOST /api/manage/v1/UserSettings/acceptUse this endpoint to accept current version of service license agreement
UserSettingsApiuser_settings_get_current_user_settingsGET /api/manage/v1/UserSettingsReturn current user settings.
UserSettingsApiuser_settings_update_my_settingsPUT /api/manage/v1/UserSettingsUpdate settings of the current user

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

JWT

  • Type: Bearer authentication (JWT)

ApiKey

  • Type: HTTP basic authentication

Author

About

No description, website, or topics provided.

Resources

Stars

1 star

Watchers

2 watching

Forks

Releases

Packages

Used by

Contributors

Languages