Skip to content

FastReports/FastReport-Cloud-Python

BranchesTags

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: 2024.1.0
  • Build package: org.openapitools.codegen.languages.PythonLegacyClientCodegen

Requirements.

Python 2.7 and 3.4+

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:

import fastreport_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:

import fastreport_cloud_sdk

Getting Started

Please follow the installation procedure and then run the following:

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 = "https://fastreport.cloud",
    username = 'apikey',
                # Put your api key here
    password = '????????????????????????????????????????????????????'
)


# 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.UserProfileApi(api_client)
    
    try:
        # Return current profile of the current user
        api_response = api_instance.user_profile_get_my_profile()
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling UserProfileApi->user_profile_get_my_profile: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
ApiKeysApi api_keys_create_api_key POST /api/manage/v1/ApiKeys Create a new apikey, 5 apikeys for user. Hardcoded for ddos.
ApiKeysApi api_keys_delete_api_key DELETE /api/manage/v1/ApiKeys Delete an apikey
ApiKeysApi api_keys_get_api_keys GET /api/manage/v1/ApiKeys Returns list with all api keys of current user
ConfigurationApi configuration_get GET /api/v1/Configuration returns information about server configuration
ContactGroupsApi contact_groups_create POST /api/v1/ContactGroups/group Creates contact group
ContactGroupsApi contact_groups_delete DELETE /api/v1/ContactGroups/{id} Removes contact by id
ContactGroupsApi contact_groups_get GET /api/v1/ContactGroups/{id} Returns contact group by id
ContactGroupsApi contact_groups_get_list GET /api/v1/ContactGroups/subscription/{subscriptionId}/groups Returns contact groups by subscriptionId
ContactGroupsApi contact_groups_update PUT /api/v1/ContactGroups/{id} Updates contact group by id
ContactsApi contacts_create POST /api/v1/Contacts/contact Creates new contact
ContactsApi contacts_delete DELETE /api/v1/Contacts/{id} Removes contact by id
ContactsApi contacts_get GET /api/v1/Contacts/{id} Returns contact group by id
ContactsApi contacts_get_by_group GET /api/v1/Contacts/group/{groupId}/contacts Returns contacts by group id
ContactsApi contacts_get_list GET /api/v1/Contacts/subscription/{subscriptionId}/contacts Allows to search for contacts
ContactsApi contacts_update PUT /api/v1/Contacts/{id} Updates contact by id
DataSourcesApi data_sources_count_data_sources_async GET /api/data/v1/DataSources/{subscriptionId}/count Returns a number of data sources in subscription
DataSourcesApi data_sources_create_data_source POST /api/data/v1/DataSources Create new data source
DataSourcesApi data_sources_delete_data_source DELETE /api/data/v1/DataSources/{id} Delete data source by id
DataSourcesApi data_sources_fetch_data GET /api/data/v1/DataSources/{id}/fetch This should connect to a database and set data structure
DataSourcesApi data_sources_get_available_data_sources GET /api/data/v1/DataSources Returns 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.
DataSourcesApi data_sources_get_data_source GET /api/data/v1/DataSources/{id} Get data source by id
DataSourcesApi data_sources_get_permissions GET /api/data/v1/DataSources/{id}/permissions Get all Data source permissions
DataSourcesApi data_sources_rename_data_source PUT /api/data/v1/DataSources/{id}/rename Rename data source by id
DataSourcesApi data_sources_update_connection_string PUT /api/data/v1/DataSources/{id}/ConnectionString Update data source's connection string by id
DataSourcesApi data_sources_update_permissions POST /api/data/v1/DataSources/{id}/permissions Update permissions
DataSourcesApi data_sources_update_subscription_data_source PUT /api/data/v1/DataSources/{id}/updateSubscription Update data source's subscription
DownloadApi download_get_export GET /download/e/{id} Returns a export file with specified id
DownloadApi download_get_export_thumbnail GET /download/e/{id}/thumbnail Returns export's thumbnail
DownloadApi download_get_exports GET /download/es/{archiveName} Returns a zip archive with selected ids
DownloadApi download_get_last_svg_export GET /download/lastPreview/{reportId} returns export, that was created from report with specified id. INTERNAL USAGE ONLY!
DownloadApi download_get_report GET /download/r/{id} Returns a prepared file with specified id
DownloadApi download_get_report_thumbnail GET /download/r/{id}/thumbnail Returns report's thumbnail
DownloadApi download_get_reports GET /download/rs/{archiveName} Returns a zip archive with selected files
DownloadApi download_get_template GET /download/t/{id} Returns a Template file with specified id
DownloadApi download_get_template_thumbnail GET /download/t/{id}/thumbnail Returns template's thumbnail
DownloadApi download_get_templates GET /download/ts/{archiveName} Returns a zip archive with selected files
ExportsApi export_folder_and_file_clear_recycle_bin DELETE /api/rp/v1/Exports/{subscriptionId}/ClearRecycleBin Delete all folders and files from recycle bin
ExportsApi export_folder_and_file_delete_files POST /api/rp/v1/Exports/{subscriptionId}/DeleteFiles Delete folders and files
ExportsApi 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
ExportsApi export_folder_and_file_get_folders_and_files GET /api/rp/v1/Exports/Folder/{id}/ListFolderAndFiles Get all folders and files from specified folder
ExportsApi 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
ExportsApi export_folder_and_file_move_files_to_bin POST /api/rp/v1/Exports/{subscriptionId}/ToBin Move folders and files to bin
ExportsApi export_folder_and_file_recover_all_from_recycle_bin POST /api/rp/v1/Exports/{subscriptionId}/RecoverRecycleBin Recover all folders and files from recycle bin
ExportsApi export_folder_and_file_recover_files POST /api/rp/v1/Exports/{subscriptionId}/RecoverFiles Recover folders and files from bin
ExportsApi export_folders_calculate_folder_size GET /api/rp/v1/Exports/Folder/{id}/size Get specified folder, calculate it's size
ExportsApi export_folders_copy_folder POST /api/rp/v1/Exports/Folder/{id}/Copy/{folderId} Move folder to a specified folder
ExportsApi export_folders_delete_folder DELETE /api/rp/v1/Exports/Folder/{id} Delete specified folder
ExportsApi export_folders_get_breadcrumbs GET /api/rp/v1/Exports/Folder/{id}/Breadcrumbs Get specified folder breadcrumbs
ExportsApi export_folders_get_folder GET /api/rp/v1/Exports/Folder/{id} Get specified folder
ExportsApi export_folders_get_folders GET /api/rp/v1/Exports/Folder/{id}/ListFolders Get all folders from specified folder
ExportsApi export_folders_get_folders_count GET /api/rp/v1/Exports/Folder/{id}/CountFolders Get count of folders what contains in a specified folder
ExportsApi export_folders_get_or_create GET /api/rp/v1/Exports/Folder/getOrCreate Get specified folder
ExportsApi export_folders_get_permissions GET /api/rp/v1/Exports/Folder/{id}/permissions Get all folder permissions
ExportsApi export_folders_get_root_folder GET /api/rp/v1/Exports/Root Get user's root folder (without parents)
ExportsApi export_folders_move_folder POST /api/rp/v1/Exports/Folder/{id}/Move/{folderId} Move folder to a specified folder
ExportsApi export_folders_move_folder_to_bin DELETE /api/rp/v1/Exports/Folder/{id}/ToBin Move specified folder to recycle bin
ExportsApi export_folders_post_folder POST /api/rp/v1/Exports/Folder/{id}/Folder Create folder
ExportsApi export_folders_recover_folder POST /api/rp/v1/Exports/Folder/{id}/Recover Recover specified folder
ExportsApi export_folders_rename_folder PUT /api/rp/v1/Exports/Folder/{id}/Rename Rename a folder
ExportsApi export_folders_update_icon PUT /api/rp/v1/Exports/Folder/{id}/Icon Update a folder's icon
ExportsApi export_folders_update_permissions POST /api/rp/v1/Exports/{id}/permissions Update permissions
ExportsApi export_folders_update_tags PUT /api/rp/v1/Exports/Folder/{id}/UpdateTags Update tags
ExportsApi exports_copy_file POST /api/rp/v1/Exports/File/{id}/Copy/{folderId} Copy file to a specified folder
ExportsApi exports_delete_file DELETE /api/rp/v1/Exports/File/{id} Delete specified file
ExportsApi exports_get_file GET /api/rp/v1/Exports/File/{id}
ExportsApi exports_get_file_history GET /api/rp/v1/Exports/File/{id}/History Returns list of actions, performed on this file
ExportsApi exports_get_files_count GET /api/rp/v1/Exports/Folder/{id}/CountFiles Get count of files what contains in a specified folder
ExportsApi 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.
ExportsApi exports_get_permissions GET /api/rp/v1/Exports/File/{id}/permissions Get all file permissions
ExportsApi exports_move_file POST /api/rp/v1/Exports/File/{id}/Move/{folderId} Move file to a specified folder
ExportsApi exports_move_file_to_bin DELETE /api/rp/v1/Exports/File/{id}/ToBin Move specified file to recycle bin
ExportsApi exports_recover_file POST /api/rp/v1/Exports/File/{id}/Recover Recover specified file from bin
ExportsApi exports_rename_file PUT /api/rp/v1/Exports/File/{id}/Rename Rename a file
ExportsApi exports_update_icon PUT /api/rp/v1/Exports/File/{id}/Icon Update a files's icon
ExportsApi exports_update_permissions POST /api/rp/v1/Exports/File/{id}/permissions Update permissions
ExportsApi exports_update_tags PUT /api/rp/v1/Exports/File/{id}/UpdateTags Update tags
GroupUsersApi group_users_add_user_to_group PUT /api/manage/v1/Groups/{id}/Users/{userId} Add user to the group by identifier
GroupUsersApi group_users_get_users_in_group GET /api/manage/v1/Groups/{id}/Users Returns users in the group by identifier
GroupUsersApi group_users_leave_from_group DELETE /api/manage/v1/Groups/{id}/leave Leave from the group
GroupUsersApi group_users_remove_from_group DELETE /api/manage/v1/Groups/{id}/Users/{userId} Remove user from the group by identifier
GroupsApi groups_create_group POST /api/manage/v1/Groups Create a new user group
GroupsApi groups_delete_group DELETE /api/manage/v1/Groups/{id} Delete group by identifier
GroupsApi groups_get_group GET /api/manage/v1/Groups/{id} Gets group by identifier
GroupsApi groups_get_group_list GET /api/manage/v1/Groups Returns 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
GroupsApi groups_get_permissions GET /api/manage/v1/Groups/{id}/permissions Gets group permissions by identifier
GroupsApi groups_rename_group PUT /api/manage/v1/Groups/{id}/rename Rename group by identifier
GroupsApi groups_update_permissions POST /api/manage/v1/Groups/{id}/permissions Update permissions
HealthCheckApi health_check_data_get GET /api/backend/v1/HealthCheck healthcheck
ReportsApi report_folder_and_file_clear_recycle_bin DELETE /api/rp/v1/Reports/{subscriptionId}/ClearRecycleBin Delete all folders and files from recycle bin
ReportsApi report_folder_and_file_delete_files POST /api/rp/v1/Reports/{subscriptionId}/DeleteFiles Delete folders and files
ReportsApi report_folder_and_file_get_count GET /api/rp/v1/Reports/Folder/{id}/CountFolderAndFiles Get count of files and folders what contains in a specified folder
ReportsApi report_folder_and_file_get_folders_and_files GET /api/rp/v1/Reports/Folder/{id}/ListFolderAndFiles Get all folders and files from specified folder
ReportsApi report_folder_and_file_get_recycle_bin_folders_and_files GET /api/rp/v1/Reports/{subscriptionId}/ListRecycleBinFolderAndFiles Get all folders and files from recycle bin
ReportsApi report_folder_and_file_move_files_to_bin POST /api/rp/v1/Reports/{subscriptionId}/ToBin Move folders and files to bin
ReportsApi report_folder_and_file_recover_all_from_recycle_bin POST /api/rp/v1/Reports/{subscriptionId}/RecoverRecycleBin Recover all folders and files from recycle bin
ReportsApi report_folder_and_file_recover_files POST /api/rp/v1/Reports/{subscriptionId}/RecoverFiles Recover folders and files from bin
ReportsApi report_folders_calculate_folder_size GET /api/rp/v1/Reports/Folder/{id}/size Get specified folder, calculate it's size
ReportsApi report_folders_copy_folder POST /api/rp/v1/Reports/Folder/{id}/Copy/{folderId} Move folder to a specified folder
ReportsApi report_folders_delete_folder DELETE /api/rp/v1/Reports/Folder/{id} Delete specified folder
ReportsApi report_folders_export POST /api/rp/v1/Reports/Folder/{id}/Export Export specified report folder to a specified format
ReportsApi report_folders_get_breadcrumbs GET /api/rp/v1/Reports/Folder/{id}/Breadcrumbs Get specified folder breadcrumbs
ReportsApi report_folders_get_folder GET /api/rp/v1/Reports/Folder/{id} Get specified folder
ReportsApi report_folders_get_folders GET /api/rp/v1/Reports/Folder/{id}/ListFolders Get all folders from specified folder
ReportsApi report_folders_get_folders_count GET /api/rp/v1/Reports/Folder/{id}/CountFolders Get count of folders what contains in a specified folder
ReportsApi report_folders_get_or_create GET /api/rp/v1/Reports/Folder/getOrCreate Get specified folder
ReportsApi report_folders_get_permissions GET /api/rp/v1/Reports/Folder/{id}/permissions Get all folder permissions
ReportsApi report_folders_get_root_folder GET /api/rp/v1/Reports/Root Get user's root folder (without parents)
ReportsApi report_folders_move_folder POST /api/rp/v1/Reports/Folder/{id}/Move/{folderId} Move folder to a specified folder
ReportsApi report_folders_move_folder_to_bin DELETE /api/rp/v1/Reports/Folder/{id}/ToBin Move specified folder to recycle bin
ReportsApi report_folders_post_folder POST /api/rp/v1/Reports/Folder/{id}/Folder Create folder
ReportsApi report_folders_recover_folder POST /api/rp/v1/Reports/Folder/{id}/Recover Recover specified folder
ReportsApi report_folders_rename_folder PUT /api/rp/v1/Reports/Folder/{id}/Rename Rename a folder
ReportsApi report_folders_update_icon PUT /api/rp/v1/Reports/Folder/{id}/Icon Update a folder's icon
ReportsApi report_folders_update_permissions POST /api/rp/v1/Reports/{id}/permissions Update permissions
ReportsApi report_folders_update_tags PUT /api/rp/v1/Reports/Folder/{id}/UpdateTags Update tags
ReportsApi reports_copy_file POST /api/rp/v1/Reports/File/{id}/Copy/{folderId} Copy file to a specified folder
ReportsApi reports_delete_file DELETE /api/rp/v1/Reports/File/{id} Delete specified file
ReportsApi reports_export POST /api/rp/v1/Reports/File/{id}/Export Export specified report to a specified format
ReportsApi reports_get_file GET /api/rp/v1/Reports/File/{id} Get specified file
ReportsApi reports_get_file_history GET /api/rp/v1/Reports/File/{id}/History Returns list of actions, performed on this file
ReportsApi reports_get_files_count GET /api/rp/v1/Reports/Folder/{id}/CountFiles Get count of files what contains in a specified folder
ReportsApi reports_get_files_list GET /api/rp/v1/Reports/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.
ReportsApi reports_get_permissions GET /api/rp/v1/Reports/File/{id}/permissions Get all file permissions
ReportsApi reports_move_file POST /api/rp/v1/Reports/File/{id}/Move/{folderId} Move file to a specified folder
ReportsApi reports_move_file_to_bin DELETE /api/rp/v1/Reports/File/{id}/ToBin Move specified file to recycle bin
ReportsApi reports_recover_file POST /api/rp/v1/Reports/File/{id}/Recover Recover specified file from bin
ReportsApi reports_rename_file PUT /api/rp/v1/Reports/File/{id}/Rename Rename a file
ReportsApi reports_static_preview POST /api/rp/v1/Reports/File/{id}/StaticPreview Make 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
ReportsApi reports_update_icon PUT /api/rp/v1/Reports/File/{id}/Icon Update a files's icon
ReportsApi reports_update_permissions POST /api/rp/v1/Reports/File/{id}/permissions Update permissions
ReportsApi reports_update_tags PUT /api/rp/v1/Reports/File/{id}/UpdateTags Update tags
ReportsApi reports_upload_file POST /api/rp/v1/Reports/Folder/{id}/File Upload a file to the specified folder !
SubscriptionGroupsApi subscription_groups_count_groups_async GET /api/manage/v1/Subscriptions/{subscriptionId}/count Returns a number of groups in subscription
SubscriptionGroupsApi subscription_groups_get_groups_list GET /api/manage/v1/Subscriptions/{subscriptionId}/groups returns groups of the subscription or subscription user
SubscriptionInvitesApi subscription_invites_accept_invite GET /api/manage/v1/Subscriptions/{subscriptionId}/invite/{accessToken}/accept Add a user to the subscription using invite, the added users will be displayed in the list of users of the subscription, and these users will also have an active subscription.
SubscriptionInvitesApi subscription_invites_create_invite POST /api/manage/v1/Subscriptions/{subscriptionId}/invite Create invite to subscription
SubscriptionInvitesApi subscription_invites_delete_invite DELETE /api/manage/v1/Subscriptions/{subscriptionId}/invite/{accesstoken} Rename subscription
SubscriptionInvitesApi subscription_invites_get_invites GET /api/manage/v1/Subscriptions/{subscriptionId}/invites Get 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.
SubscriptionPlansApi subscription_plans_get_subscription_plan GET /api/manage/v1/SubscriptionPlans/{id} Returns a subscription plan. Not all subscriptions can be issued for customer.
SubscriptionPlansApi subscription_plans_get_subscription_plans GET /api/manage/v1/SubscriptionPlans Returns a list of active subscription plans that can be issued to the user.
SubscriptionUsersApi subscription_users_add_user PUT /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.
SubscriptionUsersApi subscription_users_count_users_async GET /api/manage/v1/Subscriptions/{subscriptionId}/UsersCount Returns a number of users in subscription
SubscriptionUsersApi subscription_users_get_users GET /api/manage/v1/Subscriptions/{subscriptionId}/users Returns all users of subscription
SubscriptionUsersApi subscription_users_leave_subscripiton DELETE /api/manage/v1/Subscriptions/{subscriptionId}/leave Allows user to leave subscription,.
SubscriptionUsersApi subscription_users_remove_user DELETE /api/manage/v1/Subscriptions/{subscriptionId}/users/{userId} Delete a user from 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.
SubscriptionsApi subscriptions_get_default_permissions GET /api/manage/v1/Subscriptions/{subscriptionId}/defaultPermissions Get subscription's default permissions for new entities
SubscriptionsApi subscriptions_get_my_permissions GET /api/manage/v1/Subscriptions/{subId}/mypermissions Get user's permissions for a subscription by id
SubscriptionsApi subscriptions_get_permissions GET /api/manage/v1/Subscriptions/{id}/permissions Get permissions for a subscription by id
SubscriptionsApi subscriptions_get_subscription GET /api/manage/v1/Subscriptions/{id} Returns the subscription by id
SubscriptionsApi subscriptions_get_subscriptions GET /api/manage/v1/Subscriptions Returns a list of all subscriptions of current user
SubscriptionsApi subscriptions_rename_subscription PUT /api/manage/v1/Subscriptions/{subscriptionId}/rename Rename subscription
SubscriptionsApi subscriptions_update_default_permissions PUT /api/manage/v1/Subscriptions/{subscriptionId}/defaultPermissions Change subscription's default permissions for new entities
SubscriptionsApi subscriptions_update_locale PUT /api/manage/v1/Subscriptions/{subscriptionId}/Locale Update subscription's default locale
SubscriptionsApi subscriptions_update_permissions POST /api/manage/v1/Subscriptions/{id}/permissions Update permissions
TasksApi tasks_create_task POST /api/tasks/v1/Tasks Create a new task
TasksApi tasks_delete_task DELETE /api/tasks/v1/Tasks/{taskId} Delete a task from a storage
TasksApi tasks_get GET /api/tasks/v1/Tasks/{taskId} Get a task by a specified id
TasksApi tasks_get_list GET /api/tasks/v1/Tasks Get tasks list
TasksApi tasks_get_permissions GET /api/tasks/v1/Tasks/{id}/permissions Get all Task permissions
TasksApi tasks_rename_task PUT /api/tasks/v1/Tasks/{taskId}/rename Rename a task
TasksApi tasks_run_task POST /api/tasks/v1/Tasks/run Run a task from request body
TasksApi tasks_run_task_by_id POST /api/tasks/v1/Tasks/{taskId}/run Run a task by id
TasksApi tasks_update_permissions POST /api/tasks/v1/Tasks/{id}/permissions Update permissions
TasksApi tasks_update_task PUT /api/tasks/v1/Tasks/{taskId} Update a task
TemplatesApi template_folder_and_file_clear_recycle_bin DELETE /api/rp/v1/Templates/{subscriptionId}/ClearRecycleBin Delete all folders and files from recycle bin
TemplatesApi template_folder_and_file_delete_files POST /api/rp/v1/Templates/{subscriptionId}/DeleteFiles Delete folders and files
TemplatesApi template_folder_and_file_get_count GET /api/rp/v1/Templates/Folder/{id}/CountFolderAndFiles Get count of files and folders what contains in a specified folder
TemplatesApi template_folder_and_file_get_folders_and_files GET /api/rp/v1/Templates/Folder/{id}/ListFolderAndFiles Get all folders and files from specified folder
TemplatesApi template_folder_and_file_get_recycle_bin_folders_and_files GET /api/rp/v1/Templates/{subscriptionId}/ListRecycleBinFolderAndFiles Get all folders and files from recycle bin
TemplatesApi template_folder_and_file_move_files_to_bin POST /api/rp/v1/Templates/{subscriptionId}/ToBin Move folders and files to bin
TemplatesApi template_folder_and_file_recover_all_from_recycle_bin POST /api/rp/v1/Templates/{subscriptionId}/RecoverRecycleBin Recover all folders and files from recycle bin
TemplatesApi template_folder_and_file_recover_files POST /api/rp/v1/Templates/{subscriptionId}/RecoverFiles Recover folders and files from bin
TemplatesApi template_folders_calculate_folder_size GET /api/rp/v1/Templates/Folder/{id}/size Get specified folder, calculate it's size
TemplatesApi template_folders_copy_folder POST /api/rp/v1/Templates/Folder/{id}/Copy/{folderId} Move folder to a specified folder
TemplatesApi template_folders_delete_folder DELETE /api/rp/v1/Templates/Folder/{id} Delete specified folder
TemplatesApi template_folders_export POST /api/rp/v1/Templates/Folder/{id}/Export Export specified template folder to a specified format
TemplatesApi template_folders_get_breadcrumbs GET /api/rp/v1/Templates/Folder/{id}/Breadcrumbs Get specified folder breadcrumbs
TemplatesApi template_folders_get_folder GET /api/rp/v1/Templates/Folder/{id} Get specified folder
TemplatesApi template_folders_get_folders GET /api/rp/v1/Templates/Folder/{id}/ListFolders Get all folders from specified folder
TemplatesApi template_folders_get_folders_count GET /api/rp/v1/Templates/Folder/{id}/CountFolders Get count of folders what contains in a specified folder
TemplatesApi template_folders_get_or_create GET /api/rp/v1/Templates/Folder/getOrCreate Get specified folder
TemplatesApi template_folders_get_permissions GET /api/rp/v1/Templates/Folder/{id}/permissions Get all folder permissions
TemplatesApi template_folders_get_root_folder GET /api/rp/v1/Templates/Root Get user's root folder (without parents)
TemplatesApi template_folders_move_folder POST /api/rp/v1/Templates/Folder/{id}/Move/{folderId} Move folder to a specified folder
TemplatesApi template_folders_move_folder_to_bin DELETE /api/rp/v1/Templates/Folder/{id}/ToBin Move specified folder to recycle bin
TemplatesApi template_folders_post_folder POST /api/rp/v1/Templates/Folder/{id}/Folder Create folder
TemplatesApi template_folders_prepare POST /api/rp/v1/Templates/Folder/{id}/Prepare Prepare specified template folder to report folder
TemplatesApi template_folders_recover_folder POST /api/rp/v1/Templates/Folder/{id}/Recover Recover specified folder
TemplatesApi template_folders_rename_folder PUT /api/rp/v1/Templates/Folder/{id}/Rename Rename a folder
TemplatesApi template_folders_update_icon PUT /api/rp/v1/Templates/Folder/{id}/Icon Update a folder's icon
TemplatesApi template_folders_update_permissions POST /api/rp/v1/Templates/{id}/permissions Update permissions
TemplatesApi template_folders_update_tags PUT /api/rp/v1/Templates/Folder/{id}/UpdateTags Update tags
TemplatesApi templates_copy_file POST /api/rp/v1/Templates/File/{id}/Copy/{folderId} Copy file to a specified folder
TemplatesApi templates_delete_file DELETE /api/rp/v1/Templates/File/{id} Delete specified file
TemplatesApi templates_export POST /api/rp/v1/Templates/File/{id}/Export Export specified report template to a specified format
TemplatesApi templates_get_file GET /api/rp/v1/Templates/File/{id} Get specified file
TemplatesApi templates_get_file_history GET /api/rp/v1/Templates/File/{id}/History Returns list of actions, performed on this file
TemplatesApi templates_get_files_count GET /api/rp/v1/Templates/Folder/{id}/CountFiles Get count of files what contains in a specified folder
TemplatesApi templates_get_files_list GET /api/rp/v1/Templates/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.
TemplatesApi templates_get_permissions GET /api/rp/v1/Templates/File/{id}/permissions Get all file permissions
TemplatesApi templates_move_file POST /api/rp/v1/Templates/File/{id}/Move/{folderId} Move file to a specified folder
TemplatesApi templates_move_file_to_bin DELETE /api/rp/v1/Templates/File/{id}/ToBin Move specified file to recycle bin
TemplatesApi templates_prepare POST /api/rp/v1/Templates/File/{id}/Prepare Prepare specified template to report
TemplatesApi templates_recover_file POST /api/rp/v1/Templates/File/{id}/Recover Recover specified file from bin
TemplatesApi templates_rename_file PUT /api/rp/v1/Templates/File/{id}/Rename Rename a file
TemplatesApi templates_static_preview POST /api/rp/v1/Templates/File/{id}/StaticPreview Make 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
TemplatesApi templates_update_content PUT /api/rp/v1/Templates/File/{id}/Content Updates contnet of the template
TemplatesApi templates_update_icon PUT /api/rp/v1/Templates/File/{id}/Icon Update a files's icon
TemplatesApi templates_update_permissions POST /api/rp/v1/Templates/File/{id}/permissions Update permissions
TemplatesApi templates_update_tags PUT /api/rp/v1/Templates/File/{id}/UpdateTags Update tags
TemplatesApi templates_upload_file POST /api/rp/v1/Templates/Folder/{id}/File Upload a file to the specified folder !
UserNotificationsApi user_notifications_clear_notifications DELETE /api/manage/v1/notifications Use this endpoint to &quot;clear&quot; your notifications
UserNotificationsApi user_notifications_get_notifications GET /api/manage/v1/notifications Use this endpoint to recieve notifications
UserProfileApi user_profile_get_my_profile GET /api/manage/v1/UserProfile Return current profile of the current user
UserProfileApi user_profile_get_user_profile GET /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)
UserProfileApi user_profile_update_my_profile PUT /api/manage/v1/UserProfile Update profile of the current user
UserSettingsApi user_settings_accept_agreements POST /api/manage/v1/UserSettings/accept Use this endpoint to accept current version of service license agreement
UserSettingsApi user_settings_get_current_user_settings GET /api/manage/v1/UserSettings Return current user settings.
UserSettingsApi user_settings_update_my_settings PUT /api/manage/v1/UserSettings Update settings of the current user

Documentation For Models

Documentation For Authorization

JWT

  • Type: Bearer authentication (JWT)

ApiKey

  • Type: HTTP basic authentication

Author

https://www.fast-report.com/en/

About

No description, website, or topics provided.

Resources

Readme

License

MIT license
Activity
Custom properties

Stars

2 stars

Watchers

3 watching

Forks

2 forks
Report repository

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •  

Languages