All URIs are relative to http://localhost
Method | HTTP request | Description |
---|---|---|
TemplateFolderAndFileClearRecycleBin | Delete /api/rp/v1/Templates/{subscriptionId}/ClearRecycleBin | Delete all folders and files from recycle bin |
TemplateFolderAndFileCopyFiles | Post /api/rp/v1/Templates/{subscriptionId}/CopyFiles | Copy folders and files to a specified folder |
TemplateFolderAndFileCountRecycleBinFoldersAndFiles | Get /api/rp/v1/Templates/{subscriptionId}/CountRecycleBinFolderAndFiles | Count all folders and files from recycle bin |
TemplateFolderAndFileDeleteFiles | Post /api/rp/v1/Templates/{subscriptionId}/DeleteFiles | Delete folders and files |
TemplateFolderAndFileGetCount | Get /api/rp/v1/Templates/Folder/{id}/CountFolderAndFiles | Get count of files and folders what contains in a specified folder |
TemplateFolderAndFileGetFoldersAndFiles | Get /api/rp/v1/Templates/Folder/{id}/ListFolderAndFiles | Get all folders and files from specified folder |
TemplateFolderAndFileGetRecycleBinFoldersAndFiles | Get /api/rp/v1/Templates/{subscriptionId}/ListRecycleBinFolderAndFiles | Get all folders and files from recycle bin |
TemplateFolderAndFileMoveFiles | Post /api/rp/v1/Templates/{subscriptionId}/MoveFiles | Move folders and files to a specified folder |
TemplateFolderAndFileMoveFilesToBin | Post /api/rp/v1/Templates/{subscriptionId}/ToBin | Move folders and files to bin |
TemplateFolderAndFileRecoverAllFromRecycleBin | Post /api/rp/v1/Templates/{subscriptionId}/RecoverRecycleBin | Recover all folders and files from recycle bin |
TemplateFolderAndFileRecoverFiles | Post /api/rp/v1/Templates/{subscriptionId}/RecoverFiles | Recover folders and files from bin |
TemplateFoldersCalculateFolderSize | Get /api/rp/v1/Templates/Folder/{id}/size | Get specified folder, calculate it's size |
TemplateFoldersCopyFolder | Post /api/rp/v1/Templates/Folder/{id}/Copy/{folderId} | Move folder to a specified folder |
TemplateFoldersDeleteFolder | Delete /api/rp/v1/Templates/Folder/{id} | Delete specified folder |
TemplateFoldersExport | Post /api/rp/v1/Templates/Folder/{id}/Export | Export specified template folder to a specified format |
TemplateFoldersGetBreadcrumbs | Get /api/rp/v1/Templates/Folder/{id}/Breadcrumbs | Get specified folder breadcrumbs |
TemplateFoldersGetFolder | Get /api/rp/v1/Templates/Folder/{id} | Get specified folder |
TemplateFoldersGetFolders | Get /api/rp/v1/Templates/Folder/{id}/ListFolders | Get all folders from specified folder |
TemplateFoldersGetFoldersCount | Get /api/rp/v1/Templates/Folder/{id}/CountFolders | Get count of folders what contains in a specified folder |
TemplateFoldersGetOrCreate | Get /api/rp/v1/Templates/Folder/getOrCreate | Get specified folder |
TemplateFoldersGetPermissions | Get /api/rp/v1/Templates/Folder/{id}/permissions | Get all folder permissions |
TemplateFoldersGetRootFolder | Get /api/rp/v1/Templates/Root | Get user's root folder (without parents) |
TemplateFoldersMoveFolder | Post /api/rp/v1/Templates/Folder/{id}/Move/{folderId} | Move folder to a specified folder |
TemplateFoldersMoveFolderToBin | Delete /api/rp/v1/Templates/Folder/{id}/ToBin | Move specified folder to recycle bin |
TemplateFoldersPostFolder | Post /api/rp/v1/Templates/Folder/{id}/Folder | Create folder |
TemplateFoldersPrepare | Post /api/rp/v1/Templates/Folder/{id}/Prepare | Prepare specified template folder to report folder |
TemplateFoldersRecoverFolder | Post /api/rp/v1/Templates/Folder/{id}/Recover | Recover specified folder |
TemplateFoldersRenameFolder | Put /api/rp/v1/Templates/Folder/{id}/Rename | Rename a folder |
TemplateFoldersUpdateIcon | Put /api/rp/v1/Templates/Folder/{id}/Icon | Update a folder's icon |
TemplateFoldersUpdatePermissions | Post /api/rp/v1/Templates/{id}/permissions | Update permissions |
TemplateFoldersUpdateTags | Put /api/rp/v1/Templates/Folder/{id}/UpdateTags | Update tags |
TemplatesCopyFile | Post /api/rp/v1/Templates/File/{id}/Copy/{folderId} | Copy file to a specified folder |
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) |
TemplatesDeleteFile | Delete /api/rp/v1/Templates/File/{id} | Delete specified file |
TemplatesDeleteSharingKey | Delete /api/rp/v1/Templates/File/{id}/sharingKey | Deletes a sharing key, making links, that utilizing it no longer work |
TemplatesExport | Post /api/rp/v1/Templates/File/{id}/Export | Export specified report template to a specified format |
TemplatesGetFile | Get /api/rp/v1/Templates/File/{id} | Get specified file |
TemplatesGetFileHistory | Get /api/rp/v1/Templates/File/{id}/History | Returns list of actions, performed on this file |
TemplatesGetFilesCount | Get /api/rp/v1/Templates/Folder/{id}/CountFiles | Get count of files what contains in a specified folder |
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. |
TemplatesGetPermissions | Get /api/rp/v1/Templates/File/{id}/permissions | |
TemplatesGetSharingKeys | Get /api/rp/v1/Templates/File/{id}/sharingKeys | Returns all sharing keys, associated with the file |
TemplatesMoveFile | Post /api/rp/v1/Templates/File/{id}/Move/{folderId} | Move file to a specified folder |
TemplatesMoveFileToBin | Delete /api/rp/v1/Templates/File/{id}/ToBin | Move specified file to recycle bin |
TemplatesPrepare | Post /api/rp/v1/Templates/File/{id}/Prepare | Prepare specified template to report |
TemplatesRecoverFile | Post /api/rp/v1/Templates/File/{id}/Recover | Recover specified file from bin |
TemplatesRenameFile | Put /api/rp/v1/Templates/File/{id}/Rename | Rename a file |
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 |
TemplatesUpdateContent | Put /api/rp/v1/Templates/File/{id}/Content | Updates contnet of the template. The method is deprecated, use the UpdateContentV2 method instead! |
TemplatesUpdateContentV2 | Put /api/rp/v2/Templates/File/{id}/Content | Updates contnet of the template. |
TemplatesUpdateIcon | Put /api/rp/v1/Templates/File/{id}/Icon | Update a files's icon |
TemplatesUpdatePermissions | Post /api/rp/v1/Templates/File/{id}/permissions | Update permissions |
TemplatesUpdateTags | Put /api/rp/v1/Templates/File/{id}/UpdateTags | Update tags |
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! |
TemplatesUploadFileV2 | Post /api/rp/v2/Templates/Folder/{id}/File | Alternative api for upload a file to the specified folder! |
TemplateFolderAndFileClearRecycleBin(ctx, subscriptionId).Execute()
Delete all folders and files from recycle bin
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/fastreports/gofrcloud"
)
func main() {
subscriptionId := "subscriptionId_example" // string | subscription id
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
r, err := apiClient.TemplatesAPI.TemplateFolderAndFileClearRecycleBin(context.Background(), subscriptionId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TemplatesAPI.TemplateFolderAndFileClearRecycleBin``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
subscriptionId | string | subscription id |
Other parameters are passed through a pointer to a apiTemplateFolderAndFileClearRecycleBinRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
(empty response body)
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
TemplateFolderAndFileCopyFiles(ctx, subscriptionId).SelectedFilesVM(selectedFilesVM).Execute()
Copy folders and files to a specified folder
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/fastreports/gofrcloud"
)
func main() {
subscriptionId := "subscriptionId_example" // string | id of current subscription
selectedFilesVM := *openapiclient.NewSelectedFilesVM("T_example") // SelectedFilesVM | VM with files' ids and params of their destination (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
r, err := apiClient.TemplatesAPI.TemplateFolderAndFileCopyFiles(context.Background(), subscriptionId).SelectedFilesVM(selectedFilesVM).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TemplatesAPI.TemplateFolderAndFileCopyFiles``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
subscriptionId | string | id of current subscription |
Other parameters are passed through a pointer to a apiTemplateFolderAndFileCopyFilesRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
selectedFilesVM | SelectedFilesVM | VM with files' ids and params of their destination |
(empty response body)
- Content-Type: application/json, text/json, application/*+json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CountVM TemplateFolderAndFileCountRecycleBinFoldersAndFiles(ctx, subscriptionId).SearchPattern(searchPattern).UseRegex(useRegex).Execute()
Count all folders and files from recycle bin
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/fastreports/gofrcloud"
)
func main() {
subscriptionId := "subscriptionId_example" // string | subscription id
searchPattern := "searchPattern_example" // string | (optional) (default to "")
useRegex := true // bool | (optional) (default to false)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.TemplatesAPI.TemplateFolderAndFileCountRecycleBinFoldersAndFiles(context.Background(), subscriptionId).SearchPattern(searchPattern).UseRegex(useRegex).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TemplatesAPI.TemplateFolderAndFileCountRecycleBinFoldersAndFiles``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `TemplateFolderAndFileCountRecycleBinFoldersAndFiles`: CountVM
fmt.Fprintf(os.Stdout, "Response from `TemplatesAPI.TemplateFolderAndFileCountRecycleBinFoldersAndFiles`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
subscriptionId | string | subscription id |
Other parameters are passed through a pointer to a apiTemplateFolderAndFileCountRecycleBinFoldersAndFilesRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
searchPattern | string | | [default to ""] useRegex | bool | | [default to false]
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
TemplateFolderAndFileDeleteFiles(ctx, subscriptionId).SelectedFilesVM(selectedFilesVM).Execute()
Delete folders and files
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/fastreports/gofrcloud"
)
func main() {
subscriptionId := "subscriptionId_example" // string | id of current subscription
selectedFilesVM := *openapiclient.NewSelectedFilesVM("T_example") // SelectedFilesVM | VM with files' ids and params of their destination (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
r, err := apiClient.TemplatesAPI.TemplateFolderAndFileDeleteFiles(context.Background(), subscriptionId).SelectedFilesVM(selectedFilesVM).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TemplatesAPI.TemplateFolderAndFileDeleteFiles``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
subscriptionId | string | id of current subscription |
Other parameters are passed through a pointer to a apiTemplateFolderAndFileDeleteFilesRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
selectedFilesVM | SelectedFilesVM | VM with files' ids and params of their destination |
(empty response body)
- Content-Type: application/json, text/json, application/*+json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CountVM TemplateFolderAndFileGetCount(ctx, id).SearchPattern(searchPattern).UseRegex(useRegex).Execute()
Get count of files and folders what contains in a specified folder
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/fastreports/gofrcloud"
)
func main() {
id := "id_example" // string | folder id
searchPattern := "searchPattern_example" // string | string, that must be incuded in file or folder name to be counted <br /> (leave undefined to count all files and folders) (optional)
useRegex := true // bool | set this to true if you want to use regular expression to search (optional) (default to false)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.TemplatesAPI.TemplateFolderAndFileGetCount(context.Background(), id).SearchPattern(searchPattern).UseRegex(useRegex).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TemplatesAPI.TemplateFolderAndFileGetCount``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `TemplateFolderAndFileGetCount`: CountVM
fmt.Fprintf(os.Stdout, "Response from `TemplatesAPI.TemplateFolderAndFileGetCount`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string | folder id |
Other parameters are passed through a pointer to a apiTemplateFolderAndFileGetCountRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
searchPattern | string | string, that must be incuded in file or folder name to be counted <br /> (leave undefined to count all files and folders) | useRegex | bool | set this to true if you want to use regular expression to search | [default to false]
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
FilesVM TemplateFolderAndFileGetFoldersAndFiles(ctx, id).Skip(skip).Take(take).OrderBy(orderBy).Desc(desc).SearchPattern(searchPattern).UseRegex(useRegex).Execute()
Get all folders and files from specified folder
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/fastreports/gofrcloud"
)
func main() {
id := "id_example" // string | folder id
skip := int32(56) // int32 | number of folder and files, that have to be skipped (optional) (default to 0)
take := int32(56) // int32 | number of folder and files, that have to be returned (optional) (default to 10)
orderBy := openapiclient.FileSorting("CreatedTime") // FileSorting | indicates a field to sort by (optional)
desc := true // bool | indicates if sorting is descending (optional) (default to false)
searchPattern := "searchPattern_example" // string | (optional) (default to "")
useRegex := true // bool | (optional) (default to false)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.TemplatesAPI.TemplateFolderAndFileGetFoldersAndFiles(context.Background(), id).Skip(skip).Take(take).OrderBy(orderBy).Desc(desc).SearchPattern(searchPattern).UseRegex(useRegex).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TemplatesAPI.TemplateFolderAndFileGetFoldersAndFiles``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `TemplateFolderAndFileGetFoldersAndFiles`: FilesVM
fmt.Fprintf(os.Stdout, "Response from `TemplatesAPI.TemplateFolderAndFileGetFoldersAndFiles`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string | folder id |
Other parameters are passed through a pointer to a apiTemplateFolderAndFileGetFoldersAndFilesRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
skip | int32 | number of folder and files, that have to be skipped | [default to 0] take | int32 | number of folder and files, that have to be returned | [default to 10] orderBy | FileSorting | indicates a field to sort by | desc | bool | indicates if sorting is descending | [default to false] searchPattern | string | | [default to ""] useRegex | bool | | [default to false]
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
FilesVM TemplateFolderAndFileGetRecycleBinFoldersAndFiles(ctx, subscriptionId).Skip(skip).Take(take).OrderBy(orderBy).Desc(desc).SearchPattern(searchPattern).UseRegex(useRegex).Execute()
Get all folders and files from recycle bin
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/fastreports/gofrcloud"
)
func main() {
subscriptionId := "subscriptionId_example" // string | subscription id
skip := int32(56) // int32 | number of folder and files, that have to be skipped (optional) (default to 0)
take := int32(56) // int32 | number of folder and files, that have to be returned (optional) (default to 10)
orderBy := openapiclient.FileSorting("CreatedTime") // FileSorting | indicates a field to sort by (optional)
desc := true // bool | indicates if sorting is descending (optional) (default to false)
searchPattern := "searchPattern_example" // string | (optional) (default to "")
useRegex := true // bool | (optional) (default to false)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.TemplatesAPI.TemplateFolderAndFileGetRecycleBinFoldersAndFiles(context.Background(), subscriptionId).Skip(skip).Take(take).OrderBy(orderBy).Desc(desc).SearchPattern(searchPattern).UseRegex(useRegex).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TemplatesAPI.TemplateFolderAndFileGetRecycleBinFoldersAndFiles``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `TemplateFolderAndFileGetRecycleBinFoldersAndFiles`: FilesVM
fmt.Fprintf(os.Stdout, "Response from `TemplatesAPI.TemplateFolderAndFileGetRecycleBinFoldersAndFiles`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
subscriptionId | string | subscription id |
Other parameters are passed through a pointer to a apiTemplateFolderAndFileGetRecycleBinFoldersAndFilesRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
skip | int32 | number of folder and files, that have to be skipped | [default to 0] take | int32 | number of folder and files, that have to be returned | [default to 10] orderBy | FileSorting | indicates a field to sort by | desc | bool | indicates if sorting is descending | [default to false] searchPattern | string | | [default to ""] useRegex | bool | | [default to false]
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
TemplateFolderAndFileMoveFiles(ctx, subscriptionId).SelectedFilesVM(selectedFilesVM).Execute()
Move folders and files to a specified folder
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/fastreports/gofrcloud"
)
func main() {
subscriptionId := "subscriptionId_example" // string | id of current subscription
selectedFilesVM := *openapiclient.NewSelectedFilesVM("T_example") // SelectedFilesVM | VM with files' ids and params of their destination (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
r, err := apiClient.TemplatesAPI.TemplateFolderAndFileMoveFiles(context.Background(), subscriptionId).SelectedFilesVM(selectedFilesVM).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TemplatesAPI.TemplateFolderAndFileMoveFiles``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
subscriptionId | string | id of current subscription |
Other parameters are passed through a pointer to a apiTemplateFolderAndFileMoveFilesRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
selectedFilesVM | SelectedFilesVM | VM with files' ids and params of their destination |
(empty response body)
- Content-Type: application/json, text/json, application/*+json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
TemplateFolderAndFileMoveFilesToBin(ctx, subscriptionId).SelectedFilesVM(selectedFilesVM).Execute()
Move folders and files to bin
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/fastreports/gofrcloud"
)
func main() {
subscriptionId := "subscriptionId_example" // string | id of current subscription
selectedFilesVM := *openapiclient.NewSelectedFilesVM("T_example") // SelectedFilesVM | VM with files' ids and params of their destination (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
r, err := apiClient.TemplatesAPI.TemplateFolderAndFileMoveFilesToBin(context.Background(), subscriptionId).SelectedFilesVM(selectedFilesVM).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TemplatesAPI.TemplateFolderAndFileMoveFilesToBin``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
subscriptionId | string | id of current subscription |
Other parameters are passed through a pointer to a apiTemplateFolderAndFileMoveFilesToBinRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
selectedFilesVM | SelectedFilesVM | VM with files' ids and params of their destination |
(empty response body)
- Content-Type: application/json, text/json, application/*+json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
TemplateFolderAndFileRecoverAllFromRecycleBin(ctx, subscriptionId).Execute()
Recover all folders and files from recycle bin
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/fastreports/gofrcloud"
)
func main() {
subscriptionId := "subscriptionId_example" // string | subscription id
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
r, err := apiClient.TemplatesAPI.TemplateFolderAndFileRecoverAllFromRecycleBin(context.Background(), subscriptionId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TemplatesAPI.TemplateFolderAndFileRecoverAllFromRecycleBin``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
subscriptionId | string | subscription id |
Other parameters are passed through a pointer to a apiTemplateFolderAndFileRecoverAllFromRecycleBinRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
(empty response body)
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
TemplateFolderAndFileRecoverFiles(ctx, subscriptionId).SelectedFilesVM(selectedFilesVM).Execute()
Recover folders and files from bin
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/fastreports/gofrcloud"
)
func main() {
subscriptionId := "subscriptionId_example" // string | id of current subscription
selectedFilesVM := *openapiclient.NewSelectedFilesVM("T_example") // SelectedFilesVM | VM with files' ids and params of their destination (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
r, err := apiClient.TemplatesAPI.TemplateFolderAndFileRecoverFiles(context.Background(), subscriptionId).SelectedFilesVM(selectedFilesVM).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TemplatesAPI.TemplateFolderAndFileRecoverFiles``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
subscriptionId | string | id of current subscription |
Other parameters are passed through a pointer to a apiTemplateFolderAndFileRecoverFilesRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
selectedFilesVM | SelectedFilesVM | VM with files' ids and params of their destination |
(empty response body)
- Content-Type: application/json, text/json, application/*+json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
FolderSizeVM TemplateFoldersCalculateFolderSize(ctx, id).Execute()
Get specified folder, calculate it's size
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/fastreports/gofrcloud"
)
func main() {
id := "id_example" // string | folder id
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.TemplatesAPI.TemplateFoldersCalculateFolderSize(context.Background(), id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TemplatesAPI.TemplateFoldersCalculateFolderSize``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `TemplateFoldersCalculateFolderSize`: FolderSizeVM
fmt.Fprintf(os.Stdout, "Response from `TemplatesAPI.TemplateFoldersCalculateFolderSize`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string | folder id |
Other parameters are passed through a pointer to a apiTemplateFoldersCalculateFolderSizeRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
FileVM TemplateFoldersCopyFolder(ctx, id, folderId).Execute()
Move folder to a specified folder
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/fastreports/gofrcloud"
)
func main() {
id := "id_example" // string | moving folder id
folderId := "folderId_example" // string | destination folder id
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.TemplatesAPI.TemplateFoldersCopyFolder(context.Background(), id, folderId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TemplatesAPI.TemplateFoldersCopyFolder``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `TemplateFoldersCopyFolder`: FileVM
fmt.Fprintf(os.Stdout, "Response from `TemplatesAPI.TemplateFoldersCopyFolder`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string | moving folder id | |
folderId | string | destination folder id |
Other parameters are passed through a pointer to a apiTemplateFoldersCopyFolderRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
TemplateFoldersDeleteFolder(ctx, id).Execute()
Delete specified folder
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/fastreports/gofrcloud"
)
func main() {
id := "id_example" // string | folder id
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
r, err := apiClient.TemplatesAPI.TemplateFoldersDeleteFolder(context.Background(), id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TemplatesAPI.TemplateFoldersDeleteFolder``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string | folder id |
Other parameters are passed through a pointer to a apiTemplateFoldersDeleteFolderRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
(empty response body)
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
FileVM TemplateFoldersExport(ctx, id).ExportTemplateVM(exportTemplateVM).Execute()
Export specified template folder to a specified format
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/fastreports/gofrcloud"
)
func main() {
id := "id_example" // string | template folder id
exportTemplateVM := *openapiclient.NewExportTemplateVM("T_example") // ExportTemplateVM | export parameters (string only) (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.TemplatesAPI.TemplateFoldersExport(context.Background(), id).ExportTemplateVM(exportTemplateVM).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TemplatesAPI.TemplateFoldersExport``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `TemplateFoldersExport`: FileVM
fmt.Fprintf(os.Stdout, "Response from `TemplatesAPI.TemplateFoldersExport`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string | template folder id |
Other parameters are passed through a pointer to a apiTemplateFoldersExportRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
exportTemplateVM | ExportTemplateVM | export parameters (string only) |
- Content-Type: application/json, text/json, application/*+json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
BreadcrumbsVM TemplateFoldersGetBreadcrumbs(ctx, id).Execute()
Get specified folder breadcrumbs
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/fastreports/gofrcloud"
)
func main() {
id := "id_example" // string | folder id
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.TemplatesAPI.TemplateFoldersGetBreadcrumbs(context.Background(), id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TemplatesAPI.TemplateFoldersGetBreadcrumbs``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `TemplateFoldersGetBreadcrumbs`: BreadcrumbsVM
fmt.Fprintf(os.Stdout, "Response from `TemplatesAPI.TemplateFoldersGetBreadcrumbs`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string | folder id |
Other parameters are passed through a pointer to a apiTemplateFoldersGetBreadcrumbsRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
FileVM TemplateFoldersGetFolder(ctx, id).Execute()
Get specified folder
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/fastreports/gofrcloud"
)
func main() {
id := "id_example" // string | folder id
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.TemplatesAPI.TemplateFoldersGetFolder(context.Background(), id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TemplatesAPI.TemplateFoldersGetFolder``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `TemplateFoldersGetFolder`: FileVM
fmt.Fprintf(os.Stdout, "Response from `TemplatesAPI.TemplateFoldersGetFolder`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string | folder id |
Other parameters are passed through a pointer to a apiTemplateFoldersGetFolderRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
FilesVM TemplateFoldersGetFolders(ctx, id).Skip(skip).Take(take).OrderBy(orderBy).Desc(desc).SearchPattern(searchPattern).UseRegex(useRegex).Execute()
Get all folders from specified folder
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/fastreports/gofrcloud"
)
func main() {
id := "id_example" // string | folder id
skip := int32(56) // int32 | number of files, that have to be skipped (optional) (default to 0)
take := int32(56) // int32 | number of files, that have to be returned (optional) (default to 10)
orderBy := openapiclient.FileSorting("CreatedTime") // FileSorting | (optional)
desc := true // bool | (optional) (default to false)
searchPattern := "searchPattern_example" // string | (optional) (default to "")
useRegex := true // bool | (optional) (default to false)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.TemplatesAPI.TemplateFoldersGetFolders(context.Background(), id).Skip(skip).Take(take).OrderBy(orderBy).Desc(desc).SearchPattern(searchPattern).UseRegex(useRegex).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TemplatesAPI.TemplateFoldersGetFolders``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `TemplateFoldersGetFolders`: FilesVM
fmt.Fprintf(os.Stdout, "Response from `TemplatesAPI.TemplateFoldersGetFolders`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string | folder id |
Other parameters are passed through a pointer to a apiTemplateFoldersGetFoldersRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
skip | int32 | number of files, that have to be skipped | [default to 0] take | int32 | number of files, that have to be returned | [default to 10] orderBy | FileSorting | | desc | bool | | [default to false] searchPattern | string | | [default to ""] useRegex | bool | | [default to false]
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CountVM TemplateFoldersGetFoldersCount(ctx, id).Execute()
Get count of folders what contains in a specified folder
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/fastreports/gofrcloud"
)
func main() {
id := "id_example" // string | folder id
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.TemplatesAPI.TemplateFoldersGetFoldersCount(context.Background(), id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TemplatesAPI.TemplateFoldersGetFoldersCount``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `TemplateFoldersGetFoldersCount`: CountVM
fmt.Fprintf(os.Stdout, "Response from `TemplatesAPI.TemplateFoldersGetFoldersCount`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string | folder id |
Other parameters are passed through a pointer to a apiTemplateFoldersGetFoldersCountRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
FileVM TemplateFoldersGetOrCreate(ctx).Name(name).SubscriptionId(subscriptionId).ParentId(parentId).Execute()
Get specified folder
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/fastreports/gofrcloud"
)
func main() {
name := "name_example" // string | folder name (optional)
subscriptionId := "subscriptionId_example" // string | subscriptionId (optional)
parentId := "parentId_example" // string | parent folder id (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.TemplatesAPI.TemplateFoldersGetOrCreate(context.Background()).Name(name).SubscriptionId(subscriptionId).ParentId(parentId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TemplatesAPI.TemplateFoldersGetOrCreate``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `TemplateFoldersGetOrCreate`: FileVM
fmt.Fprintf(os.Stdout, "Response from `TemplatesAPI.TemplateFoldersGetOrCreate`: %v\n", resp)
}
Other parameters are passed through a pointer to a apiTemplateFoldersGetOrCreateRequest struct via the builder pattern
Name | Type | Description | Notes |
---|---|---|---|
name | string | folder name | |
subscriptionId | string | subscriptionId | |
parentId | string | parent folder id |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
FilePermissionsVM TemplateFoldersGetPermissions(ctx, id).Execute()
Get all folder permissions
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/fastreports/gofrcloud"
)
func main() {
id := "id_example" // string |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.TemplatesAPI.TemplateFoldersGetPermissions(context.Background(), id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TemplatesAPI.TemplateFoldersGetPermissions``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `TemplateFoldersGetPermissions`: FilePermissionsVM
fmt.Fprintf(os.Stdout, "Response from `TemplatesAPI.TemplateFoldersGetPermissions`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string |
Other parameters are passed through a pointer to a apiTemplateFoldersGetPermissionsRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
FileVM TemplateFoldersGetRootFolder(ctx).SubscriptionId(subscriptionId).Execute()
Get user's root folder (without parents)
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/fastreports/gofrcloud"
)
func main() {
subscriptionId := "subscriptionId_example" // string | (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.TemplatesAPI.TemplateFoldersGetRootFolder(context.Background()).SubscriptionId(subscriptionId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TemplatesAPI.TemplateFoldersGetRootFolder``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `TemplateFoldersGetRootFolder`: FileVM
fmt.Fprintf(os.Stdout, "Response from `TemplatesAPI.TemplateFoldersGetRootFolder`: %v\n", resp)
}
Other parameters are passed through a pointer to a apiTemplateFoldersGetRootFolderRequest struct via the builder pattern
Name | Type | Description | Notes |
---|---|---|---|
subscriptionId | string |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
FileVM TemplateFoldersMoveFolder(ctx, id, folderId).Execute()
Move folder to a specified folder
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/fastreports/gofrcloud"
)
func main() {
id := "id_example" // string | moving folder id
folderId := "folderId_example" // string | destination folder id
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.TemplatesAPI.TemplateFoldersMoveFolder(context.Background(), id, folderId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TemplatesAPI.TemplateFoldersMoveFolder``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `TemplateFoldersMoveFolder`: FileVM
fmt.Fprintf(os.Stdout, "Response from `TemplatesAPI.TemplateFoldersMoveFolder`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string | moving folder id | |
folderId | string | destination folder id |
Other parameters are passed through a pointer to a apiTemplateFoldersMoveFolderRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
TemplateFoldersMoveFolderToBin(ctx, id).Execute()
Move specified folder to recycle bin
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/fastreports/gofrcloud"
)
func main() {
id := "id_example" // string | folder id
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
r, err := apiClient.TemplatesAPI.TemplateFoldersMoveFolderToBin(context.Background(), id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TemplatesAPI.TemplateFoldersMoveFolderToBin``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string | folder id |
Other parameters are passed through a pointer to a apiTemplateFoldersMoveFolderToBinRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
(empty response body)
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
FileVM TemplateFoldersPostFolder(ctx, id).TemplateFolderCreateVM(templateFolderCreateVM).Execute()
Create folder
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/fastreports/gofrcloud"
)
func main() {
id := "id_example" // string | Identifier of parent folder id
templateFolderCreateVM := *openapiclient.NewTemplateFolderCreateVM("T_example") // TemplateFolderCreateVM | create VM (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.TemplatesAPI.TemplateFoldersPostFolder(context.Background(), id).TemplateFolderCreateVM(templateFolderCreateVM).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TemplatesAPI.TemplateFoldersPostFolder``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `TemplateFoldersPostFolder`: FileVM
fmt.Fprintf(os.Stdout, "Response from `TemplatesAPI.TemplateFoldersPostFolder`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string | Identifier of parent folder id |
Other parameters are passed through a pointer to a apiTemplateFoldersPostFolderRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
templateFolderCreateVM | TemplateFolderCreateVM | create VM |
- Content-Type: application/json, text/json, application/*+json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
FileVM TemplateFoldersPrepare(ctx, id).PrepareTemplateVM(prepareTemplateVM).Execute()
Prepare specified template folder to report folder
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/fastreports/gofrcloud"
)
func main() {
id := "id_example" // string | template id
prepareTemplateVM := *openapiclient.NewPrepareTemplateVM("T_example") // PrepareTemplateVM | Template folder prepare view model (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.TemplatesAPI.TemplateFoldersPrepare(context.Background(), id).PrepareTemplateVM(prepareTemplateVM).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TemplatesAPI.TemplateFoldersPrepare``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `TemplateFoldersPrepare`: FileVM
fmt.Fprintf(os.Stdout, "Response from `TemplatesAPI.TemplateFoldersPrepare`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string | template id |
Other parameters are passed through a pointer to a apiTemplateFoldersPrepareRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
prepareTemplateVM | PrepareTemplateVM | Template folder prepare view model |
- Content-Type: application/json, text/json, application/*+json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
TemplateFoldersRecoverFolder(ctx, id).RecoveryPath(recoveryPath).Execute()
Recover specified folder
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/fastreports/gofrcloud"
)
func main() {
id := "id_example" // string | folder id
recoveryPath := "recoveryPath_example" // string | (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
r, err := apiClient.TemplatesAPI.TemplateFoldersRecoverFolder(context.Background(), id).RecoveryPath(recoveryPath).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TemplatesAPI.TemplateFoldersRecoverFolder``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string | folder id |
Other parameters are passed through a pointer to a apiTemplateFoldersRecoverFolderRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
recoveryPath | string | |
(empty response body)
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
FileVM TemplateFoldersRenameFolder(ctx, id).FolderRenameVM(folderRenameVM).Execute()
Rename a folder
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/fastreports/gofrcloud"
)
func main() {
id := "id_example" // string |
folderRenameVM := *openapiclient.NewFolderRenameVM("Name_example", "T_example") // FolderRenameVM | (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.TemplatesAPI.TemplateFoldersRenameFolder(context.Background(), id).FolderRenameVM(folderRenameVM).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TemplatesAPI.TemplateFoldersRenameFolder``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `TemplateFoldersRenameFolder`: FileVM
fmt.Fprintf(os.Stdout, "Response from `TemplatesAPI.TemplateFoldersRenameFolder`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string |
Other parameters are passed through a pointer to a apiTemplateFoldersRenameFolderRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
folderRenameVM | FolderRenameVM | |
- Content-Type: application/json, text/json, application/*+json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
FileVM TemplateFoldersUpdateIcon(ctx, id).FolderIconVM(folderIconVM).Execute()
Update a folder's icon
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/fastreports/gofrcloud"
)
func main() {
id := "id_example" // string | Identifier of folder
folderIconVM := *openapiclient.NewFolderIconVM(string(123), "T_example") // FolderIconVM | Update icon model (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.TemplatesAPI.TemplateFoldersUpdateIcon(context.Background(), id).FolderIconVM(folderIconVM).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TemplatesAPI.TemplateFoldersUpdateIcon``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `TemplateFoldersUpdateIcon`: FileVM
fmt.Fprintf(os.Stdout, "Response from `TemplatesAPI.TemplateFoldersUpdateIcon`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string | Identifier of folder |
Other parameters are passed through a pointer to a apiTemplateFoldersUpdateIconRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
folderIconVM | FolderIconVM | Update icon model |
- Content-Type: application/json, text/json, application/*+json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
TemplateFoldersUpdatePermissions(ctx, id).UpdateFilePermissionsVM(updateFilePermissionsVM).Execute()
Update permissions
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/fastreports/gofrcloud"
)
func main() {
id := "id_example" // string |
updateFilePermissionsVM := *openapiclient.NewUpdateFilePermissionsVM(*openapiclient.NewFilePermissionsCRUDVM("T_example"), openapiclient.FileAdministrate(0), "T_example") // UpdateFilePermissionsVM | (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
r, err := apiClient.TemplatesAPI.TemplateFoldersUpdatePermissions(context.Background(), id).UpdateFilePermissionsVM(updateFilePermissionsVM).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TemplatesAPI.TemplateFoldersUpdatePermissions``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string |
Other parameters are passed through a pointer to a apiTemplateFoldersUpdatePermissionsRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
updateFilePermissionsVM | UpdateFilePermissionsVM | |
(empty response body)
- Content-Type: application/json, text/json, application/*+json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
FileVM TemplateFoldersUpdateTags(ctx, id).FolderTagsUpdateVM(folderTagsUpdateVM).Execute()
Update tags
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/fastreports/gofrcloud"
)
func main() {
id := "id_example" // string |
folderTagsUpdateVM := *openapiclient.NewFolderTagsUpdateVM("T_example") // FolderTagsUpdateVM | (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.TemplatesAPI.TemplateFoldersUpdateTags(context.Background(), id).FolderTagsUpdateVM(folderTagsUpdateVM).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TemplatesAPI.TemplateFoldersUpdateTags``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `TemplateFoldersUpdateTags`: FileVM
fmt.Fprintf(os.Stdout, "Response from `TemplatesAPI.TemplateFoldersUpdateTags`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string |
Other parameters are passed through a pointer to a apiTemplateFoldersUpdateTagsRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
folderTagsUpdateVM | FolderTagsUpdateVM | |
- Content-Type: application/json, text/json, application/*+json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
TemplateVM TemplatesCopyFile(ctx, id, folderId).Execute()
Copy file to a specified folder
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/fastreports/gofrcloud"
)
func main() {
id := "id_example" // string | file id
folderId := "folderId_example" // string | folder id
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.TemplatesAPI.TemplatesCopyFile(context.Background(), id, folderId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TemplatesAPI.TemplatesCopyFile``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `TemplatesCopyFile`: TemplateVM
fmt.Fprintf(os.Stdout, "Response from `TemplatesAPI.TemplatesCopyFile`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string | file id | |
folderId | string | folder id |
Other parameters are passed through a pointer to a apiTemplatesCopyFileRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
FileSharingKeysVM TemplatesCreateSharingKey(ctx, id).CreateFileShareVM(createFileShareVM).Execute()
Create a new key, that can be used to share access to a file (You need Administrate.Anon permission to create a new key)
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/fastreports/gofrcloud"
)
func main() {
id := "id_example" // string | file id
createFileShareVM := *openapiclient.NewCreateFileShareVM() // CreateFileShareVM | parameters for sharing key creation (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.TemplatesAPI.TemplatesCreateSharingKey(context.Background(), id).CreateFileShareVM(createFileShareVM).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TemplatesAPI.TemplatesCreateSharingKey``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `TemplatesCreateSharingKey`: FileSharingKeysVM
fmt.Fprintf(os.Stdout, "Response from `TemplatesAPI.TemplatesCreateSharingKey`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string | file id |
Other parameters are passed through a pointer to a apiTemplatesCreateSharingKeyRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
createFileShareVM | CreateFileShareVM | parameters for sharing key creation |
- Content-Type: application/json, text/json, application/*+json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
TemplatesDeleteFile(ctx, id).Execute()
Delete specified file
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/fastreports/gofrcloud"
)
func main() {
id := "id_example" // string | file id
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
r, err := apiClient.TemplatesAPI.TemplatesDeleteFile(context.Background(), id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TemplatesAPI.TemplatesDeleteFile``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string | file id |
Other parameters are passed through a pointer to a apiTemplatesDeleteFileRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
(empty response body)
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
TemplatesDeleteSharingKey(ctx, id, key).Execute()
Deletes a sharing key, making links, that utilizing it no longer work
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/fastreports/gofrcloud"
)
func main() {
id := "id_example" // string | file id
key := "key_example" // string | key to delete
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
r, err := apiClient.TemplatesAPI.TemplatesDeleteSharingKey(context.Background(), id, key).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TemplatesAPI.TemplatesDeleteSharingKey``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string | file id | |
key | string | key to delete |
Other parameters are passed through a pointer to a apiTemplatesDeleteSharingKeyRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
(empty response body)
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ExportVM TemplatesExport(ctx, id).ExportTemplateVM(exportTemplateVM).Execute()
Export specified report template to a specified format
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/fastreports/gofrcloud"
)
func main() {
id := "id_example" // string | template id
exportTemplateVM := *openapiclient.NewExportTemplateVM("T_example") // ExportTemplateVM | export parameters (string only) (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.TemplatesAPI.TemplatesExport(context.Background(), id).ExportTemplateVM(exportTemplateVM).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TemplatesAPI.TemplatesExport``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `TemplatesExport`: ExportVM
fmt.Fprintf(os.Stdout, "Response from `TemplatesAPI.TemplatesExport`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string | template id |
Other parameters are passed through a pointer to a apiTemplatesExportRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
exportTemplateVM | ExportTemplateVM | export parameters (string only) |
- Content-Type: application/json, text/json, application/*+json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
TemplateVM TemplatesGetFile(ctx, id).Execute()
Get specified file
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/fastreports/gofrcloud"
)
func main() {
id := "id_example" // string | file id
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.TemplatesAPI.TemplatesGetFile(context.Background(), id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TemplatesAPI.TemplatesGetFile``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `TemplatesGetFile`: TemplateVM
fmt.Fprintf(os.Stdout, "Response from `TemplatesAPI.TemplatesGetFile`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string | file id |
Other parameters are passed through a pointer to a apiTemplatesGetFileRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
AuditActionsVM TemplatesGetFileHistory(ctx, id).Skip(skip).Take(take).Execute()
Returns list of actions, performed on this file
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/fastreports/gofrcloud"
)
func main() {
id := "id_example" // string |
skip := int32(56) // int32 | (optional) (default to 0)
take := int32(56) // int32 | (optional) (default to 10)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.TemplatesAPI.TemplatesGetFileHistory(context.Background(), id).Skip(skip).Take(take).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TemplatesAPI.TemplatesGetFileHistory``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `TemplatesGetFileHistory`: AuditActionsVM
fmt.Fprintf(os.Stdout, "Response from `TemplatesAPI.TemplatesGetFileHistory`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string |
Other parameters are passed through a pointer to a apiTemplatesGetFileHistoryRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
skip | int32 | | [default to 0] take | int32 | | [default to 10]
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CountVM TemplatesGetFilesCount(ctx, id).Execute()
Get count of files what contains in a specified folder
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/fastreports/gofrcloud"
)
func main() {
id := "id_example" // string | folder id
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.TemplatesAPI.TemplatesGetFilesCount(context.Background(), id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TemplatesAPI.TemplatesGetFilesCount``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `TemplatesGetFilesCount`: CountVM
fmt.Fprintf(os.Stdout, "Response from `TemplatesAPI.TemplatesGetFilesCount`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string | folder id |
Other parameters are passed through a pointer to a apiTemplatesGetFilesCountRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
TemplatesVM TemplatesGetFilesList(ctx, id).Skip(skip).Take(take).SearchPattern(searchPattern).OrderBy(orderBy).Desc(desc).UseRegex(useRegex).Execute()
Get all files from specified folder.
User with Get Entity permission can access this method.
The method will returns minimal infomration about the file:
id, name, size, editedTime, createdTime, tags, status, statusReason.
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/fastreports/gofrcloud"
)
func main() {
id := "id_example" // string | folder id
skip := int32(56) // int32 | number of files, that have to be skipped (optional) (default to 0)
take := int32(56) // int32 | number of files, that have to be returned (optional) (default to 10)
searchPattern := "searchPattern_example" // string | (optional)
orderBy := openapiclient.FileSorting("CreatedTime") // FileSorting | (optional)
desc := true // bool | (optional) (default to false)
useRegex := true // bool | (optional) (default to false)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.TemplatesAPI.TemplatesGetFilesList(context.Background(), id).Skip(skip).Take(take).SearchPattern(searchPattern).OrderBy(orderBy).Desc(desc).UseRegex(useRegex).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TemplatesAPI.TemplatesGetFilesList``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `TemplatesGetFilesList`: TemplatesVM
fmt.Fprintf(os.Stdout, "Response from `TemplatesAPI.TemplatesGetFilesList`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string | folder id |
Other parameters are passed through a pointer to a apiTemplatesGetFilesListRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
skip | int32 | number of files, that have to be skipped | [default to 0] take | int32 | number of files, that have to be returned | [default to 10] searchPattern | string | | orderBy | FileSorting | | desc | bool | | [default to false] useRegex | bool | | [default to false]
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
FilePermissionsVM TemplatesGetPermissions(ctx, id).Execute()
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/fastreports/gofrcloud"
)
func main() {
id := "id_example" // string |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.TemplatesAPI.TemplatesGetPermissions(context.Background(), id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TemplatesAPI.TemplatesGetPermissions``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `TemplatesGetPermissions`: FilePermissionsVM
fmt.Fprintf(os.Stdout, "Response from `TemplatesAPI.TemplatesGetPermissions`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string |
Other parameters are passed through a pointer to a apiTemplatesGetPermissionsRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
FileSharingKeysVM TemplatesGetSharingKeys(ctx, id).Execute()
Returns all sharing keys, associated with the file
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/fastreports/gofrcloud"
)
func main() {
id := "id_example" // string | file id
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.TemplatesAPI.TemplatesGetSharingKeys(context.Background(), id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TemplatesAPI.TemplatesGetSharingKeys``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `TemplatesGetSharingKeys`: FileSharingKeysVM
fmt.Fprintf(os.Stdout, "Response from `TemplatesAPI.TemplatesGetSharingKeys`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string | file id |
Other parameters are passed through a pointer to a apiTemplatesGetSharingKeysRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
TemplateVM TemplatesMoveFile(ctx, id, folderId).Execute()
Move file to a specified folder
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/fastreports/gofrcloud"
)
func main() {
id := "id_example" // string | file id
folderId := "folderId_example" // string | folder id
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.TemplatesAPI.TemplatesMoveFile(context.Background(), id, folderId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TemplatesAPI.TemplatesMoveFile``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `TemplatesMoveFile`: TemplateVM
fmt.Fprintf(os.Stdout, "Response from `TemplatesAPI.TemplatesMoveFile`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string | file id | |
folderId | string | folder id |
Other parameters are passed through a pointer to a apiTemplatesMoveFileRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
TemplatesMoveFileToBin(ctx, id).Execute()
Move specified file to recycle bin
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/fastreports/gofrcloud"
)
func main() {
id := "id_example" // string | file id
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
r, err := apiClient.TemplatesAPI.TemplatesMoveFileToBin(context.Background(), id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TemplatesAPI.TemplatesMoveFileToBin``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string | file id |
Other parameters are passed through a pointer to a apiTemplatesMoveFileToBinRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
(empty response body)
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ReportVM TemplatesPrepare(ctx, id).PrepareTemplateVM(prepareTemplateVM).Execute()
Prepare specified template to report
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/fastreports/gofrcloud"
)
func main() {
id := "id_example" // string | template id
prepareTemplateVM := *openapiclient.NewPrepareTemplateVM("T_example") // PrepareTemplateVM | Template prepare view model (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.TemplatesAPI.TemplatesPrepare(context.Background(), id).PrepareTemplateVM(prepareTemplateVM).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TemplatesAPI.TemplatesPrepare``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `TemplatesPrepare`: ReportVM
fmt.Fprintf(os.Stdout, "Response from `TemplatesAPI.TemplatesPrepare`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string | template id |
Other parameters are passed through a pointer to a apiTemplatesPrepareRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
prepareTemplateVM | PrepareTemplateVM | Template prepare view model |
- Content-Type: application/json, text/json, application/*+json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
TemplatesRecoverFile(ctx, id).RecoveryPath(recoveryPath).Execute()
Recover specified file from bin
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/fastreports/gofrcloud"
)
func main() {
id := "id_example" // string | file id
recoveryPath := "recoveryPath_example" // string | (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
r, err := apiClient.TemplatesAPI.TemplatesRecoverFile(context.Background(), id).RecoveryPath(recoveryPath).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TemplatesAPI.TemplatesRecoverFile``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string | file id |
Other parameters are passed through a pointer to a apiTemplatesRecoverFileRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
recoveryPath | string | |
(empty response body)
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
TemplateVM TemplatesRenameFile(ctx, id).FileRenameVM(fileRenameVM).Execute()
Rename a file
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/fastreports/gofrcloud"
)
func main() {
id := "id_example" // string |
fileRenameVM := *openapiclient.NewFileRenameVM("T_example") // FileRenameVM | (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.TemplatesAPI.TemplatesRenameFile(context.Background(), id).FileRenameVM(fileRenameVM).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TemplatesAPI.TemplatesRenameFile``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `TemplatesRenameFile`: TemplateVM
fmt.Fprintf(os.Stdout, "Response from `TemplatesAPI.TemplatesRenameFile`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string |
Other parameters are passed through a pointer to a apiTemplatesRenameFileRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
fileRenameVM | FileRenameVM | |
- Content-Type: application/json, text/json, application/*+json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ExportVM TemplatesStaticPreview(ctx, id).PreviewTemplateVM(previewTemplateVM).Execute()
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
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/fastreports/gofrcloud"
)
func main() {
id := "id_example" // string | template id
previewTemplateVM := *openapiclient.NewPreviewTemplateVM("T_example") // PreviewTemplateVM | Model with parameters (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.TemplatesAPI.TemplatesStaticPreview(context.Background(), id).PreviewTemplateVM(previewTemplateVM).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TemplatesAPI.TemplatesStaticPreview``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `TemplatesStaticPreview`: ExportVM
fmt.Fprintf(os.Stdout, "Response from `TemplatesAPI.TemplatesStaticPreview`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string | template id |
Other parameters are passed through a pointer to a apiTemplatesStaticPreviewRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
previewTemplateVM | PreviewTemplateVM | Model with parameters |
- Content-Type: application/json, text/json, application/*+json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
TemplatesUpdateContent(ctx, id).UpdateFileContentVM(updateFileContentVM).Execute()
Updates contnet of the template. The method is deprecated, use the UpdateContentV2 method instead!
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/fastreports/gofrcloud"
)
func main() {
id := "id_example" // string | template id
updateFileContentVM := *openapiclient.NewUpdateFileContentVM(string(123), "T_example") // UpdateFileContentVM | VM with only byte[] with new content (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
r, err := apiClient.TemplatesAPI.TemplatesUpdateContent(context.Background(), id).UpdateFileContentVM(updateFileContentVM).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TemplatesAPI.TemplatesUpdateContent``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string | template id |
Other parameters are passed through a pointer to a apiTemplatesUpdateContentRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
updateFileContentVM | UpdateFileContentVM | VM with only byte[] with new content |
(empty response body)
- Content-Type: application/json, text/json, application/*+json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
TemplatesUpdateContentV2(ctx, id).FileContent(fileContent).Execute()
Updates contnet of the template.
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/fastreports/gofrcloud"
)
func main() {
id := "id_example" // string | template id
fileContent := os.NewFile(1234, "some_file") // *os.File |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
r, err := apiClient.TemplatesAPI.TemplatesUpdateContentV2(context.Background(), id).FileContent(fileContent).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TemplatesAPI.TemplatesUpdateContentV2``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string | template id |
Other parameters are passed through a pointer to a apiTemplatesUpdateContentV2Request struct via the builder pattern
Name | Type | Description | Notes |
---|
fileContent | *os.File | |
(empty response body)
- Content-Type: multipart/form-data
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
TemplateVM TemplatesUpdateIcon(ctx, id).FileIconVM(fileIconVM).Execute()
Update a files's icon
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/fastreports/gofrcloud"
)
func main() {
id := "id_example" // string |
fileIconVM := *openapiclient.NewFileIconVM("T_example") // FileIconVM | (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.TemplatesAPI.TemplatesUpdateIcon(context.Background(), id).FileIconVM(fileIconVM).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TemplatesAPI.TemplatesUpdateIcon``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `TemplatesUpdateIcon`: TemplateVM
fmt.Fprintf(os.Stdout, "Response from `TemplatesAPI.TemplatesUpdateIcon`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string |
Other parameters are passed through a pointer to a apiTemplatesUpdateIconRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
fileIconVM | FileIconVM | |
- Content-Type: application/json, text/json, application/*+json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
TemplatesUpdatePermissions(ctx, id).UpdateFilePermissionsVM(updateFilePermissionsVM).Execute()
Update permissions
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/fastreports/gofrcloud"
)
func main() {
id := "id_example" // string |
updateFilePermissionsVM := *openapiclient.NewUpdateFilePermissionsVM(*openapiclient.NewFilePermissionsCRUDVM("T_example"), openapiclient.FileAdministrate(0), "T_example") // UpdateFilePermissionsVM | (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
r, err := apiClient.TemplatesAPI.TemplatesUpdatePermissions(context.Background(), id).UpdateFilePermissionsVM(updateFilePermissionsVM).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TemplatesAPI.TemplatesUpdatePermissions``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string |
Other parameters are passed through a pointer to a apiTemplatesUpdatePermissionsRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
updateFilePermissionsVM | UpdateFilePermissionsVM | |
(empty response body)
- Content-Type: application/json, text/json, application/*+json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
TemplateVM TemplatesUpdateTags(ctx, id).FileTagsUpdateVM(fileTagsUpdateVM).Execute()
Update tags
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/fastreports/gofrcloud"
)
func main() {
id := "id_example" // string |
fileTagsUpdateVM := *openapiclient.NewFileTagsUpdateVM("T_example") // FileTagsUpdateVM | (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.TemplatesAPI.TemplatesUpdateTags(context.Background(), id).FileTagsUpdateVM(fileTagsUpdateVM).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TemplatesAPI.TemplatesUpdateTags``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `TemplatesUpdateTags`: TemplateVM
fmt.Fprintf(os.Stdout, "Response from `TemplatesAPI.TemplatesUpdateTags`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string |
Other parameters are passed through a pointer to a apiTemplatesUpdateTagsRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
fileTagsUpdateVM | FileTagsUpdateVM | |
- Content-Type: application/json, text/json, application/*+json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
TemplateVM TemplatesUploadFile(ctx, id).TemplateCreateVM(templateCreateVM).Execute()
Upload a file to the specified folder. The method is deprecated, use the UploadFileV2 method instead!
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/fastreports/gofrcloud"
)
func main() {
id := "id_example" // string | Identifier of folder
templateCreateVM := *openapiclient.NewTemplateCreateVM("T_example") // TemplateCreateVM | file's view model (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.TemplatesAPI.TemplatesUploadFile(context.Background(), id).TemplateCreateVM(templateCreateVM).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TemplatesAPI.TemplatesUploadFile``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `TemplatesUploadFile`: TemplateVM
fmt.Fprintf(os.Stdout, "Response from `TemplatesAPI.TemplatesUploadFile`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string | Identifier of folder |
Other parameters are passed through a pointer to a apiTemplatesUploadFileRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
templateCreateVM | TemplateCreateVM | file's view model |
- Content-Type: application/json, text/json, application/*+json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
TemplateVM TemplatesUploadFileV2(ctx, id).FileContent(fileContent).Tags(tags).Icon(icon).Execute()
Alternative api for upload a file to the specified folder!
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/fastreports/gofrcloud"
)
func main() {
id := "id_example" // string | Identifier of folder
fileContent := os.NewFile(1234, "some_file") // *os.File |
tags := []string{"Inner_example"} // []string | (optional)
icon := os.NewFile(1234, "some_file") // *os.File | (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.TemplatesAPI.TemplatesUploadFileV2(context.Background(), id).FileContent(fileContent).Tags(tags).Icon(icon).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TemplatesAPI.TemplatesUploadFileV2``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `TemplatesUploadFileV2`: TemplateVM
fmt.Fprintf(os.Stdout, "Response from `TemplatesAPI.TemplatesUploadFileV2`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string | Identifier of folder |
Other parameters are passed through a pointer to a apiTemplatesUploadFileV2Request struct via the builder pattern
Name | Type | Description | Notes |
---|
fileContent | *os.File | | tags | []string | | icon | *os.File | |
- Content-Type: multipart/form-data
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]