Skip to content

FastReports/FastReport-Cloud-JS

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
.openapi-generator
.openapi-generator
 
 
docs
docs
 
 
src
src
 
 
test
test
 
 
.babelrc
.babelrc
 
 
.gitignore
.gitignore
 
 
.openapi-generator-ignore
.openapi-generator-ignore
 
 
.travis.yml
.travis.yml
 
 
LICENSE
LICENSE
 
 
README.md
README.md
 
 
VERSION
VERSION
 
 
git_push.sh
git_push.sh
 
 
mocha.opts
mocha.opts
 
 
package.json
package.json
 
 

Repository files navigation

fastreport-cloud-sdk

FastreportCloudSdk - JavaScript client for fastreport-cloud-sdk No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) This SDK is automatically generated by the OpenAPI Generator project:

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

Installation

Install it via npm:

npm install git+https://github.com/FastReports/FastReport-Cloud-JS.git

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually use this library):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var FastreportCloudSdk = require('fastreport-cloud-sdk');

var api_client = FastreportCloudSdk.ApiClient.instance;
api_client.basePath = "https://fastreport.cloud";
var ApiKey = api_client.authentications['ApiKey'];
ApiKey.username = 'apikey';
ApiKey.password = '????????????????????????????????????????????????????';

let apiInstance = new FastreportCloudSdk.UserProfileApi(api_client);
apiInstance.userProfileGetMyProfile().then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
FastreportCloudSdk.ApiKeysApi apiKeysCreateApiKey POST /api/manage/v1/ApiKeys Create a new apikey, 5 apikeys for user. Hardcoded for ddos.
FastreportCloudSdk.ApiKeysApi apiKeysDeleteApiKey DELETE /api/manage/v1/ApiKeys Delete an apikey
FastreportCloudSdk.ApiKeysApi apiKeysGetApiKeys GET /api/manage/v1/ApiKeys Returns list with all apikeys of current user
FastreportCloudSdk.ConfigurationApi configurationGet GET /api/v1/Configuration returns information about server configuration
FastreportCloudSdk.ContactGroupsApi contactGroupsCreate POST /api/v1/ContactGroups/group Creates contact group
FastreportCloudSdk.ContactGroupsApi contactGroupsDelete DELETE /api/v1/ContactGroups/{id} Removes contact by id
FastreportCloudSdk.ContactGroupsApi contactGroupsGet GET /api/v1/ContactGroups/{id} Returns contact group by id
FastreportCloudSdk.ContactGroupsApi contactGroupsGetList GET /api/v1/ContactGroups/subscription/{subscriptionId}/groups Returns contact groups by subscriptionId
FastreportCloudSdk.ContactGroupsApi contactGroupsUpdate PUT /api/v1/ContactGroups/{id} Updates contact group by id
FastreportCloudSdk.ContactsApi contactsCreate POST /api/v1/Contacts/contact Creates new contact
FastreportCloudSdk.ContactsApi contactsDelete DELETE /api/v1/Contacts/{id} Removes contact by id
FastreportCloudSdk.ContactsApi contactsGet GET /api/v1/Contacts/{id} Returns contact group by id
FastreportCloudSdk.ContactsApi contactsGetByGroup GET /api/v1/Contacts/group/{groupId}/contacts Returns contacts by group id
FastreportCloudSdk.ContactsApi contactsGetList GET /api/v1/Contacts/subscription/{subscriptionId}/contacts Allows to search for contacts
FastreportCloudSdk.ContactsApi contactsUpdate PUT /api/v1/Contacts/{id} Updates contact by id
FastreportCloudSdk.DataSourcesApi dataSourcesCountDataSourcesAsync GET /api/data/v1/DataSources/{subscriptionId}/count Returns a number of data sources in subscription
FastreportCloudSdk.DataSourcesApi dataSourcesCreateDataSource POST /api/data/v1/DataSources Create new data source
FastreportCloudSdk.DataSourcesApi dataSourcesDeleteDataSource DELETE /api/data/v1/DataSources/{id} Delete data source by id
FastreportCloudSdk.DataSourcesApi dataSourcesFetchData GET /api/data/v1/DataSources/{id}/fetch This should connect to a database and set data structure
FastreportCloudSdk.DataSourcesApi dataSourcesGetAvailableDataSources 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.
FastreportCloudSdk.DataSourcesApi dataSourcesGetDataSource GET /api/data/v1/DataSources/{id} Get data source by id
FastreportCloudSdk.DataSourcesApi dataSourcesGetParameterTypes GET /api/data/v1/DataSources/parameterTypes/{dataSourceType} Get data source parameter DataType's
FastreportCloudSdk.DataSourcesApi dataSourcesGetPermissions GET /api/data/v1/DataSources/{id}/permissions Get all Data source permissions
FastreportCloudSdk.DataSourcesApi dataSourcesRenameDataSource PUT /api/data/v1/DataSources/{id}/rename Rename data source by id
FastreportCloudSdk.DataSourcesApi dataSourcesUpdateConnectionString PUT /api/data/v1/DataSources/{id}/connectionString Update data source's connection string by id
FastreportCloudSdk.DataSourcesApi dataSourcesUpdatePermissions POST /api/data/v1/DataSources/{id}/permissions Update permissions
FastreportCloudSdk.DataSourcesApi dataSourcesUpdateSelectCommands PUT /api/data/v1/DataSources/{id}/selectCommands Update data source's select commands by id
FastreportCloudSdk.DataSourcesApi dataSourcesUpdateSubscriptionDataSource PUT /api/data/v1/DataSources/{id}/updateSubscription Update data source's subscription
FastreportCloudSdk.DownloadApi downloadGetExport GET /download/e/{id} Returns a export file with specified id
FastreportCloudSdk.DownloadApi downloadGetExportThumbnail GET /download/e/{id}/thumbnail Returns export's thumbnail
FastreportCloudSdk.DownloadApi downloadGetExports GET /download/es/{archiveName} Returns a zip archive with selected ids
FastreportCloudSdk.DownloadApi downloadGetLastSVGExport GET /download/lastPreview/{reportId} returns export, that was created from report with specified id. INTERNAL USAGE ONLY!
FastreportCloudSdk.DownloadApi downloadGetReport GET /download/r/{id} Returns a prepared file with specified id
FastreportCloudSdk.DownloadApi downloadGetReportThumbnail GET /download/r/{id}/thumbnail Returns report's thumbnail
FastreportCloudSdk.DownloadApi downloadGetReports GET /download/rs/{archiveName} Returns a zip archive with selected files
FastreportCloudSdk.DownloadApi downloadGetTemplate GET /download/t/{id} Returns a Template file with specified id
FastreportCloudSdk.DownloadApi downloadGetTemplateThumbnail GET /download/t/{id}/thumbnail Returns template's thumbnail
FastreportCloudSdk.DownloadApi downloadGetTemplates GET /download/ts/{archiveName} Returns a zip archive with selected files
FastreportCloudSdk.ExportsApi exportFolderAndFileClearRecycleBin DELETE /api/rp/v1/Exports/{subscriptionId}/ClearRecycleBin Delete all folders and files from recycle bin
FastreportCloudSdk.ExportsApi exportFolderAndFileCopyFiles POST /api/rp/v1/Exports/{subscriptionId}/CopyFiles Copy folders and files to a specified folder
FastreportCloudSdk.ExportsApi exportFolderAndFileCountRecycleBinFoldersAndFiles GET /api/rp/v1/Exports/{subscriptionId}/CountRecycleBinFolderAndFiles Count all folders and files from recycle bin
FastreportCloudSdk.ExportsApi exportFolderAndFileDeleteFiles POST /api/rp/v1/Exports/{subscriptionId}/DeleteFiles Delete folders and files
FastreportCloudSdk.ExportsApi exportFolderAndFileGetCount GET /api/rp/v1/Exports/Folder/{id}/CountFolderAndFiles Get count of files and folders what contains in a specified folder
FastreportCloudSdk.ExportsApi exportFolderAndFileGetFoldersAndFiles GET /api/rp/v1/Exports/Folder/{id}/ListFolderAndFiles Get all folders and files from specified folder
FastreportCloudSdk.ExportsApi exportFolderAndFileGetRecycleBinFoldersAndFiles GET /api/rp/v1/Exports/{subscriptionId}/ListRecycleBinFolderAndFiles Get all folders and files from recycle bin
FastreportCloudSdk.ExportsApi exportFolderAndFileMoveFiles POST /api/rp/v1/Exports/{subscriptionId}/MoveFiles Move folders and files to a specified folder
FastreportCloudSdk.ExportsApi exportFolderAndFileMoveFilesToBin POST /api/rp/v1/Exports/{subscriptionId}/ToBin Move folders and files to bin
FastreportCloudSdk.ExportsApi exportFolderAndFileRecoverAllFromRecycleBin POST /api/rp/v1/Exports/{subscriptionId}/RecoverRecycleBin Recover all folders and files from recycle bin
FastreportCloudSdk.ExportsApi exportFolderAndFileRecoverFiles POST /api/rp/v1/Exports/{subscriptionId}/RecoverFiles Recover folders and files from bin
FastreportCloudSdk.ExportsApi exportFoldersCalculateFolderSize GET /api/rp/v1/Exports/Folder/{id}/size Get specified folder, calculate it's size
FastreportCloudSdk.ExportsApi exportFoldersCopyFolder POST /api/rp/v1/Exports/Folder/{id}/Copy/{folderId} Move folder to a specified folder
FastreportCloudSdk.ExportsApi exportFoldersDeleteFolder DELETE /api/rp/v1/Exports/Folder/{id} Delete specified folder
FastreportCloudSdk.ExportsApi exportFoldersGetBreadcrumbs GET /api/rp/v1/Exports/Folder/{id}/Breadcrumbs Get specified folder breadcrumbs
FastreportCloudSdk.ExportsApi exportFoldersGetFolder GET /api/rp/v1/Exports/Folder/{id} Get specified folder
FastreportCloudSdk.ExportsApi exportFoldersGetFolders GET /api/rp/v1/Exports/Folder/{id}/ListFolders Get all folders from specified folder
FastreportCloudSdk.ExportsApi exportFoldersGetFoldersCount GET /api/rp/v1/Exports/Folder/{id}/CountFolders Get count of folders what contains in a specified folder
FastreportCloudSdk.ExportsApi exportFoldersGetOrCreate GET /api/rp/v1/Exports/Folder/getOrCreate Get specified folder
FastreportCloudSdk.ExportsApi exportFoldersGetPermissions GET /api/rp/v1/Exports/Folder/{id}/permissions Get all folder permissions
FastreportCloudSdk.ExportsApi exportFoldersGetRootFolder GET /api/rp/v1/Exports/Root Get user's root folder (without parents)
FastreportCloudSdk.ExportsApi exportFoldersMoveFolder POST /api/rp/v1/Exports/Folder/{id}/Move/{folderId} Move folder to a specified folder
FastreportCloudSdk.ExportsApi exportFoldersMoveFolderToBin DELETE /api/rp/v1/Exports/Folder/{id}/ToBin Move specified folder to recycle bin
FastreportCloudSdk.ExportsApi exportFoldersPostFolder POST /api/rp/v1/Exports/Folder/{id}/Folder Create folder
FastreportCloudSdk.ExportsApi exportFoldersRecoverFolder POST /api/rp/v1/Exports/Folder/{id}/Recover Recover specified folder
FastreportCloudSdk.ExportsApi exportFoldersRenameFolder PUT /api/rp/v1/Exports/Folder/{id}/Rename Rename a folder
FastreportCloudSdk.ExportsApi exportFoldersUpdateIcon PUT /api/rp/v1/Exports/Folder/{id}/Icon Update a folder's icon
FastreportCloudSdk.ExportsApi exportFoldersUpdatePermissions POST /api/rp/v1/Exports/{id}/permissions Update permissions
FastreportCloudSdk.ExportsApi exportFoldersUpdateTags PUT /api/rp/v1/Exports/Folder/{id}/UpdateTags Update tags
FastreportCloudSdk.ExportsApi exportsCopyFile POST /api/rp/v1/Exports/File/{id}/Copy/{folderId} Copy file to a specified folder
FastreportCloudSdk.ExportsApi exportsCreateSharingKey POST /api/rp/v1/Exports/File/{id}/sharingKey Create a new key, that can be used to share access to a file (You need Administrate.Anon permission to create a new key)
FastreportCloudSdk.ExportsApi exportsDeleteFile DELETE /api/rp/v1/Exports/File/{id} Delete specified file
FastreportCloudSdk.ExportsApi exportsDeleteSharingKey DELETE /api/rp/v1/Exports/File/{id}/sharingKey Deletes a sharing key, making links, that utilizing it no longer work
FastreportCloudSdk.ExportsApi exportsGetFile GET /api/rp/v1/Exports/File/{id} Get export by specified id
FastreportCloudSdk.ExportsApi exportsGetFileHistory GET /api/rp/v1/Exports/File/{id}/History Returns list of actions, performed on this file
FastreportCloudSdk.ExportsApi exportsGetFilesCount GET /api/rp/v1/Exports/Folder/{id}/CountFiles Get count of files what contains in a specified folder
FastreportCloudSdk.ExportsApi exportsGetFilesList 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.
FastreportCloudSdk.ExportsApi exportsGetPermissions GET /api/rp/v1/Exports/File/{id}/permissions
FastreportCloudSdk.ExportsApi exportsGetSharingKeys GET /api/rp/v1/Exports/File/{id}/sharingKeys Returns all sharing keys, associated with the file
FastreportCloudSdk.ExportsApi exportsMoveFile POST /api/rp/v1/Exports/File/{id}/Move/{folderId} Move file to a specified folder
FastreportCloudSdk.ExportsApi exportsMoveFileToBin DELETE /api/rp/v1/Exports/File/{id}/ToBin Move specified file to recycle bin
FastreportCloudSdk.ExportsApi exportsRecoverFile POST /api/rp/v1/Exports/File/{id}/Recover Recover specified file from bin
FastreportCloudSdk.ExportsApi exportsRenameFile PUT /api/rp/v1/Exports/File/{id}/Rename Rename a file
FastreportCloudSdk.ExportsApi exportsUpdateIcon PUT /api/rp/v1/Exports/File/{id}/Icon Update a files's icon
FastreportCloudSdk.ExportsApi exportsUpdatePermissions POST /api/rp/v1/Exports/File/{id}/permissions Update permissions
FastreportCloudSdk.ExportsApi exportsUpdateTags PUT /api/rp/v1/Exports/File/{id}/UpdateTags Update tags
FastreportCloudSdk.GroupUsersApi groupUsersAddUserToGroup PUT /api/manage/v1/Groups/{id}/Users/{userId} Add user to the group by identifier
FastreportCloudSdk.GroupUsersApi groupUsersGetUsersInGroup GET /api/manage/v1/Groups/{id}/Users Returns users in the group by identifier
FastreportCloudSdk.GroupUsersApi groupUsersLeaveFromGroup DELETE /api/manage/v1/Groups/{id}/leave Leave from the group
FastreportCloudSdk.GroupUsersApi groupUsersRemoveFromGroup DELETE /api/manage/v1/Groups/{id}/Users/{userId} Remove user from the group by identifier
FastreportCloudSdk.GroupsApi groupsCreateGroup POST /api/manage/v1/Groups Create a new user group
FastreportCloudSdk.GroupsApi groupsDeleteGroup DELETE /api/manage/v1/Groups/{id} Delete group by identifier
FastreportCloudSdk.GroupsApi groupsGetGroup GET /api/manage/v1/Groups/{id} Gets group by identifier
FastreportCloudSdk.GroupsApi groupsGetGroupList 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
FastreportCloudSdk.GroupsApi groupsGetPermissions GET /api/manage/v1/Groups/{id}/permissions Gets group permissions by identifier
FastreportCloudSdk.GroupsApi groupsRenameGroup PUT /api/manage/v1/Groups/{id}/rename Rename group by identifier
FastreportCloudSdk.GroupsApi groupsUpdatePermissions POST /api/manage/v1/Groups/{id}/permissions Update permissions
FastreportCloudSdk.HealthCheckApi healthCheckDataGet GET /api/backend/v1/HealthCheck healthcheck
FastreportCloudSdk.ReportsApi reportFolderAndFileClearRecycleBin DELETE /api/rp/v1/Reports/{subscriptionId}/ClearRecycleBin Delete all folders and files from recycle bin
FastreportCloudSdk.ReportsApi reportFolderAndFileCopyFiles POST /api/rp/v1/Reports/{subscriptionId}/CopyFiles Copy folders and files to a specified folder
FastreportCloudSdk.ReportsApi reportFolderAndFileCountRecycleBinFoldersAndFiles GET /api/rp/v1/Reports/{subscriptionId}/CountRecycleBinFolderAndFiles Count all folders and files from recycle bin
FastreportCloudSdk.ReportsApi reportFolderAndFileDeleteFiles POST /api/rp/v1/Reports/{subscriptionId}/DeleteFiles Delete folders and files
FastreportCloudSdk.ReportsApi reportFolderAndFileGetCount GET /api/rp/v1/Reports/Folder/{id}/CountFolderAndFiles Get count of files and folders what contains in a specified folder
FastreportCloudSdk.ReportsApi reportFolderAndFileGetFoldersAndFiles GET /api/rp/v1/Reports/Folder/{id}/ListFolderAndFiles Get all folders and files from specified folder
FastreportCloudSdk.ReportsApi reportFolderAndFileGetRecycleBinFoldersAndFiles GET /api/rp/v1/Reports/{subscriptionId}/ListRecycleBinFolderAndFiles Get all folders and files from recycle bin
FastreportCloudSdk.ReportsApi reportFolderAndFileMoveFiles POST /api/rp/v1/Reports/{subscriptionId}/MoveFiles Move folders and files to a specified folder
FastreportCloudSdk.ReportsApi reportFolderAndFileMoveFilesToBin POST /api/rp/v1/Reports/{subscriptionId}/ToBin Move folders and files to bin
FastreportCloudSdk.ReportsApi reportFolderAndFileRecoverAllFromRecycleBin POST /api/rp/v1/Reports/{subscriptionId}/RecoverRecycleBin Recover all folders and files from recycle bin
FastreportCloudSdk.ReportsApi reportFolderAndFileRecoverFiles POST /api/rp/v1/Reports/{subscriptionId}/RecoverFiles Recover folders and files from bin
FastreportCloudSdk.ReportsApi reportFoldersCalculateFolderSize GET /api/rp/v1/Reports/Folder/{id}/size Get specified folder, calculate it's size
FastreportCloudSdk.ReportsApi reportFoldersCopyFolder POST /api/rp/v1/Reports/Folder/{id}/Copy/{folderId} Move folder to a specified folder
FastreportCloudSdk.ReportsApi reportFoldersDeleteFolder DELETE /api/rp/v1/Reports/Folder/{id} Delete specified folder
FastreportCloudSdk.ReportsApi reportFoldersExport POST /api/rp/v1/Reports/Folder/{id}/Export Export specified report folder to a specified format
FastreportCloudSdk.ReportsApi reportFoldersGetBreadcrumbs GET /api/rp/v1/Reports/Folder/{id}/Breadcrumbs Get specified folder breadcrumbs
FastreportCloudSdk.ReportsApi reportFoldersGetFolder GET /api/rp/v1/Reports/Folder/{id} Get specified folder
FastreportCloudSdk.ReportsApi reportFoldersGetFolders GET /api/rp/v1/Reports/Folder/{id}/ListFolders Get all folders from specified folder
FastreportCloudSdk.ReportsApi reportFoldersGetFoldersCount GET /api/rp/v1/Reports/Folder/{id}/CountFolders Get count of folders what contains in a specified folder
FastreportCloudSdk.ReportsApi reportFoldersGetOrCreate GET /api/rp/v1/Reports/Folder/getOrCreate Get specified folder
FastreportCloudSdk.ReportsApi reportFoldersGetPermissions GET /api/rp/v1/Reports/Folder/{id}/permissions Get all folder permissions
FastreportCloudSdk.ReportsApi reportFoldersGetRootFolder GET /api/rp/v1/Reports/Root Get user's root folder (without parents)
FastreportCloudSdk.ReportsApi reportFoldersMoveFolder POST /api/rp/v1/Reports/Folder/{id}/Move/{folderId} Move folder to a specified folder
FastreportCloudSdk.ReportsApi reportFoldersMoveFolderToBin DELETE /api/rp/v1/Reports/Folder/{id}/ToBin Move specified folder to recycle bin
FastreportCloudSdk.ReportsApi reportFoldersPostFolder POST /api/rp/v1/Reports/Folder/{id}/Folder Create folder
FastreportCloudSdk.ReportsApi reportFoldersRecoverFolder POST /api/rp/v1/Reports/Folder/{id}/Recover Recover specified folder
FastreportCloudSdk.ReportsApi reportFoldersRenameFolder PUT /api/rp/v1/Reports/Folder/{id}/Rename Rename a folder
FastreportCloudSdk.ReportsApi reportFoldersUpdateIcon PUT /api/rp/v1/Reports/Folder/{id}/Icon Update a folder's icon
FastreportCloudSdk.ReportsApi reportFoldersUpdatePermissions POST /api/rp/v1/Reports/{id}/permissions Update permissions
FastreportCloudSdk.ReportsApi reportFoldersUpdateTags PUT /api/rp/v1/Reports/Folder/{id}/UpdateTags Update tags
FastreportCloudSdk.ReportsApi reportsCopyFile POST /api/rp/v1/Reports/File/{id}/Copy/{folderId} Copy file to a specified folder
FastreportCloudSdk.ReportsApi reportsCreateSharingKey POST /api/rp/v1/Reports/File/{id}/sharingKey Create a new key, that can be used to share access to a file (You need Administrate.Anon permission to create a new key)
FastreportCloudSdk.ReportsApi reportsDeleteFile DELETE /api/rp/v1/Reports/File/{id} Delete specified file
FastreportCloudSdk.ReportsApi reportsDeleteSharingKey DELETE /api/rp/v1/Reports/File/{id}/sharingKey Deletes a sharing key, making links, that utilizing it no longer work
FastreportCloudSdk.ReportsApi reportsExport POST /api/rp/v1/Reports/File/{id}/Export Export specified report to a specified format
FastreportCloudSdk.ReportsApi reportsGetFile GET /api/rp/v1/Reports/File/{id} Get specified file
FastreportCloudSdk.ReportsApi reportsGetFileHistory GET /api/rp/v1/Reports/File/{id}/History Returns list of actions, performed on this file
FastreportCloudSdk.ReportsApi reportsGetFilesCount GET /api/rp/v1/Reports/Folder/{id}/CountFiles Get count of files what contains in a specified folder
FastreportCloudSdk.ReportsApi reportsGetFilesList 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.
FastreportCloudSdk.ReportsApi reportsGetPermissions GET /api/rp/v1/Reports/File/{id}/permissions
FastreportCloudSdk.ReportsApi reportsGetSharingKeys GET /api/rp/v1/Reports/File/{id}/sharingKeys Returns all sharing keys, associated with the file
FastreportCloudSdk.ReportsApi reportsMoveFile POST /api/rp/v1/Reports/File/{id}/Move/{folderId} Move file to a specified folder
FastreportCloudSdk.ReportsApi reportsMoveFileToBin DELETE /api/rp/v1/Reports/File/{id}/ToBin Move specified file to recycle bin
FastreportCloudSdk.ReportsApi reportsRecoverFile POST /api/rp/v1/Reports/File/{id}/Recover Recover specified file from bin
FastreportCloudSdk.ReportsApi reportsRenameFile PUT /api/rp/v1/Reports/File/{id}/Rename Rename a file
FastreportCloudSdk.ReportsApi reportsStaticPreview 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
FastreportCloudSdk.ReportsApi reportsUpdateIcon PUT /api/rp/v1/Reports/File/{id}/Icon Update a files's icon
FastreportCloudSdk.ReportsApi reportsUpdatePermissions POST /api/rp/v1/Reports/File/{id}/permissions Update permissions
FastreportCloudSdk.ReportsApi reportsUpdateTags PUT /api/rp/v1/Reports/File/{id}/UpdateTags Update tags
FastreportCloudSdk.ReportsApi reportsUploadFile POST /api/rp/v1/Reports/Folder/{id}/File Upload a file to the specified folder. The method is deprecated, use the UploadFileV2 method instead!
FastreportCloudSdk.ReportsApi reportsUploadFileV2 POST /api/rp/v2/Reports/Folder/{id}/File Alternative api for upload a file to the specified folder!
FastreportCloudSdk.SubscriptionGroupsApi subscriptionGroupsCountGroupsAsync GET /api/manage/v1/Subscriptions/{subscriptionId}/count Returns a number of groups in subscription
FastreportCloudSdk.SubscriptionGroupsApi subscriptionGroupsGetGroupsList GET /api/manage/v1/Subscriptions/{subscriptionId}/groups returns groups of the subscription or subscription user
FastreportCloudSdk.SubscriptionInvitesApi subscriptionInvitesAcceptInvite 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.
FastreportCloudSdk.SubscriptionInvitesApi subscriptionInvitesCreateInvite POST /api/manage/v1/Subscriptions/{subscriptionId}/invite Create invite to subscription
FastreportCloudSdk.SubscriptionInvitesApi subscriptionInvitesDeleteInvite DELETE /api/manage/v1/Subscriptions/{subscriptionId}/invite/{accesstoken} Delete invite with specified token
FastreportCloudSdk.SubscriptionInvitesApi subscriptionInvitesGetInvites 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.
FastreportCloudSdk.SubscriptionPlansApi subscriptionPlansGetSubscriptionPlan GET /api/manage/v1/SubscriptionPlans/{id} Returns a subscription plan. Not all subscriptions can be issued for customer.
FastreportCloudSdk.SubscriptionPlansApi subscriptionPlansGetSubscriptionPlans GET /api/manage/v1/SubscriptionPlans Returns a list of active subscription plans that can be issued to the user.
FastreportCloudSdk.SubscriptionUsersApi subscriptionUsersAddUser 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.
FastreportCloudSdk.SubscriptionUsersApi subscriptionUsersCountUsersAsync GET /api/manage/v1/Subscriptions/{subscriptionId}/UsersCount Returns a number of users in subscription
FastreportCloudSdk.SubscriptionUsersApi subscriptionUsersGetUsers GET /api/manage/v1/Subscriptions/{subscriptionId}/users Returns all users of subscription
FastreportCloudSdk.SubscriptionUsersApi subscriptionUsersLeaveSubscripiton DELETE /api/manage/v1/Subscriptions/{subscriptionId}/leave Allows user to leave subscription,.
FastreportCloudSdk.SubscriptionUsersApi subscriptionUsersRemoveUser 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.
FastreportCloudSdk.SubscriptionsApi subscriptionsGetDefaultPermissions GET /api/manage/v1/Subscriptions/{subscriptionId}/defaultPermissions Get subscription's default permissions for new entities
FastreportCloudSdk.SubscriptionsApi subscriptionsGetMyPermissions GET /api/manage/v1/Subscriptions/{subId}/mypermissions Get user's permissions for a subscription by id
FastreportCloudSdk.SubscriptionsApi subscriptionsGetPermissions GET /api/manage/v1/Subscriptions/{id}/permissions Get permissions for a subscription by id
FastreportCloudSdk.SubscriptionsApi subscriptionsGetSubscription GET /api/manage/v1/Subscriptions/{id} Returns the subscription by id
FastreportCloudSdk.SubscriptionsApi subscriptionsGetSubscriptions GET /api/manage/v1/Subscriptions Returns a list of all subscriptions of current user
FastreportCloudSdk.SubscriptionsApi subscriptionsRenameSubscription PUT /api/manage/v1/Subscriptions/{subscriptionId}/rename Rename subscription
FastreportCloudSdk.SubscriptionsApi subscriptionsUpdateDefaultPermissions PUT /api/manage/v1/Subscriptions/{subscriptionId}/defaultPermissions Change subscription's default permissions for new entities
FastreportCloudSdk.SubscriptionsApi subscriptionsUpdateLocale PUT /api/manage/v1/Subscriptions/{subscriptionId}/Locale Update subscription's default locale
FastreportCloudSdk.SubscriptionsApi subscriptionsUpdatePermissions POST /api/manage/v1/Subscriptions/{id}/permissions Update permissions
FastreportCloudSdk.TasksApi tasksCreateTask POST /api/tasks/v1/Tasks Create a new task
FastreportCloudSdk.TasksApi tasksDeleteTask DELETE /api/tasks/v1/Tasks/{taskId} Delete a task from a storage
FastreportCloudSdk.TasksApi tasksGet GET /api/tasks/v1/Tasks/{taskId} Get a task by a specified id
FastreportCloudSdk.TasksApi tasksGetList GET /api/tasks/v1/Tasks Get tasks list
FastreportCloudSdk.TasksApi tasksGetPermissions GET /api/tasks/v1/Tasks/{id}/permissions Get all Task permissions
FastreportCloudSdk.TasksApi tasksRenameTask PUT /api/tasks/v1/Tasks/{taskId}/rename Rename a task
FastreportCloudSdk.TasksApi tasksRunTask POST /api/tasks/v1/Tasks/run Run a task from request body
FastreportCloudSdk.TasksApi tasksRunTaskById POST /api/tasks/v1/Tasks/{taskId}/run Run a task by id
FastreportCloudSdk.TasksApi tasksUpdatePermissions POST /api/tasks/v1/Tasks/{id}/permissions Update permissions
FastreportCloudSdk.TasksApi tasksUpdateTask PUT /api/tasks/v1/Tasks/{taskId} Update a task
FastreportCloudSdk.TemplatesApi templateFolderAndFileClearRecycleBin DELETE /api/rp/v1/Templates/{subscriptionId}/ClearRecycleBin Delete all folders and files from recycle bin
FastreportCloudSdk.TemplatesApi templateFolderAndFileCopyFiles POST /api/rp/v1/Templates/{subscriptionId}/CopyFiles Copy folders and files to a specified folder
FastreportCloudSdk.TemplatesApi templateFolderAndFileCountRecycleBinFoldersAndFiles GET /api/rp/v1/Templates/{subscriptionId}/CountRecycleBinFolderAndFiles Count all folders and files from recycle bin
FastreportCloudSdk.TemplatesApi templateFolderAndFileDeleteFiles POST /api/rp/v1/Templates/{subscriptionId}/DeleteFiles Delete folders and files
FastreportCloudSdk.TemplatesApi templateFolderAndFileGetCount GET /api/rp/v1/Templates/Folder/{id}/CountFolderAndFiles Get count of files and folders what contains in a specified folder
FastreportCloudSdk.TemplatesApi templateFolderAndFileGetFoldersAndFiles GET /api/rp/v1/Templates/Folder/{id}/ListFolderAndFiles Get all folders and files from specified folder
FastreportCloudSdk.TemplatesApi templateFolderAndFileGetRecycleBinFoldersAndFiles GET /api/rp/v1/Templates/{subscriptionId}/ListRecycleBinFolderAndFiles Get all folders and files from recycle bin
FastreportCloudSdk.TemplatesApi templateFolderAndFileMoveFiles POST /api/rp/v1/Templates/{subscriptionId}/MoveFiles Move folders and files to a specified folder
FastreportCloudSdk.TemplatesApi templateFolderAndFileMoveFilesToBin POST /api/rp/v1/Templates/{subscriptionId}/ToBin Move folders and files to bin
FastreportCloudSdk.TemplatesApi templateFolderAndFileRecoverAllFromRecycleBin POST /api/rp/v1/Templates/{subscriptionId}/RecoverRecycleBin Recover all folders and files from recycle bin
FastreportCloudSdk.TemplatesApi templateFolderAndFileRecoverFiles POST /api/rp/v1/Templates/{subscriptionId}/RecoverFiles Recover folders and files from bin
FastreportCloudSdk.TemplatesApi templateFoldersCalculateFolderSize GET /api/rp/v1/Templates/Folder/{id}/size Get specified folder, calculate it's size
FastreportCloudSdk.TemplatesApi templateFoldersCopyFolder POST /api/rp/v1/Templates/Folder/{id}/Copy/{folderId} Move folder to a specified folder
FastreportCloudSdk.TemplatesApi templateFoldersDeleteFolder DELETE /api/rp/v1/Templates/Folder/{id} Delete specified folder
FastreportCloudSdk.TemplatesApi templateFoldersExport POST /api/rp/v1/Templates/Folder/{id}/Export Export specified template folder to a specified format
FastreportCloudSdk.TemplatesApi templateFoldersGetBreadcrumbs GET /api/rp/v1/Templates/Folder/{id}/Breadcrumbs Get specified folder breadcrumbs
FastreportCloudSdk.TemplatesApi templateFoldersGetFolder GET /api/rp/v1/Templates/Folder/{id} Get specified folder
FastreportCloudSdk.TemplatesApi templateFoldersGetFolders GET /api/rp/v1/Templates/Folder/{id}/ListFolders Get all folders from specified folder
FastreportCloudSdk.TemplatesApi templateFoldersGetFoldersCount GET /api/rp/v1/Templates/Folder/{id}/CountFolders Get count of folders what contains in a specified folder
FastreportCloudSdk.TemplatesApi templateFoldersGetOrCreate GET /api/rp/v1/Templates/Folder/getOrCreate Get specified folder
FastreportCloudSdk.TemplatesApi templateFoldersGetPermissions GET /api/rp/v1/Templates/Folder/{id}/permissions Get all folder permissions
FastreportCloudSdk.TemplatesApi templateFoldersGetRootFolder GET /api/rp/v1/Templates/Root Get user's root folder (without parents)
FastreportCloudSdk.TemplatesApi templateFoldersMoveFolder POST /api/rp/v1/Templates/Folder/{id}/Move/{folderId} Move folder to a specified folder
FastreportCloudSdk.TemplatesApi templateFoldersMoveFolderToBin DELETE /api/rp/v1/Templates/Folder/{id}/ToBin Move specified folder to recycle bin
FastreportCloudSdk.TemplatesApi templateFoldersPostFolder POST /api/rp/v1/Templates/Folder/{id}/Folder Create folder
FastreportCloudSdk.TemplatesApi templateFoldersPrepare POST /api/rp/v1/Templates/Folder/{id}/Prepare Prepare specified template folder to report folder
FastreportCloudSdk.TemplatesApi templateFoldersRecoverFolder POST /api/rp/v1/Templates/Folder/{id}/Recover Recover specified folder
FastreportCloudSdk.TemplatesApi templateFoldersRenameFolder PUT /api/rp/v1/Templates/Folder/{id}/Rename Rename a folder
FastreportCloudSdk.TemplatesApi templateFoldersUpdateIcon PUT /api/rp/v1/Templates/Folder/{id}/Icon Update a folder's icon
FastreportCloudSdk.TemplatesApi templateFoldersUpdatePermissions POST /api/rp/v1/Templates/{id}/permissions Update permissions
FastreportCloudSdk.TemplatesApi templateFoldersUpdateTags PUT /api/rp/v1/Templates/Folder/{id}/UpdateTags Update tags
FastreportCloudSdk.TemplatesApi templatesCopyFile POST /api/rp/v1/Templates/File/{id}/Copy/{folderId} Copy file to a specified folder
FastreportCloudSdk.TemplatesApi templatesCreateSharingKey POST /api/rp/v1/Templates/File/{id}/sharingKey Create a new key, that can be used to share access to a file (You need Administrate.Anon permission to create a new key)
FastreportCloudSdk.TemplatesApi templatesDeleteFile DELETE /api/rp/v1/Templates/File/{id} Delete specified file
FastreportCloudSdk.TemplatesApi templatesDeleteSharingKey DELETE /api/rp/v1/Templates/File/{id}/sharingKey Deletes a sharing key, making links, that utilizing it no longer work
FastreportCloudSdk.TemplatesApi templatesExport POST /api/rp/v1/Templates/File/{id}/Export Export specified report template to a specified format
FastreportCloudSdk.TemplatesApi templatesGetFile GET /api/rp/v1/Templates/File/{id} Get specified file
FastreportCloudSdk.TemplatesApi templatesGetFileHistory GET /api/rp/v1/Templates/File/{id}/History Returns list of actions, performed on this file
FastreportCloudSdk.TemplatesApi templatesGetFilesCount GET /api/rp/v1/Templates/Folder/{id}/CountFiles Get count of files what contains in a specified folder
FastreportCloudSdk.TemplatesApi templatesGetFilesList 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.
FastreportCloudSdk.TemplatesApi templatesGetPermissions GET /api/rp/v1/Templates/File/{id}/permissions
FastreportCloudSdk.TemplatesApi templatesGetSharingKeys GET /api/rp/v1/Templates/File/{id}/sharingKeys Returns all sharing keys, associated with the file
FastreportCloudSdk.TemplatesApi templatesMoveFile POST /api/rp/v1/Templates/File/{id}/Move/{folderId} Move file to a specified folder
FastreportCloudSdk.TemplatesApi templatesMoveFileToBin DELETE /api/rp/v1/Templates/File/{id}/ToBin Move specified file to recycle bin
FastreportCloudSdk.TemplatesApi templatesPrepare POST /api/rp/v1/Templates/File/{id}/Prepare Prepare specified template to report
FastreportCloudSdk.TemplatesApi templatesRecoverFile POST /api/rp/v1/Templates/File/{id}/Recover Recover specified file from bin
FastreportCloudSdk.TemplatesApi templatesRenameFile PUT /api/rp/v1/Templates/File/{id}/Rename Rename a file
FastreportCloudSdk.TemplatesApi templatesStaticPreview 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
FastreportCloudSdk.TemplatesApi templatesUpdateContent PUT /api/rp/v1/Templates/File/{id}/Content Updates contnet of the template. The method is deprecated, use the UpdateContentV2 method instead!
FastreportCloudSdk.TemplatesApi templatesUpdateContentV2 PUT /api/rp/v2/Templates/File/{id}/Content Updates contnet of the template.
FastreportCloudSdk.TemplatesApi templatesUpdateIcon PUT /api/rp/v1/Templates/File/{id}/Icon Update a files's icon
FastreportCloudSdk.TemplatesApi templatesUpdatePermissions POST /api/rp/v1/Templates/File/{id}/permissions Update permissions
FastreportCloudSdk.TemplatesApi templatesUpdateTags PUT /api/rp/v1/Templates/File/{id}/UpdateTags Update tags
FastreportCloudSdk.TemplatesApi templatesUploadFile POST /api/rp/v1/Templates/Folder/{id}/File Upload a file to the specified folder. The method is deprecated, use the UploadFileV2 method instead!
FastreportCloudSdk.TemplatesApi templatesUploadFileV2 POST /api/rp/v2/Templates/Folder/{id}/File Alternative api for upload a file to the specified folder!
FastreportCloudSdk.UserNotificationsApi userNotificationsClearNotifications DELETE /api/manage/v1/notifications Use this endpoint to &quot;clear&quot; your notifications
FastreportCloudSdk.UserNotificationsApi userNotificationsGetNotifications GET /api/manage/v1/notifications Use this endpoint to recieve notifications
FastreportCloudSdk.UserProfileApi userProfileGetMyProfile GET /api/manage/v1/UserProfile Return current profile of the current user
FastreportCloudSdk.UserProfileApi userProfileGetUserProfile 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)
FastreportCloudSdk.UserProfileApi userProfileUpdateMyProfile PUT /api/manage/v1/UserProfile Update profile of the current user
FastreportCloudSdk.UserSettingsApi userSettingsAcceptAgreements POST /api/manage/v1/UserSettings/accept Use this endpoint to accept current version of service license agreement
FastreportCloudSdk.UserSettingsApi userSettingsGetCurrentUserSettings GET /api/manage/v1/UserSettings Return current user settings.
FastreportCloudSdk.UserSettingsApi userSettingsUpdateMySettings 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

5 stars

Watchers

4 watching

Forks

1 fork
Report repository

Releases

No releases published

Packages

No packages published

Languages