Skip to content

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:

varFastreportCloudSdk=require('fastreport-cloud-sdk');varapi_client=FastreportCloudSdk.ApiClient.instance;api_client.basePath="https://fastreport.cloud";varApiKey=api_client.authentications['ApiKey'];ApiKey.username='apikey';ApiKey.password='????????????????????????????????????????????????????';letapiInstance=newFastreportCloudSdk.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

ClassMethodHTTP requestDescription
FastreportCloudSdk.ApiKeysApiapiKeysCreateApiKeyPOST /api/manage/v1/ApiKeysCreate a new apikey, 5 apikeys for user. Hardcoded for ddos.
FastreportCloudSdk.ApiKeysApiapiKeysDeleteApiKeyDELETE /api/manage/v1/ApiKeysDelete an apikey
FastreportCloudSdk.ApiKeysApiapiKeysGetApiKeysGET /api/manage/v1/ApiKeysReturns list with all apikeys of current user
FastreportCloudSdk.ConfigurationApiconfigurationGetGET /api/v1/Configurationreturns information about server configuration
FastreportCloudSdk.ContactGroupsApicontactGroupsCreatePOST /api/v1/ContactGroups/groupCreates contact group
FastreportCloudSdk.ContactGroupsApicontactGroupsDeleteDELETE /api/v1/ContactGroups/{id}Removes contact by id
FastreportCloudSdk.ContactGroupsApicontactGroupsGetGET /api/v1/ContactGroups/{id}Returns contact group by id
FastreportCloudSdk.ContactGroupsApicontactGroupsGetListGET /api/v1/ContactGroups/subscription/{subscriptionId}/groupsReturns contact groups by subscriptionId
FastreportCloudSdk.ContactGroupsApicontactGroupsUpdatePUT /api/v1/ContactGroups/{id}Updates contact group by id
FastreportCloudSdk.ContactsApicontactsCreatePOST /api/v1/Contacts/contactCreates new contact
FastreportCloudSdk.ContactsApicontactsDeleteDELETE /api/v1/Contacts/{id}Removes contact by id
FastreportCloudSdk.ContactsApicontactsGetGET /api/v1/Contacts/{id}Returns contact group by id
FastreportCloudSdk.ContactsApicontactsGetByGroupGET /api/v1/Contacts/group/{groupId}/contactsReturns contacts by group id
FastreportCloudSdk.ContactsApicontactsGetListGET /api/v1/Contacts/subscription/{subscriptionId}/contactsAllows to search for contacts
FastreportCloudSdk.ContactsApicontactsUpdatePUT /api/v1/Contacts/{id}Updates contact by id
FastreportCloudSdk.DataSourcesApidataSourcesCountDataSourcesAsyncGET /api/data/v1/DataSources/{subscriptionId}/countReturns a number of data sources in subscription
FastreportCloudSdk.DataSourcesApidataSourcesCreateDataSourcePOST /api/data/v1/DataSourcesCreate new data source
FastreportCloudSdk.DataSourcesApidataSourcesDeleteDataSourceDELETE /api/data/v1/DataSources/{id}Delete data source by id
FastreportCloudSdk.DataSourcesApidataSourcesFetchDataGET /api/data/v1/DataSources/{id}/fetchThis should connect to a database and set data structure
FastreportCloudSdk.DataSourcesApidataSourcesGetAvailableDataSourcesGET /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.
FastreportCloudSdk.DataSourcesApidataSourcesGetDataSourceGET /api/data/v1/DataSources/{id}Get data source by id
FastreportCloudSdk.DataSourcesApidataSourcesGetMyPermissionsGET /api/data/v1/DataSources/{id}/mypermissionsGet current user's permissions to Data source
FastreportCloudSdk.DataSourcesApidataSourcesGetParameterTypesGET /api/data/v1/DataSources/parameterTypes/{dataSourceType}Get data source parameter DataType's
FastreportCloudSdk.DataSourcesApidataSourcesGetPermissionsGET /api/data/v1/DataSources/{id}/permissionsGet all Data source permissions
FastreportCloudSdk.DataSourcesApidataSourcesRenameDataSourcePUT /api/data/v1/DataSources/{id}/renameRename data source by id
FastreportCloudSdk.DataSourcesApidataSourcesUpdateConnectionStringPUT /api/data/v1/DataSources/{id}/connectionStringUpdate data source's connection string by id
FastreportCloudSdk.DataSourcesApidataSourcesUpdatePermissionsPOST /api/data/v1/DataSources/{id}/permissionsUpdate permissions
FastreportCloudSdk.DataSourcesApidataSourcesUpdateSelectCommandsPUT /api/data/v1/DataSources/{id}/selectCommandsUpdate data source's select commands by id
FastreportCloudSdk.DataSourcesApidataSourcesUpdateSubscriptionDataSourcePUT /api/data/v1/DataSources/{id}/updateSubscriptionUpdate data source's subscription
FastreportCloudSdk.DownloadApidownloadGetExportGET /download/e/{id}Returns a export file with specified id
FastreportCloudSdk.DownloadApidownloadGetExportThumbnailGET /download/e/{id}/thumbnailReturns export's thumbnail
FastreportCloudSdk.DownloadApidownloadGetExportsGET /download/es/{archiveName}Returns a zip archive with selected ids
FastreportCloudSdk.DownloadApidownloadGetLastSVGExportGET /download/lastPreview/{reportId}returns export, that was created from report with specified id. INTERNAL USAGE ONLY!
FastreportCloudSdk.DownloadApidownloadGetReportGET /download/r/{id}Returns a prepared file with specified id
FastreportCloudSdk.DownloadApidownloadGetReportThumbnailGET /download/r/{id}/thumbnailReturns report's thumbnail
FastreportCloudSdk.DownloadApidownloadGetReportsGET /download/rs/{archiveName}Returns a zip archive with selected files
FastreportCloudSdk.DownloadApidownloadGetTemplateGET /download/t/{id}Returns a Template file with specified id
FastreportCloudSdk.DownloadApidownloadGetTemplateThumbnailGET /download/t/{id}/thumbnailReturns template's thumbnail
FastreportCloudSdk.DownloadApidownloadGetTemplatesGET /download/ts/{archiveName}Returns a zip archive with selected files
FastreportCloudSdk.ExportsApiexportFolderAndFileClearRecycleBinDELETE /api/rp/v1/Exports/{subscriptionId}/ClearRecycleBinDelete all folders and files from recycle bin
FastreportCloudSdk.ExportsApiexportFolderAndFileCopyFilesPOST /api/rp/v1/Exports/{subscriptionId}/CopyFilesCopy folders and files to a specified folder
FastreportCloudSdk.ExportsApiexportFolderAndFileCountRecycleBinFoldersAndFilesGET /api/rp/v1/Exports/{subscriptionId}/CountRecycleBinFolderAndFilesCount all folders and files from recycle bin
FastreportCloudSdk.ExportsApiexportFolderAndFileDeleteFilesPOST /api/rp/v1/Exports/{subscriptionId}/DeleteFilesDelete folders and files
FastreportCloudSdk.ExportsApiexportFolderAndFileGetCountGET /api/rp/v1/Exports/Folder/{id}/CountFolderAndFilesGet count of files and folders what contains in a specified folder
FastreportCloudSdk.ExportsApiexportFolderAndFileGetFoldersAndFilesGET /api/rp/v1/Exports/Folder/{id}/ListFolderAndFilesGet all folders and files from specified folder
FastreportCloudSdk.ExportsApiexportFolderAndFileGetRecycleBinFoldersAndFilesGET /api/rp/v1/Exports/{subscriptionId}/ListRecycleBinFolderAndFilesGet all folders and files from recycle bin
FastreportCloudSdk.ExportsApiexportFolderAndFileMoveFilesPOST /api/rp/v1/Exports/{subscriptionId}/MoveFilesMove folders and files to a specified folder
FastreportCloudSdk.ExportsApiexportFolderAndFileMoveFilesToBinPOST /api/rp/v1/Exports/{subscriptionId}/ToBinMove folders and files to bin
FastreportCloudSdk.ExportsApiexportFolderAndFileRecoverAllFromRecycleBinPOST /api/rp/v1/Exports/{subscriptionId}/RecoverRecycleBinRecover all folders and files from recycle bin
FastreportCloudSdk.ExportsApiexportFolderAndFileRecoverFilesPOST /api/rp/v1/Exports/{subscriptionId}/RecoverFilesRecover folders and files from bin
FastreportCloudSdk.ExportsApiexportFoldersCalculateFolderSizeGET /api/rp/v1/Exports/Folder/{id}/sizeGet specified folder, calculate it's size
FastreportCloudSdk.ExportsApiexportFoldersCopyFolderPOST /api/rp/v1/Exports/Folder/{id}/Copy/{folderId}Move folder to a specified folder
FastreportCloudSdk.ExportsApiexportFoldersDeleteFolderDELETE /api/rp/v1/Exports/Folder/{id}Delete specified folder
FastreportCloudSdk.ExportsApiexportFoldersGetBreadcrumbsGET /api/rp/v1/Exports/Folder/{id}/BreadcrumbsGet specified folder breadcrumbs
FastreportCloudSdk.ExportsApiexportFoldersGetFolderGET /api/rp/v1/Exports/Folder/{id}Get specified folder
FastreportCloudSdk.ExportsApiexportFoldersGetFoldersGET /api/rp/v1/Exports/Folder/{id}/ListFoldersGet all folders from specified folder
FastreportCloudSdk.ExportsApiexportFoldersGetFoldersCountGET /api/rp/v1/Exports/Folder/{id}/CountFoldersGet count of folders what contains in a specified folder
FastreportCloudSdk.ExportsApiexportFoldersGetMyPermissionsGET /api/rp/v1/Exports/Folder/{folderId}/mypermissionsGet user's permissions for a folder by id
FastreportCloudSdk.ExportsApiexportFoldersGetOrCreateGET /api/rp/v1/Exports/Folder/getOrCreateGet specified folder
FastreportCloudSdk.ExportsApiexportFoldersGetPermissionsGET /api/rp/v1/Exports/Folder/{id}/permissionsGet all folder permissions
FastreportCloudSdk.ExportsApiexportFoldersGetRootFolderGET /api/rp/v1/Exports/RootGet user's root folder (without parents)
FastreportCloudSdk.ExportsApiexportFoldersMoveFolderPOST /api/rp/v1/Exports/Folder/{id}/Move/{folderId}Move folder to a specified folder
FastreportCloudSdk.ExportsApiexportFoldersMoveFolderToBinDELETE /api/rp/v1/Exports/Folder/{id}/ToBinMove specified folder to recycle bin
FastreportCloudSdk.ExportsApiexportFoldersPostFolderPOST /api/rp/v1/Exports/Folder/{id}/FolderCreate folder
FastreportCloudSdk.ExportsApiexportFoldersRecoverFolderPOST /api/rp/v1/Exports/Folder/{id}/RecoverRecover specified folder
FastreportCloudSdk.ExportsApiexportFoldersRenameFolderPUT /api/rp/v1/Exports/Folder/{id}/RenameRename a folder
FastreportCloudSdk.ExportsApiexportFoldersUpdateIconPUT /api/rp/v1/Exports/Folder/{id}/IconUpdate a folder's icon
FastreportCloudSdk.ExportsApiexportFoldersUpdatePermissionsPOST /api/rp/v1/Exports/{id}/permissionsUpdate permissions
FastreportCloudSdk.ExportsApiexportFoldersUpdateTagsPUT /api/rp/v1/Exports/Folder/{id}/UpdateTagsUpdate tags
FastreportCloudSdk.ExportsApiexportsCopyFilePOST /api/rp/v1/Exports/File/{id}/Copy/{folderId}Copy file to a specified folder
FastreportCloudSdk.ExportsApiexportsCreateSharingKeyPOST /api/rp/v1/Exports/File/{id}/sharingKeyCreate a new key, that can be used to share access to a file (You need Administrate.Anon permission to create a new key)
FastreportCloudSdk.ExportsApiexportsDeleteFileDELETE /api/rp/v1/Exports/File/{id}Delete specified file
FastreportCloudSdk.ExportsApiexportsDeleteSharingKeyDELETE /api/rp/v1/Exports/File/{id}/sharingKeyDeletes a sharing key, making links, that utilizing it no longer work
FastreportCloudSdk.ExportsApiexportsGetByTaskIdGET /api/rp/v1/Exports/File/Task/{taskId}Get exports by specified task id
FastreportCloudSdk.ExportsApiexportsGetByTaskMessageIdGET /api/rp/v1/Exports/File/TaskMessage/{taskMessageId}Get export by specified task message id
FastreportCloudSdk.ExportsApiexportsGetFileGET /api/rp/v1/Exports/File/{id}Get export by specified id
FastreportCloudSdk.ExportsApiexportsGetFileHistoryGET /api/rp/v1/Exports/File/{id}/HistoryReturns list of actions, performed on this file
FastreportCloudSdk.ExportsApiexportsGetFilesCountGET /api/rp/v1/Exports/Folder/{id}/CountFilesGet count of files what contains in a specified folder
FastreportCloudSdk.ExportsApiexportsGetFilesListGET /api/rp/v1/Exports/Folder/{id}/ListFilesGet 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.ExportsApiexportsGetMyPermissionsGET /api/rp/v1/Exports/File/{id}/mypermissionsGet current user's permissions to file
FastreportCloudSdk.ExportsApiexportsGetPermissionsGET /api/rp/v1/Exports/File/{id}/permissions
FastreportCloudSdk.ExportsApiexportsGetSharingKeysGET /api/rp/v1/Exports/File/{id}/sharingKeysReturns all sharing keys, associated with the file
FastreportCloudSdk.ExportsApiexportsMoveFilePOST /api/rp/v1/Exports/File/{id}/Move/{folderId}Move file to a specified folder
FastreportCloudSdk.ExportsApiexportsMoveFileToBinDELETE /api/rp/v1/Exports/File/{id}/ToBinMove specified file to recycle bin
FastreportCloudSdk.ExportsApiexportsRecoverFilePOST /api/rp/v1/Exports/File/{id}/RecoverRecover specified file from bin
FastreportCloudSdk.ExportsApiexportsRenameFilePUT /api/rp/v1/Exports/File/{id}/RenameRename a file
FastreportCloudSdk.ExportsApiexportsUpdateIconPUT /api/rp/v1/Exports/File/{id}/IconUpdate a files's icon
FastreportCloudSdk.ExportsApiexportsUpdatePermissionsPOST /api/rp/v1/Exports/File/{id}/permissionsUpdate permissions
FastreportCloudSdk.ExportsApiexportsUpdateTagsPUT /api/rp/v1/Exports/File/{id}/UpdateTagsUpdate tags
FastreportCloudSdk.GroupUsersApigroupUsersAddUserToGroupPUT /api/manage/v1/Groups/{id}/Users/{userId}Add user to the group by identifier
FastreportCloudSdk.GroupUsersApigroupUsersGetUsersInGroupGET /api/manage/v1/Groups/{id}/UsersReturns users in the group by identifier
FastreportCloudSdk.GroupUsersApigroupUsersLeaveFromGroupDELETE /api/manage/v1/Groups/{id}/leaveLeave from the group
FastreportCloudSdk.GroupUsersApigroupUsersRemoveFromGroupDELETE /api/manage/v1/Groups/{id}/Users/{userId}Remove user from the group by identifier
FastreportCloudSdk.GroupsApigroupsCreateGroupPOST /api/manage/v1/GroupsCreate a new user group
FastreportCloudSdk.GroupsApigroupsDeleteGroupDELETE /api/manage/v1/Groups/{id}Delete group by identifier
FastreportCloudSdk.GroupsApigroupsGetGroupGET /api/manage/v1/Groups/{id}Gets group by identifier
FastreportCloudSdk.GroupsApigroupsGetGroupListGET /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
FastreportCloudSdk.GroupsApigroupsGetMyPermissionsGET /api/manage/v1/Groups/{id}/mypermissionsGet current user's permissions to group
FastreportCloudSdk.GroupsApigroupsGetPermissionsGET /api/manage/v1/Groups/{id}/permissionsGets group permissions by identifier
FastreportCloudSdk.GroupsApigroupsRenameGroupPUT /api/manage/v1/Groups/{id}/renameRename group by identifier
FastreportCloudSdk.GroupsApigroupsUpdatePermissionsPOST /api/manage/v1/Groups/{id}/permissionsUpdate permissions
FastreportCloudSdk.HealthCheckApihealthCheckDataGetGET /api/backend/v1/HealthCheckhealthcheck
FastreportCloudSdk.ReportsApireportFolderAndFileClearRecycleBinDELETE /api/rp/v1/Reports/{subscriptionId}/ClearRecycleBinDelete all folders and files from recycle bin
FastreportCloudSdk.ReportsApireportFolderAndFileCopyFilesPOST /api/rp/v1/Reports/{subscriptionId}/CopyFilesCopy folders and files to a specified folder
FastreportCloudSdk.ReportsApireportFolderAndFileCountRecycleBinFoldersAndFilesGET /api/rp/v1/Reports/{subscriptionId}/CountRecycleBinFolderAndFilesCount all folders and files from recycle bin
FastreportCloudSdk.ReportsApireportFolderAndFileDeleteFilesPOST /api/rp/v1/Reports/{subscriptionId}/DeleteFilesDelete folders and files
FastreportCloudSdk.ReportsApireportFolderAndFileGetCountGET /api/rp/v1/Reports/Folder/{id}/CountFolderAndFilesGet count of files and folders what contains in a specified folder
FastreportCloudSdk.ReportsApireportFolderAndFileGetFoldersAndFilesGET /api/rp/v1/Reports/Folder/{id}/ListFolderAndFilesGet all folders and files from specified folder
FastreportCloudSdk.ReportsApireportFolderAndFileGetRecycleBinFoldersAndFilesGET /api/rp/v1/Reports/{subscriptionId}/ListRecycleBinFolderAndFilesGet all folders and files from recycle bin
FastreportCloudSdk.ReportsApireportFolderAndFileMoveFilesPOST /api/rp/v1/Reports/{subscriptionId}/MoveFilesMove folders and files to a specified folder
FastreportCloudSdk.ReportsApireportFolderAndFileMoveFilesToBinPOST /api/rp/v1/Reports/{subscriptionId}/ToBinMove folders and files to bin
FastreportCloudSdk.ReportsApireportFolderAndFileRecoverAllFromRecycleBinPOST /api/rp/v1/Reports/{subscriptionId}/RecoverRecycleBinRecover all folders and files from recycle bin
FastreportCloudSdk.ReportsApireportFolderAndFileRecoverFilesPOST /api/rp/v1/Reports/{subscriptionId}/RecoverFilesRecover folders and files from bin
FastreportCloudSdk.ReportsApireportFoldersCalculateFolderSizeGET /api/rp/v1/Reports/Folder/{id}/sizeGet specified folder, calculate it's size
FastreportCloudSdk.ReportsApireportFoldersCopyFolderPOST /api/rp/v1/Reports/Folder/{id}/Copy/{folderId}Move folder to a specified folder
FastreportCloudSdk.ReportsApireportFoldersDeleteFolderDELETE /api/rp/v1/Reports/Folder/{id}Delete specified folder
FastreportCloudSdk.ReportsApireportFoldersExportPOST /api/rp/v1/Reports/Folder/{id}/ExportExport specified report folder to a specified format
FastreportCloudSdk.ReportsApireportFoldersGetBreadcrumbsGET /api/rp/v1/Reports/Folder/{id}/BreadcrumbsGet specified folder breadcrumbs
FastreportCloudSdk.ReportsApireportFoldersGetFolderGET /api/rp/v1/Reports/Folder/{id}Get specified folder
FastreportCloudSdk.ReportsApireportFoldersGetFoldersGET /api/rp/v1/Reports/Folder/{id}/ListFoldersGet all folders from specified folder
FastreportCloudSdk.ReportsApireportFoldersGetFoldersCountGET /api/rp/v1/Reports/Folder/{id}/CountFoldersGet count of folders what contains in a specified folder
FastreportCloudSdk.ReportsApireportFoldersGetMyPermissionsGET /api/rp/v1/Reports/Folder/{folderId}/mypermissionsGet user's permissions for a folder by id
FastreportCloudSdk.ReportsApireportFoldersGetOrCreateGET /api/rp/v1/Reports/Folder/getOrCreateGet specified folder
FastreportCloudSdk.ReportsApireportFoldersGetPermissionsGET /api/rp/v1/Reports/Folder/{id}/permissionsGet all folder permissions
FastreportCloudSdk.ReportsApireportFoldersGetRootFolderGET /api/rp/v1/Reports/RootGet user's root folder (without parents)
FastreportCloudSdk.ReportsApireportFoldersMoveFolderPOST /api/rp/v1/Reports/Folder/{id}/Move/{folderId}Move folder to a specified folder
FastreportCloudSdk.ReportsApireportFoldersMoveFolderToBinDELETE /api/rp/v1/Reports/Folder/{id}/ToBinMove specified folder to recycle bin
FastreportCloudSdk.ReportsApireportFoldersPostFolderPOST /api/rp/v1/Reports/Folder/{id}/FolderCreate folder
FastreportCloudSdk.ReportsApireportFoldersRecoverFolderPOST /api/rp/v1/Reports/Folder/{id}/RecoverRecover specified folder
FastreportCloudSdk.ReportsApireportFoldersRenameFolderPUT /api/rp/v1/Reports/Folder/{id}/RenameRename a folder
FastreportCloudSdk.ReportsApireportFoldersUpdateIconPUT /api/rp/v1/Reports/Folder/{id}/IconUpdate a folder's icon
FastreportCloudSdk.ReportsApireportFoldersUpdatePermissionsPOST /api/rp/v1/Reports/{id}/permissionsUpdate permissions
FastreportCloudSdk.ReportsApireportFoldersUpdateTagsPUT /api/rp/v1/Reports/Folder/{id}/UpdateTagsUpdate tags
FastreportCloudSdk.ReportsApireportsCopyFilePOST /api/rp/v1/Reports/File/{id}/Copy/{folderId}Copy file to a specified folder
FastreportCloudSdk.ReportsApireportsCreateSharingKeyPOST /api/rp/v1/Reports/File/{id}/sharingKeyCreate a new key, that can be used to share access to a file (You need Administrate.Anon permission to create a new key)
FastreportCloudSdk.ReportsApireportsDeleteFileDELETE /api/rp/v1/Reports/File/{id}Delete specified file
FastreportCloudSdk.ReportsApireportsDeleteSharingKeyDELETE /api/rp/v1/Reports/File/{id}/sharingKeyDeletes a sharing key, making links, that utilizing it no longer work
FastreportCloudSdk.ReportsApireportsExportPOST /api/rp/v1/Reports/File/{id}/ExportExport specified report to a specified format
FastreportCloudSdk.ReportsApireportsGetByTaskIdGET /api/rp/v1/Reports/File/Task/{taskId}Get reports by specified task id
FastreportCloudSdk.ReportsApireportsGetByTaskMessageIdGET /api/rp/v1/Reports/File/TaskMessage/{taskMessageId}Get report by specified task message id
FastreportCloudSdk.ReportsApireportsGetFileGET /api/rp/v1/Reports/File/{id}Get specified file
FastreportCloudSdk.ReportsApireportsGetFileHistoryGET /api/rp/v1/Reports/File/{id}/HistoryReturns list of actions, performed on this file
FastreportCloudSdk.ReportsApireportsGetFilesCountGET /api/rp/v1/Reports/Folder/{id}/CountFilesGet count of files what contains in a specified folder
FastreportCloudSdk.ReportsApireportsGetFilesListGET /api/rp/v1/Reports/Folder/{id}/ListFilesGet 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.ReportsApireportsGetMyPermissionsGET /api/rp/v1/Reports/File/{id}/mypermissionsGet current user's permissions to file
FastreportCloudSdk.ReportsApireportsGetPermissionsGET /api/rp/v1/Reports/File/{id}/permissions
FastreportCloudSdk.ReportsApireportsGetSharingKeysGET /api/rp/v1/Reports/File/{id}/sharingKeysReturns all sharing keys, associated with the file
FastreportCloudSdk.ReportsApireportsMoveFilePOST /api/rp/v1/Reports/File/{id}/Move/{folderId}Move file to a specified folder
FastreportCloudSdk.ReportsApireportsMoveFileToBinDELETE /api/rp/v1/Reports/File/{id}/ToBinMove specified file to recycle bin
FastreportCloudSdk.ReportsApireportsRecoverFilePOST /api/rp/v1/Reports/File/{id}/RecoverRecover specified file from bin
FastreportCloudSdk.ReportsApireportsRenameFilePUT /api/rp/v1/Reports/File/{id}/RenameRename a file
FastreportCloudSdk.ReportsApireportsStaticPreviewPOST /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
FastreportCloudSdk.ReportsApireportsUpdateIconPUT /api/rp/v1/Reports/File/{id}/IconUpdate a files's icon
FastreportCloudSdk.ReportsApireportsUpdatePermissionsPOST /api/rp/v1/Reports/File/{id}/permissionsUpdate permissions
FastreportCloudSdk.ReportsApireportsUpdateTagsPUT /api/rp/v1/Reports/File/{id}/UpdateTagsUpdate tags
FastreportCloudSdk.ReportsApireportsUploadFilePOST /api/rp/v1/Reports/Folder/{id}/FileUpload a file to the specified folder. The method is deprecated, use the UploadFileV2 method instead!
FastreportCloudSdk.ReportsApireportsUploadFileV2POST /api/rp/v2/Reports/Folder/{id}/FileAlternative api for upload a file to the specified folder!
FastreportCloudSdk.SubscriptionGroupsApisubscriptionGroupsCountGroupsAsyncGET /api/manage/v1/Subscriptions/{subscriptionId}/countReturns a number of groups in subscription
FastreportCloudSdk.SubscriptionGroupsApisubscriptionGroupsGetGroupsListGET /api/manage/v1/Subscriptions/{subscriptionId}/groupsreturns groups of the subscription or subscription user
FastreportCloudSdk.SubscriptionInvitesApisubscriptionInvitesAcceptInviteGET /api/manage/v1/Subscriptions/{subscriptionId}/invite/{accessToken}/acceptAdd 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.SubscriptionInvitesApisubscriptionInvitesCreateInvitePOST /api/manage/v1/Subscriptions/{subscriptionId}/inviteCreate invite to subscription
FastreportCloudSdk.SubscriptionInvitesApisubscriptionInvitesDeleteInviteDELETE /api/manage/v1/Subscriptions/{subscriptionId}/invite/{accesstoken}Delete invite with specified token
FastreportCloudSdk.SubscriptionInvitesApisubscriptionInvitesGetInvitesGET /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.
FastreportCloudSdk.SubscriptionPlansApisubscriptionPlansGetSubscriptionPlanGET /api/manage/v1/SubscriptionPlans/{id}Returns a subscription plan. Not all subscriptions can be issued for customer.
FastreportCloudSdk.SubscriptionPlansApisubscriptionPlansGetSubscriptionPlansGET /api/manage/v1/SubscriptionPlansReturns a list of active subscription plans that can be issued to the user.
FastreportCloudSdk.SubscriptionUsersApisubscriptionUsersAddUserPUT /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.SubscriptionUsersApisubscriptionUsersCountUsersAsyncGET /api/manage/v1/Subscriptions/{subscriptionId}/UsersCountReturns a number of users in subscription
FastreportCloudSdk.SubscriptionUsersApisubscriptionUsersGetUsersGET /api/manage/v1/Subscriptions/{subscriptionId}/usersReturns all users of subscription
FastreportCloudSdk.SubscriptionUsersApisubscriptionUsersLeaveSubscripitonDELETE /api/manage/v1/Subscriptions/{subscriptionId}/leaveAllows user to leave subscription,.
FastreportCloudSdk.SubscriptionUsersApisubscriptionUsersRemoveUserDELETE /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.SubscriptionsApisubscriptionsGetDefaultPermissionsGET /api/manage/v1/Subscriptions/{subscriptionId}/defaultPermissionsGet subscription's default permissions for new entities
FastreportCloudSdk.SubscriptionsApisubscriptionsGetMyPermissionsGET /api/manage/v1/Subscriptions/{subId}/mypermissionsGet user's permissions for a subscription by id
FastreportCloudSdk.SubscriptionsApisubscriptionsGetPermissionsGET /api/manage/v1/Subscriptions/{id}/permissionsGet permissions for a subscription by id
FastreportCloudSdk.SubscriptionsApisubscriptionsGetSubscriptionGET /api/manage/v1/Subscriptions/{id}Returns the subscription by id
FastreportCloudSdk.SubscriptionsApisubscriptionsGetSubscriptionsGET /api/manage/v1/SubscriptionsReturns a list of all subscriptions of current user
FastreportCloudSdk.SubscriptionsApisubscriptionsRenameSubscriptionPUT /api/manage/v1/Subscriptions/{subscriptionId}/renameRename subscription
FastreportCloudSdk.SubscriptionsApisubscriptionsUpdateDefaultPermissionsPUT /api/manage/v1/Subscriptions/{subscriptionId}/defaultPermissionsChange subscription's default permissions for new entities
FastreportCloudSdk.SubscriptionsApisubscriptionsUpdateLocalePUT /api/manage/v1/Subscriptions/{subscriptionId}/LocaleUpdate subscription's default locale
FastreportCloudSdk.SubscriptionsApisubscriptionsUpdatePermissionsPOST /api/manage/v1/Subscriptions/{id}/permissionsUpdate permissions
FastreportCloudSdk.TasksApitasksCreateTaskPOST /api/tasks/v1/TasksCreate a new task
FastreportCloudSdk.TasksApitasksDeleteTaskDELETE /api/tasks/v1/Tasks/{taskId}Delete a task from a storage
FastreportCloudSdk.TasksApitasksGetGET /api/tasks/v1/Tasks/{taskId}Get a task by a specified id
FastreportCloudSdk.TasksApitasksGetListGET /api/tasks/v1/TasksGet tasks list
FastreportCloudSdk.TasksApitasksGetMyPermissionsGET /api/tasks/v1/Tasks/{id}/mypermissionsGet current user's permissions to Task
FastreportCloudSdk.TasksApitasksGetPermissionsGET /api/tasks/v1/Tasks/{id}/permissionsGet all Task permissions
FastreportCloudSdk.TasksApitasksRenameTaskPUT /api/tasks/v1/Tasks/{taskId}/renameRename a task
FastreportCloudSdk.TasksApitasksRunTaskPOST /api/tasks/v1/Tasks/runRun a task from request body
FastreportCloudSdk.TasksApitasksRunTaskByIdPOST /api/tasks/v1/Tasks/{taskId}/runRun a task by id
FastreportCloudSdk.TasksApitasksUpdatePermissionsPOST /api/tasks/v1/Tasks/{id}/permissionsUpdate permissions
FastreportCloudSdk.TasksApitasksUpdateTaskPUT /api/tasks/v1/Tasks/{taskId}Update a task
FastreportCloudSdk.TemplatesApitemplateFolderAndFileClearRecycleBinDELETE /api/rp/v1/Templates/{subscriptionId}/ClearRecycleBinDelete all folders and files from recycle bin
FastreportCloudSdk.TemplatesApitemplateFolderAndFileCopyFilesPOST /api/rp/v1/Templates/{subscriptionId}/CopyFilesCopy folders and files to a specified folder
FastreportCloudSdk.TemplatesApitemplateFolderAndFileCountRecycleBinFoldersAndFilesGET /api/rp/v1/Templates/{subscriptionId}/CountRecycleBinFolderAndFilesCount all folders and files from recycle bin
FastreportCloudSdk.TemplatesApitemplateFolderAndFileDeleteFilesPOST /api/rp/v1/Templates/{subscriptionId}/DeleteFilesDelete folders and files
FastreportCloudSdk.TemplatesApitemplateFolderAndFileGetCountGET /api/rp/v1/Templates/Folder/{id}/CountFolderAndFilesGet count of files and folders what contains in a specified folder
FastreportCloudSdk.TemplatesApitemplateFolderAndFileGetFoldersAndFilesGET /api/rp/v1/Templates/Folder/{id}/ListFolderAndFilesGet all folders and files from specified folder
FastreportCloudSdk.TemplatesApitemplateFolderAndFileGetRecycleBinFoldersAndFilesGET /api/rp/v1/Templates/{subscriptionId}/ListRecycleBinFolderAndFilesGet all folders and files from recycle bin
FastreportCloudSdk.TemplatesApitemplateFolderAndFileMoveFilesPOST /api/rp/v1/Templates/{subscriptionId}/MoveFilesMove folders and files to a specified folder
FastreportCloudSdk.TemplatesApitemplateFolderAndFileMoveFilesToBinPOST /api/rp/v1/Templates/{subscriptionId}/ToBinMove folders and files to bin
FastreportCloudSdk.TemplatesApitemplateFolderAndFileRecoverAllFromRecycleBinPOST /api/rp/v1/Templates/{subscriptionId}/RecoverRecycleBinRecover all folders and files from recycle bin
FastreportCloudSdk.TemplatesApitemplateFolderAndFileRecoverFilesPOST /api/rp/v1/Templates/{subscriptionId}/RecoverFilesRecover folders and files from bin
FastreportCloudSdk.TemplatesApitemplateFoldersCalculateFolderSizeGET /api/rp/v1/Templates/Folder/{id}/sizeGet specified folder, calculate it's size
FastreportCloudSdk.TemplatesApitemplateFoldersCopyFolderPOST /api/rp/v1/Templates/Folder/{id}/Copy/{folderId}Move folder to a specified folder
FastreportCloudSdk.TemplatesApitemplateFoldersDeleteFolderDELETE /api/rp/v1/Templates/Folder/{id}Delete specified folder
FastreportCloudSdk.TemplatesApitemplateFoldersExportPOST /api/rp/v1/Templates/Folder/{id}/ExportExport specified template folder to a specified format
FastreportCloudSdk.TemplatesApitemplateFoldersGetBreadcrumbsGET /api/rp/v1/Templates/Folder/{id}/BreadcrumbsGet specified folder breadcrumbs
FastreportCloudSdk.TemplatesApitemplateFoldersGetFolderGET /api/rp/v1/Templates/Folder/{id}Get specified folder
FastreportCloudSdk.TemplatesApitemplateFoldersGetFoldersGET /api/rp/v1/Templates/Folder/{id}/ListFoldersGet all folders from specified folder
FastreportCloudSdk.TemplatesApitemplateFoldersGetFoldersCountGET /api/rp/v1/Templates/Folder/{id}/CountFoldersGet count of folders what contains in a specified folder
FastreportCloudSdk.TemplatesApitemplateFoldersGetMyPermissionsGET /api/rp/v1/Templates/Folder/{folderId}/mypermissionsGet user's permissions for a folder by id
FastreportCloudSdk.TemplatesApitemplateFoldersGetOrCreateGET /api/rp/v1/Templates/Folder/getOrCreateGet specified folder
FastreportCloudSdk.TemplatesApitemplateFoldersGetPermissionsGET /api/rp/v1/Templates/Folder/{id}/permissionsGet all folder permissions
FastreportCloudSdk.TemplatesApitemplateFoldersGetRootFolderGET /api/rp/v1/Templates/RootGet user's root folder (without parents)
FastreportCloudSdk.TemplatesApitemplateFoldersMoveFolderPOST /api/rp/v1/Templates/Folder/{id}/Move/{folderId}Move folder to a specified folder
FastreportCloudSdk.TemplatesApitemplateFoldersMoveFolderToBinDELETE /api/rp/v1/Templates/Folder/{id}/ToBinMove specified folder to recycle bin
FastreportCloudSdk.TemplatesApitemplateFoldersPostFolderPOST /api/rp/v1/Templates/Folder/{id}/FolderCreate folder
FastreportCloudSdk.TemplatesApitemplateFoldersPreparePOST /api/rp/v1/Templates/Folder/{id}/PreparePrepare specified template folder to report folder
FastreportCloudSdk.TemplatesApitemplateFoldersRecoverFolderPOST /api/rp/v1/Templates/Folder/{id}/RecoverRecover specified folder
FastreportCloudSdk.TemplatesApitemplateFoldersRenameFolderPUT /api/rp/v1/Templates/Folder/{id}/RenameRename a folder
FastreportCloudSdk.TemplatesApitemplateFoldersUpdateIconPUT /api/rp/v1/Templates/Folder/{id}/IconUpdate a folder's icon
FastreportCloudSdk.TemplatesApitemplateFoldersUpdatePermissionsPOST /api/rp/v1/Templates/{id}/permissionsUpdate permissions
FastreportCloudSdk.TemplatesApitemplateFoldersUpdateTagsPUT /api/rp/v1/Templates/Folder/{id}/UpdateTagsUpdate tags
FastreportCloudSdk.TemplatesApitemplatesCopyFilePOST /api/rp/v1/Templates/File/{id}/Copy/{folderId}Copy file to a specified folder
FastreportCloudSdk.TemplatesApitemplatesCreateSharingKeyPOST /api/rp/v1/Templates/File/{id}/sharingKeyCreate a new key, that can be used to share access to a file (You need Administrate.Anon permission to create a new key)
FastreportCloudSdk.TemplatesApitemplatesDeleteFileDELETE /api/rp/v1/Templates/File/{id}Delete specified file
FastreportCloudSdk.TemplatesApitemplatesDeleteSharingKeyDELETE /api/rp/v1/Templates/File/{id}/sharingKeyDeletes a sharing key, making links, that utilizing it no longer work
FastreportCloudSdk.TemplatesApitemplatesExportPOST /api/rp/v1/Templates/File/{id}/ExportExport specified report template to a specified format
FastreportCloudSdk.TemplatesApitemplatesGetFileGET /api/rp/v1/Templates/File/{id}Get specified file
FastreportCloudSdk.TemplatesApitemplatesGetFileHistoryGET /api/rp/v1/Templates/File/{id}/HistoryReturns list of actions, performed on this file
FastreportCloudSdk.TemplatesApitemplatesGetFilesCountGET /api/rp/v1/Templates/Folder/{id}/CountFilesGet count of files what contains in a specified folder
FastreportCloudSdk.TemplatesApitemplatesGetFilesListGET /api/rp/v1/Templates/Folder/{id}/ListFilesGet 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.TemplatesApitemplatesGetMyPermissionsGET /api/rp/v1/Templates/File/{id}/mypermissionsGet current user's permissions to file
FastreportCloudSdk.TemplatesApitemplatesGetPermissionsGET /api/rp/v1/Templates/File/{id}/permissions
FastreportCloudSdk.TemplatesApitemplatesGetSharingKeysGET /api/rp/v1/Templates/File/{id}/sharingKeysReturns all sharing keys, associated with the file
FastreportCloudSdk.TemplatesApitemplatesMoveFilePOST /api/rp/v1/Templates/File/{id}/Move/{folderId}Move file to a specified folder
FastreportCloudSdk.TemplatesApitemplatesMoveFileToBinDELETE /api/rp/v1/Templates/File/{id}/ToBinMove specified file to recycle bin
FastreportCloudSdk.TemplatesApitemplatesPreparePOST /api/rp/v1/Templates/File/{id}/PreparePrepare specified template to report
FastreportCloudSdk.TemplatesApitemplatesRecoverFilePOST /api/rp/v1/Templates/File/{id}/RecoverRecover specified file from bin
FastreportCloudSdk.TemplatesApitemplatesRenameFilePUT /api/rp/v1/Templates/File/{id}/RenameRename a file
FastreportCloudSdk.TemplatesApitemplatesStaticPreviewPOST /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
FastreportCloudSdk.TemplatesApitemplatesUpdateContentPUT /api/rp/v1/Templates/File/{id}/ContentUpdates contnet of the template. The method is deprecated, use the UpdateContentV2 method instead!
FastreportCloudSdk.TemplatesApitemplatesUpdateContentV2PUT /api/rp/v2/Templates/File/{id}/ContentUpdates contnet of the template.
FastreportCloudSdk.TemplatesApitemplatesUpdateIconPUT /api/rp/v1/Templates/File/{id}/IconUpdate a files's icon
FastreportCloudSdk.TemplatesApitemplatesUpdateParametersPUT /api/rp/v1/Templates/File/{id}/parameters
FastreportCloudSdk.TemplatesApitemplatesUpdatePermissionsPOST /api/rp/v1/Templates/File/{id}/permissionsUpdate permissions
FastreportCloudSdk.TemplatesApitemplatesUpdateTagsPUT /api/rp/v1/Templates/File/{id}/UpdateTagsUpdate tags
FastreportCloudSdk.TemplatesApitemplatesUploadFilePOST /api/rp/v1/Templates/Folder/{id}/FileUpload a file to the specified folder. The method is deprecated, use the UploadFileV2 method instead!
FastreportCloudSdk.TemplatesApitemplatesUploadFileV2POST /api/rp/v2/Templates/Folder/{id}/FileAlternative api for upload a file to the specified folder!
FastreportCloudSdk.UserNotificationsApiuserNotificationsClearNotificationsDELETE /api/manage/v1/notificationsUse this endpoint to &quot;clear&quot; your notifications
FastreportCloudSdk.UserNotificationsApiuserNotificationsGetNotificationsGET /api/manage/v1/notificationsUse this endpoint to recieve notifications
FastreportCloudSdk.UserProfileApiuserProfileGetMyProfileGET /api/manage/v1/UserProfileReturn current profile of the current user
FastreportCloudSdk.UserProfileApiuserProfileGetUserProfileGET /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.UserProfileApiuserProfileUpdateMyProfilePUT /api/manage/v1/UserProfileUpdate profile of the current user
FastreportCloudSdk.UserSettingsApiuserSettingsAcceptAgreementsPOST /api/manage/v1/UserSettings/acceptUse this endpoint to accept current version of service license agreement
FastreportCloudSdk.UserSettingsApiuserSettingsGetCurrentUserSettingsGET /api/manage/v1/UserSettingsReturn current user settings.
FastreportCloudSdk.UserSettingsApiuserSettingsUpdateMySettingsPUT /api/manage/v1/UserSettingsUpdate 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

Stars

6 stars

Watchers

3 watching

Forks

Releases

Packages

Used by

Contributors

Languages