TemplatesApi.md

OpenAPI\Client\TemplatesApi

All URIs are relative to http://localhost, except if the operation defines another base path.

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()

templateFolderAndFileClearRecycleBin($subscription_id)

Delete all folders and files from recycle bin

User with a Delete RecycleBin permission can access this method.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\TemplatesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$subscription_id = 'subscription_id_example'; // string | subscription id

try {
    $apiInstance->templateFolderAndFileClearRecycleBin($subscription_id);
} catch (Exception $e) {
    echo 'Exception when calling TemplatesApi->templateFolderAndFileClearRecycleBin: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
subscription_id	string	subscription id

Return type

void (empty response body)

Authorization

ApiKey, JWT

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

templateFolderAndFileCopyFiles()

templateFolderAndFileCopyFiles($subscription_id, $selected_files_vm)

Copy folders and files to a specified folder

User with a Get permission for a files and Create permission for a destination folder can access this method.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\TemplatesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$subscription_id = 'subscription_id_example'; // string | id of current subscription
$selected_files_vm = new \OpenAPI\Client\cloud\fastreport\model\SelectedFilesVM(); // \OpenAPI\Client\cloud\fastreport\model\SelectedFilesVM | VM with files' ids and params of their destination

try {
    $apiInstance->templateFolderAndFileCopyFiles($subscription_id, $selected_files_vm);
} catch (Exception $e) {
    echo 'Exception when calling TemplatesApi->templateFolderAndFileCopyFiles: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
subscription_id	string	id of current subscription
selected_files_vm	\OpenAPI\Client\cloud\fastreport\model\SelectedFilesVM	VM with files' ids and params of their destination	[optional]

Return type

void (empty response body)

Authorization

ApiKey, JWT

HTTP request headers

• 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]

templateFolderAndFileCountRecycleBinFoldersAndFiles()

templateFolderAndFileCountRecycleBinFoldersAndFiles($subscription_id, $search_pattern, $use_regex): \OpenAPI\Client\cloud\fastreport\model\CountVM

Count all folders and files from recycle bin

User with a Get DeletedFiles permission can access this method.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\TemplatesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$subscription_id = 'subscription_id_example'; // string | subscription id
$search_pattern = ''; // string | 
$use_regex = false; // bool | 

try {
    $result = $apiInstance->templateFolderAndFileCountRecycleBinFoldersAndFiles($subscription_id, $search_pattern, $use_regex);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TemplatesApi->templateFolderAndFileCountRecycleBinFoldersAndFiles: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
subscription_id	string	subscription id
search_pattern	string		[optional] [default to '']
use_regex	bool		[optional] [default to false]

Return type

\OpenAPI\Client\cloud\fastreport\model\CountVM

Authorization

ApiKey, JWT

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

templateFolderAndFileDeleteFiles()

templateFolderAndFileDeleteFiles($subscription_id, $selected_files_vm)

Delete folders and files

User with a Delete permission can access this method.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\TemplatesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$subscription_id = 'subscription_id_example'; // string | id of current subscription
$selected_files_vm = new \OpenAPI\Client\cloud\fastreport\model\SelectedFilesVM(); // \OpenAPI\Client\cloud\fastreport\model\SelectedFilesVM | VM with files' ids and params of their destination

try {
    $apiInstance->templateFolderAndFileDeleteFiles($subscription_id, $selected_files_vm);
} catch (Exception $e) {
    echo 'Exception when calling TemplatesApi->templateFolderAndFileDeleteFiles: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
subscription_id	string	id of current subscription
selected_files_vm	\OpenAPI\Client\cloud\fastreport\model\SelectedFilesVM	VM with files' ids and params of their destination	[optional]

Return type

void (empty response body)

Authorization

ApiKey, JWT

HTTP request headers

• 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]

templateFolderAndFileGetCount()

templateFolderAndFileGetCount($id, $search_pattern, $use_regex): \OpenAPI\Client\cloud\fastreport\model\CountVM

Get count of files and folders what contains in a specified folder

User with a Get Count permission can access this method.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\TemplatesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 'id_example'; // string | folder id
$search_pattern = 'search_pattern_example'; // string | string, that must be incuded in file or folder name to be counted <br />              (leave undefined to count all files and folders)
$use_regex = false; // bool | set this to true if you want to use regular expression to search

try {
    $result = $apiInstance->templateFolderAndFileGetCount($id, $search_pattern, $use_regex);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TemplatesApi->templateFolderAndFileGetCount: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	folder id
search_pattern	string	string, that must be incuded in file or folder name to be counted <br /> (leave undefined to count all files and folders)	[optional]
use_regex	bool	set this to true if you want to use regular expression to search	[optional] [default to false]

Return type

\OpenAPI\Client\cloud\fastreport\model\CountVM

Authorization

ApiKey, JWT

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

templateFolderAndFileGetFoldersAndFiles()

templateFolderAndFileGetFoldersAndFiles($id, $skip, $take, $order_by, $desc, $search_pattern, $use_regex): \OpenAPI\Client\cloud\fastreport\model\FilesVM

Get all folders and files from specified folder

User with a Get Entity permission can access this method.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\TemplatesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 'id_example'; // string | folder id
$skip = 0; // int | number of folder and files, that have to be skipped
$take = 10; // int | number of folder and files, that have to be returned
$order_by = new \OpenAPI\Client\cloud\fastreport\model\FileSorting(); // FileSorting | indicates a field to sort by
$desc = false; // bool | indicates if sorting is descending
$search_pattern = ''; // string | 
$use_regex = false; // bool | 

try {
    $result = $apiInstance->templateFolderAndFileGetFoldersAndFiles($id, $skip, $take, $order_by, $desc, $search_pattern, $use_regex);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TemplatesApi->templateFolderAndFileGetFoldersAndFiles: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	folder id
skip	int	number of folder and files, that have to be skipped	[optional] [default to 0]
take	int	number of folder and files, that have to be returned	[optional] [default to 10]
order_by	FileSorting	indicates a field to sort by	[optional]
desc	bool	indicates if sorting is descending	[optional] [default to false]
search_pattern	string		[optional] [default to '']
use_regex	bool		[optional] [default to false]

Return type

\OpenAPI\Client\cloud\fastreport\model\FilesVM

Authorization

ApiKey, JWT

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

templateFolderAndFileGetRecycleBinFoldersAndFiles()

templateFolderAndFileGetRecycleBinFoldersAndFiles($subscription_id, $skip, $take, $order_by, $desc, $search_pattern, $use_regex): \OpenAPI\Client\cloud\fastreport\model\FilesVM

Get all folders and files from recycle bin

User with a Get DeletedFiles permission can access this method.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\TemplatesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$subscription_id = 'subscription_id_example'; // string | subscription id
$skip = 0; // int | number of folder and files, that have to be skipped
$take = 10; // int | number of folder and files, that have to be returned
$order_by = new \OpenAPI\Client\cloud\fastreport\model\FileSorting(); // FileSorting | indicates a field to sort by
$desc = false; // bool | indicates if sorting is descending
$search_pattern = ''; // string | 
$use_regex = false; // bool | 

try {
    $result = $apiInstance->templateFolderAndFileGetRecycleBinFoldersAndFiles($subscription_id, $skip, $take, $order_by, $desc, $search_pattern, $use_regex);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TemplatesApi->templateFolderAndFileGetRecycleBinFoldersAndFiles: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
subscription_id	string	subscription id
skip	int	number of folder and files, that have to be skipped	[optional] [default to 0]
take	int	number of folder and files, that have to be returned	[optional] [default to 10]
order_by	FileSorting	indicates a field to sort by	[optional]
desc	bool	indicates if sorting is descending	[optional] [default to false]
search_pattern	string		[optional] [default to '']
use_regex	bool		[optional] [default to false]

Return type

\OpenAPI\Client\cloud\fastreport\model\FilesVM

Authorization

ApiKey, JWT

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

templateFolderAndFileMoveFiles()

templateFolderAndFileMoveFiles($subscription_id, $selected_files_vm)

Move folders and files to a specified folder

User with a Update Place permission for a files and Create permission for a destination folder can access this method.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\TemplatesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$subscription_id = 'subscription_id_example'; // string | id of current subscription
$selected_files_vm = new \OpenAPI\Client\cloud\fastreport\model\SelectedFilesVM(); // \OpenAPI\Client\cloud\fastreport\model\SelectedFilesVM | VM with files' ids and params of their destination

try {
    $apiInstance->templateFolderAndFileMoveFiles($subscription_id, $selected_files_vm);
} catch (Exception $e) {
    echo 'Exception when calling TemplatesApi->templateFolderAndFileMoveFiles: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
subscription_id	string	id of current subscription
selected_files_vm	\OpenAPI\Client\cloud\fastreport\model\SelectedFilesVM	VM with files' ids and params of their destination	[optional]

Return type

void (empty response body)

Authorization

ApiKey, JWT

HTTP request headers

• 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()

templateFolderAndFileMoveFilesToBin($subscription_id, $selected_files_vm)

Move folders and files to bin

User with a Delete permission can access this method.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\TemplatesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$subscription_id = 'subscription_id_example'; // string | id of current subscription
$selected_files_vm = new \OpenAPI\Client\cloud\fastreport\model\SelectedFilesVM(); // \OpenAPI\Client\cloud\fastreport\model\SelectedFilesVM | VM with files' ids and params of their destination

try {
    $apiInstance->templateFolderAndFileMoveFilesToBin($subscription_id, $selected_files_vm);
} catch (Exception $e) {
    echo 'Exception when calling TemplatesApi->templateFolderAndFileMoveFilesToBin: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
subscription_id	string	id of current subscription
selected_files_vm	\OpenAPI\Client\cloud\fastreport\model\SelectedFilesVM	VM with files' ids and params of their destination	[optional]

Return type

void (empty response body)

Authorization

ApiKey, JWT

HTTP request headers

• 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()

templateFolderAndFileRecoverAllFromRecycleBin($subscription_id)

Recover all folders and files from recycle bin

User with a Create RecycleBin permission can access this method.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\TemplatesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$subscription_id = 'subscription_id_example'; // string | subscription id

try {
    $apiInstance->templateFolderAndFileRecoverAllFromRecycleBin($subscription_id);
} catch (Exception $e) {
    echo 'Exception when calling TemplatesApi->templateFolderAndFileRecoverAllFromRecycleBin: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
subscription_id	string	subscription id

Return type

void (empty response body)

Authorization

ApiKey, JWT

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

templateFolderAndFileRecoverFiles()

templateFolderAndFileRecoverFiles($subscription_id, $selected_files_vm)

Recover folders and files from bin

User with a SubscriptionCreate permission can access this method.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\TemplatesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$subscription_id = 'subscription_id_example'; // string | id of current subscription
$selected_files_vm = new \OpenAPI\Client\cloud\fastreport\model\SelectedFilesVM(); // \OpenAPI\Client\cloud\fastreport\model\SelectedFilesVM | VM with files' ids and params of their destination

try {
    $apiInstance->templateFolderAndFileRecoverFiles($subscription_id, $selected_files_vm);
} catch (Exception $e) {
    echo 'Exception when calling TemplatesApi->templateFolderAndFileRecoverFiles: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
subscription_id	string	id of current subscription
selected_files_vm	\OpenAPI\Client\cloud\fastreport\model\SelectedFilesVM	VM with files' ids and params of their destination	[optional]

Return type

void (empty response body)

Authorization

ApiKey, JWT

HTTP request headers

• 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]

templateFoldersCalculateFolderSize()

templateFoldersCalculateFolderSize($id): \OpenAPI\Client\cloud\fastreport\model\FolderSizeVM

Get specified folder, calculate it's size

User with a Get Entity permission can access this method.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\TemplatesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 'id_example'; // string | folder id

try {
    $result = $apiInstance->templateFoldersCalculateFolderSize($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TemplatesApi->templateFoldersCalculateFolderSize: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	folder id

Return type

\OpenAPI\Client\cloud\fastreport\model\FolderSizeVM

Authorization

ApiKey, JWT

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

templateFoldersCopyFolder()

templateFoldersCopyFolder($id, $folder_id): \OpenAPI\Client\cloud\fastreport\model\FileVM

Move folder to a specified folder

User with a Update Place permission for a folder and Create Entity for a Parent Folder can access this method.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\TemplatesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 'id_example'; // string | moving folder id
$folder_id = 'folder_id_example'; // string | destination folder id

try {
    $result = $apiInstance->templateFoldersCopyFolder($id, $folder_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TemplatesApi->templateFoldersCopyFolder: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	moving folder id
folder_id	string	destination folder id

Return type

\OpenAPI\Client\cloud\fastreport\model\FileVM

Authorization

ApiKey, JWT

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

templateFoldersDeleteFolder()

templateFoldersDeleteFolder($id)

Delete specified folder

User with a Delete Entity permission can access this method.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\TemplatesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 'id_example'; // string | folder id

try {
    $apiInstance->templateFoldersDeleteFolder($id);
} catch (Exception $e) {
    echo 'Exception when calling TemplatesApi->templateFoldersDeleteFolder: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	folder id

Return type

void (empty response body)

Authorization

ApiKey, JWT

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

templateFoldersExport()

templateFoldersExport($id, $export_template_vm): \OpenAPI\Client\cloud\fastreport\model\FileVM

Export specified template folder to a specified format

User with Execute Export permission on template folder and Create Entity on an export folder can access this method.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\TemplatesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 'id_example'; // string | template folder id
$export_template_vm = new \OpenAPI\Client\cloud\fastreport\model\ExportTemplateVM(); // \OpenAPI\Client\cloud\fastreport\model\ExportTemplateVM | export parameters (string only)

try {
    $result = $apiInstance->templateFoldersExport($id, $export_template_vm);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TemplatesApi->templateFoldersExport: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	template folder id
export_template_vm	\OpenAPI\Client\cloud\fastreport\model\ExportTemplateVM	export parameters (string only)	[optional]

Return type

\OpenAPI\Client\cloud\fastreport\model\FileVM

Authorization

ApiKey, JWT

HTTP request headers

• 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]

templateFoldersGetBreadcrumbs()

templateFoldersGetBreadcrumbs($id): \OpenAPI\Client\cloud\fastreport\model\BreadcrumbsVM

Get specified folder breadcrumbs

User with a Get Entity permission can access this method.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\TemplatesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 'id_example'; // string | folder id

try {
    $result = $apiInstance->templateFoldersGetBreadcrumbs($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TemplatesApi->templateFoldersGetBreadcrumbs: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	folder id

Return type

\OpenAPI\Client\cloud\fastreport\model\BreadcrumbsVM

Authorization

ApiKey, JWT

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

templateFoldersGetFolder()

templateFoldersGetFolder($id): \OpenAPI\Client\cloud\fastreport\model\FileVM

Get specified folder

User with a Get Entity permission can access this method.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\TemplatesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 'id_example'; // string | folder id

try {
    $result = $apiInstance->templateFoldersGetFolder($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TemplatesApi->templateFoldersGetFolder: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	folder id

Return type

\OpenAPI\Client\cloud\fastreport\model\FileVM

Authorization

ApiKey, JWT

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

templateFoldersGetFolders()

templateFoldersGetFolders($id, $skip, $take, $order_by, $desc, $search_pattern, $use_regex): \OpenAPI\Client\cloud\fastreport\model\FilesVM

Get all folders from specified folder

User with a Get Entity permission can access this method.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\TemplatesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 'id_example'; // string | folder id
$skip = 0; // int | number of files, that have to be skipped
$take = 10; // int | number of files, that have to be returned
$order_by = new \OpenAPI\Client\cloud\fastreport\model\FileSorting(); // FileSorting | 
$desc = false; // bool | 
$search_pattern = ''; // string | 
$use_regex = false; // bool | 

try {
    $result = $apiInstance->templateFoldersGetFolders($id, $skip, $take, $order_by, $desc, $search_pattern, $use_regex);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TemplatesApi->templateFoldersGetFolders: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	folder id
skip	int	number of files, that have to be skipped	[optional] [default to 0]
take	int	number of files, that have to be returned	[optional] [default to 10]
order_by	FileSorting		[optional]
desc	bool		[optional] [default to false]
search_pattern	string		[optional] [default to '']
use_regex	bool		[optional] [default to false]

Return type

\OpenAPI\Client\cloud\fastreport\model\FilesVM

Authorization

ApiKey, JWT

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

templateFoldersGetFoldersCount()

templateFoldersGetFoldersCount($id): \OpenAPI\Client\cloud\fastreport\model\CountVM

Get count of folders what contains in a specified folder

User with a Get Count permission can access this method.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\TemplatesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 'id_example'; // string | folder id

try {
    $result = $apiInstance->templateFoldersGetFoldersCount($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TemplatesApi->templateFoldersGetFoldersCount: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	folder id

Return type

\OpenAPI\Client\cloud\fastreport\model\CountVM

Authorization

ApiKey, JWT

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

templateFoldersGetOrCreate()

templateFoldersGetOrCreate($name, $subscription_id, $parent_id): \OpenAPI\Client\cloud\fastreport\model\FileVM

Get specified folder

User with a Get Entity permission can access this method.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\TemplatesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$name = 'name_example'; // string | folder name
$subscription_id = 'subscription_id_example'; // string | subscriptionId
$parent_id = 'parent_id_example'; // string | parent folder id

try {
    $result = $apiInstance->templateFoldersGetOrCreate($name, $subscription_id, $parent_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TemplatesApi->templateFoldersGetOrCreate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
name	string	folder name	[optional]
subscription_id	string	subscriptionId	[optional]
parent_id	string	parent folder id	[optional]

Return type

\OpenAPI\Client\cloud\fastreport\model\FileVM

Authorization

ApiKey, JWT

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

templateFoldersGetPermissions()

templateFoldersGetPermissions($id): \OpenAPI\Client\cloud\fastreport\model\FilePermissionsVM

Get all folder permissions

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\TemplatesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 'id_example'; // string | 

try {
    $result = $apiInstance->templateFoldersGetPermissions($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TemplatesApi->templateFoldersGetPermissions: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string

Return type

\OpenAPI\Client\cloud\fastreport\model\FilePermissionsVM

Authorization

ApiKey, JWT

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

templateFoldersGetRootFolder()

templateFoldersGetRootFolder($subscription_id): \OpenAPI\Client\cloud\fastreport\model\FileVM

Get user's root folder (without parents)

Breakchange. Now user model doesn't contain a root folders. This method can return error 400 and 404 when subscription is not found.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\TemplatesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$subscription_id = 'subscription_id_example'; // string

try {
    $result = $apiInstance->templateFoldersGetRootFolder($subscription_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TemplatesApi->templateFoldersGetRootFolder: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
subscription_id	string		[optional]

Return type

\OpenAPI\Client\cloud\fastreport\model\FileVM

Authorization

ApiKey, JWT

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

templateFoldersMoveFolder()

templateFoldersMoveFolder($id, $folder_id): \OpenAPI\Client\cloud\fastreport\model\FileVM

Move folder to a specified folder

User with a Update Place permission for a folder and Create Entity for a Parent Folder can access this method.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\TemplatesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 'id_example'; // string | moving folder id
$folder_id = 'folder_id_example'; // string | destination folder id

try {
    $result = $apiInstance->templateFoldersMoveFolder($id, $folder_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TemplatesApi->templateFoldersMoveFolder: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	moving folder id
folder_id	string	destination folder id

Return type

\OpenAPI\Client\cloud\fastreport\model\FileVM

Authorization

ApiKey, JWT

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

templateFoldersMoveFolderToBin()

templateFoldersMoveFolderToBin($id)

Move specified folder to recycle bin

User with a Delete Entity permission can access this method.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\TemplatesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 'id_example'; // string | folder id

try {
    $apiInstance->templateFoldersMoveFolderToBin($id);
} catch (Exception $e) {
    echo 'Exception when calling TemplatesApi->templateFoldersMoveFolderToBin: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	folder id

Return type

void (empty response body)

Authorization

ApiKey, JWT

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

templateFoldersPostFolder()

templateFoldersPostFolder($id, $template_folder_create_vm): \OpenAPI\Client\cloud\fastreport\model\FileVM

Create folder

User with a Create Entity permisison can access this method.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\TemplatesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 'id_example'; // string | Identifier of parent folder id
$template_folder_create_vm = new \OpenAPI\Client\cloud\fastreport\model\TemplateFolderCreateVM(); // \OpenAPI\Client\cloud\fastreport\model\TemplateFolderCreateVM | create VM

try {
    $result = $apiInstance->templateFoldersPostFolder($id, $template_folder_create_vm);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TemplatesApi->templateFoldersPostFolder: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	Identifier of parent folder id
template_folder_create_vm	\OpenAPI\Client\cloud\fastreport\model\TemplateFolderCreateVM	create VM	[optional]

Return type

\OpenAPI\Client\cloud\fastreport\model\FileVM

Authorization

ApiKey, JWT

HTTP request headers

• 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]

templateFoldersPrepare()

templateFoldersPrepare($id, $prepare_template_vm): \OpenAPI\Client\cloud\fastreport\model\FileVM

Prepare specified template folder to report folder

User with Execute Prepare permission on report and Create Entity on a prepared report folder can access this method.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\TemplatesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 'id_example'; // string | template id
$prepare_template_vm = new \OpenAPI\Client\cloud\fastreport\model\PrepareTemplateVM(); // \OpenAPI\Client\cloud\fastreport\model\PrepareTemplateVM | Template folder prepare view model

try {
    $result = $apiInstance->templateFoldersPrepare($id, $prepare_template_vm);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TemplatesApi->templateFoldersPrepare: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	template id
prepare_template_vm	\OpenAPI\Client\cloud\fastreport\model\PrepareTemplateVM	Template folder prepare view model	[optional]

Return type

\OpenAPI\Client\cloud\fastreport\model\FileVM

Authorization

ApiKey, JWT

HTTP request headers

• 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()

templateFoldersRecoverFolder($id, $recovery_path)

Recover specified folder

User with a Delete Entity permission can access this method.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\TemplatesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 'id_example'; // string | folder id
$recovery_path = 'recovery_path_example'; // string | 

try {
    $apiInstance->templateFoldersRecoverFolder($id, $recovery_path);
} catch (Exception $e) {
    echo 'Exception when calling TemplatesApi->templateFoldersRecoverFolder: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	folder id
recovery_path	string		[optional]

Return type

void (empty response body)

Authorization

ApiKey, JWT

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

templateFoldersRenameFolder()

templateFoldersRenameFolder($id, $folder_rename_vm): \OpenAPI\Client\cloud\fastreport\model\FileVM

Rename a folder

User with a Update Name permision can access this method.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\TemplatesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 'id_example'; // string
$folder_rename_vm = new \OpenAPI\Client\cloud\fastreport\model\FolderRenameVM(); // \OpenAPI\Client\cloud\fastreport\model\FolderRenameVM

try {
    $result = $apiInstance->templateFoldersRenameFolder($id, $folder_rename_vm);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TemplatesApi->templateFoldersRenameFolder: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string
folder_rename_vm	\OpenAPI\Client\cloud\fastreport\model\FolderRenameVM		[optional]

Return type

\OpenAPI\Client\cloud\fastreport\model\FileVM

Authorization

ApiKey, JWT

HTTP request headers

• 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]

templateFoldersUpdateIcon()

templateFoldersUpdateIcon($id, $folder_icon_vm): \OpenAPI\Client\cloud\fastreport\model\FileVM

Update a folder's icon

User with a Update Icon permission can access this method.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\TemplatesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 'id_example'; // string | Identifier of folder
$folder_icon_vm = new \OpenAPI\Client\cloud\fastreport\model\FolderIconVM(); // \OpenAPI\Client\cloud\fastreport\model\FolderIconVM | Update icon model

try {
    $result = $apiInstance->templateFoldersUpdateIcon($id, $folder_icon_vm);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TemplatesApi->templateFoldersUpdateIcon: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	Identifier of folder
folder_icon_vm	\OpenAPI\Client\cloud\fastreport\model\FolderIconVM	Update icon model	[optional]

Return type

\OpenAPI\Client\cloud\fastreport\model\FileVM

Authorization

ApiKey, JWT

HTTP request headers

• 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()

templateFoldersUpdatePermissions($id, $update_file_permissions_vm)

Update permissions

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\TemplatesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 'id_example'; // string | 
$update_file_permissions_vm = new \OpenAPI\Client\cloud\fastreport\model\UpdateFilePermissionsVM(); // \OpenAPI\Client\cloud\fastreport\model\UpdateFilePermissionsVM | 

try {
    $apiInstance->templateFoldersUpdatePermissions($id, $update_file_permissions_vm);
} catch (Exception $e) {
    echo 'Exception when calling TemplatesApi->templateFoldersUpdatePermissions: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string
update_file_permissions_vm	\OpenAPI\Client\cloud\fastreport\model\UpdateFilePermissionsVM		[optional]

Return type

void (empty response body)

Authorization

ApiKey, JWT

HTTP request headers

• 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]

templateFoldersUpdateTags()

templateFoldersUpdateTags($id, $folder_tags_update_vm): \OpenAPI\Client\cloud\fastreport\model\FileVM

Update tags

User with a Update Tags permission can access this method.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\TemplatesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 'id_example'; // string
$folder_tags_update_vm = new \OpenAPI\Client\cloud\fastreport\model\FolderTagsUpdateVM(); // \OpenAPI\Client\cloud\fastreport\model\FolderTagsUpdateVM

try {
    $result = $apiInstance->templateFoldersUpdateTags($id, $folder_tags_update_vm);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TemplatesApi->templateFoldersUpdateTags: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string
folder_tags_update_vm	\OpenAPI\Client\cloud\fastreport\model\FolderTagsUpdateVM		[optional]

Return type

\OpenAPI\Client\cloud\fastreport\model\FileVM

Authorization

ApiKey, JWT

HTTP request headers

• 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]

templatesCopyFile()

templatesCopyFile($id, $folder_id): \OpenAPI\Client\cloud\fastreport\model\TemplateVM

Copy file to a specified folder

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\TemplatesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 'id_example'; // string | file id
$folder_id = 'folder_id_example'; // string | folder id

try {
    $result = $apiInstance->templatesCopyFile($id, $folder_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TemplatesApi->templatesCopyFile: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	file id
folder_id	string	folder id

Return type

\OpenAPI\Client\cloud\fastreport\model\TemplateVM

Authorization

ApiKey, JWT

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

templatesCreateSharingKey()

templatesCreateSharingKey($id, $create_file_share_vm): \OpenAPI\Client\cloud\fastreport\model\FileSharingKeysVM

Create a new key, that can be used to share access to a file (You need Administrate.Anon permission to create a new key)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\TemplatesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 'id_example'; // string | file id
$create_file_share_vm = new \OpenAPI\Client\cloud\fastreport\model\CreateFileShareVM(); // \OpenAPI\Client\cloud\fastreport\model\CreateFileShareVM | parameters for sharing key creation

try {
    $result = $apiInstance->templatesCreateSharingKey($id, $create_file_share_vm);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TemplatesApi->templatesCreateSharingKey: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	file id
create_file_share_vm	\OpenAPI\Client\cloud\fastreport\model\CreateFileShareVM	parameters for sharing key creation	[optional]

Return type

\OpenAPI\Client\cloud\fastreport\model\FileSharingKeysVM

Authorization

ApiKey, JWT

HTTP request headers

• 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()

templatesDeleteFile($id)

Delete specified file

User with Delete permission can access the method.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\TemplatesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 'id_example'; // string | file id

try {
    $apiInstance->templatesDeleteFile($id);
} catch (Exception $e) {
    echo 'Exception when calling TemplatesApi->templatesDeleteFile: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	file id

Return type

void (empty response body)

Authorization

ApiKey, JWT

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

templatesDeleteSharingKey()

templatesDeleteSharingKey($id, $key)

Deletes a sharing key, making links, that utilizing it no longer work

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\TemplatesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 'id_example'; // string | file id
$key = 'key_example'; // string | key to delete

try {
    $apiInstance->templatesDeleteSharingKey($id, $key);
} catch (Exception $e) {
    echo 'Exception when calling TemplatesApi->templatesDeleteSharingKey: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	file id
key	string	key to delete

Return type

void (empty response body)

Authorization

ApiKey, JWT

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

templatesExport()

templatesExport($id, $export_template_vm): \OpenAPI\Client\cloud\fastreport\model\ExportVM

Export specified report template to a specified format

User with Execute Export permission on prepared report and Create Entity on an export folder can access this method.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\TemplatesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 'id_example'; // string | template id
$export_template_vm = new \OpenAPI\Client\cloud\fastreport\model\ExportTemplateVM(); // \OpenAPI\Client\cloud\fastreport\model\ExportTemplateVM | export parameters (string only)

try {
    $result = $apiInstance->templatesExport($id, $export_template_vm);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TemplatesApi->templatesExport: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	template id
export_template_vm	\OpenAPI\Client\cloud\fastreport\model\ExportTemplateVM	export parameters (string only)	[optional]

Return type

\OpenAPI\Client\cloud\fastreport\model\ExportVM

Authorization

ApiKey, JWT

HTTP request headers

• 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]

templatesGetFile()

templatesGetFile($id): \OpenAPI\Client\cloud\fastreport\model\TemplateVM

Get specified file

User with Get Entity permission can access this method.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\TemplatesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 'id_example'; // string | file id

try {
    $result = $apiInstance->templatesGetFile($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TemplatesApi->templatesGetFile: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	file id

Return type

\OpenAPI\Client\cloud\fastreport\model\TemplateVM

Authorization

ApiKey, JWT

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

templatesGetFileHistory()

templatesGetFileHistory($id, $skip, $take): \OpenAPI\Client\cloud\fastreport\model\AuditActionsVM

Returns list of actions, performed on this file

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\TemplatesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 'id_example'; // string | 
$skip = 0; // int | 
$take = 10; // int | 

try {
    $result = $apiInstance->templatesGetFileHistory($id, $skip, $take);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TemplatesApi->templatesGetFileHistory: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string
skip	int		[optional] [default to 0]
take	int		[optional] [default to 10]

Return type

\OpenAPI\Client\cloud\fastreport\model\AuditActionsVM

Authorization

ApiKey, JWT

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

templatesGetFilesCount()

templatesGetFilesCount($id): \OpenAPI\Client\cloud\fastreport\model\CountVM

Get count of files what contains in a specified folder

User with Get Count permission can access this method.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\TemplatesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 'id_example'; // string | folder id

try {
    $result = $apiInstance->templatesGetFilesCount($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TemplatesApi->templatesGetFilesCount: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	folder id

Return type

\OpenAPI\Client\cloud\fastreport\model\CountVM

Authorization

ApiKey, JWT

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

templatesGetFilesList()

templatesGetFilesList($id, $skip, $take, $search_pattern, $order_by, $desc, $use_regex): \OpenAPI\Client\cloud\fastreport\model\TemplatesVM

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.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\TemplatesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 'id_example'; // string | folder id
$skip = 0; // int | number of files, that have to be skipped
$take = 10; // int | number of files, that have to be returned
$search_pattern = 'search_pattern_example'; // string | 
$order_by = new \OpenAPI\Client\cloud\fastreport\model\FileSorting(); // FileSorting | 
$desc = false; // bool | 
$use_regex = false; // bool | 

try {
    $result = $apiInstance->templatesGetFilesList($id, $skip, $take, $search_pattern, $order_by, $desc, $use_regex);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TemplatesApi->templatesGetFilesList: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	folder id
skip	int	number of files, that have to be skipped	[optional] [default to 0]
take	int	number of files, that have to be returned	[optional] [default to 10]
search_pattern	string		[optional]
order_by	FileSorting		[optional]
desc	bool		[optional] [default to false]
use_regex	bool		[optional] [default to false]

Return type

\OpenAPI\Client\cloud\fastreport\model\TemplatesVM

Authorization

ApiKey, JWT

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

templatesGetPermissions()

templatesGetPermissions($id): \OpenAPI\Client\cloud\fastreport\model\FilePermissionsVM

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\TemplatesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 'id_example'; // string

try {
    $result = $apiInstance->templatesGetPermissions($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TemplatesApi->templatesGetPermissions: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string

Return type

\OpenAPI\Client\cloud\fastreport\model\FilePermissionsVM

Authorization

ApiKey, JWT

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

templatesGetSharingKeys()

templatesGetSharingKeys($id): \OpenAPI\Client\cloud\fastreport\model\FileSharingKeysVM

Returns all sharing keys, associated with the file

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\TemplatesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 'id_example'; // string | file id

try {
    $result = $apiInstance->templatesGetSharingKeys($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TemplatesApi->templatesGetSharingKeys: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	file id

Return type

\OpenAPI\Client\cloud\fastreport\model\FileSharingKeysVM

Authorization

ApiKey, JWT

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

templatesMoveFile()

templatesMoveFile($id, $folder_id): \OpenAPI\Client\cloud\fastreport\model\TemplateVM

Move file to a specified folder

User with a Update Place permission for a folder and Create Entity for a Parent Folder can access this method.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\TemplatesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 'id_example'; // string | file id
$folder_id = 'folder_id_example'; // string | folder id

try {
    $result = $apiInstance->templatesMoveFile($id, $folder_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TemplatesApi->templatesMoveFile: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	file id
folder_id	string	folder id

Return type

\OpenAPI\Client\cloud\fastreport\model\TemplateVM

Authorization

ApiKey, JWT

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

templatesMoveFileToBin()

templatesMoveFileToBin($id)

Move specified file to recycle bin

User with Delete permission can access the method.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\TemplatesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 'id_example'; // string | file id

try {
    $apiInstance->templatesMoveFileToBin($id);
} catch (Exception $e) {
    echo 'Exception when calling TemplatesApi->templatesMoveFileToBin: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	file id

Return type

void (empty response body)

Authorization

ApiKey, JWT

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

templatesPrepare()

templatesPrepare($id, $prepare_template_vm): \OpenAPI\Client\cloud\fastreport\model\ReportVM

Prepare specified template to report

User with Execute Prepare permission on report and Create Entity on a prepared report folder can access this method.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\TemplatesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 'id_example'; // string | template id
$prepare_template_vm = new \OpenAPI\Client\cloud\fastreport\model\PrepareTemplateVM(); // \OpenAPI\Client\cloud\fastreport\model\PrepareTemplateVM | Template prepare view model

try {
    $result = $apiInstance->templatesPrepare($id, $prepare_template_vm);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TemplatesApi->templatesPrepare: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	template id
prepare_template_vm	\OpenAPI\Client\cloud\fastreport\model\PrepareTemplateVM	Template prepare view model	[optional]

Return type

\OpenAPI\Client\cloud\fastreport\model\ReportVM

Authorization

ApiKey, JWT

HTTP request headers

• 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()

templatesRecoverFile($id, $recovery_path)

Recover specified file from bin

User with Delete permission can access the method.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\TemplatesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 'id_example'; // string | file id
$recovery_path = 'recovery_path_example'; // string | 

try {
    $apiInstance->templatesRecoverFile($id, $recovery_path);
} catch (Exception $e) {
    echo 'Exception when calling TemplatesApi->templatesRecoverFile: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	file id
recovery_path	string		[optional]

Return type

void (empty response body)

Authorization

ApiKey, JWT

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

templatesRenameFile()

templatesRenameFile($id, $file_rename_vm): \OpenAPI\Client\cloud\fastreport\model\TemplateVM

Rename a file

User with Update Name permission can access this method.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\TemplatesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 'id_example'; // string
$file_rename_vm = new \OpenAPI\Client\cloud\fastreport\model\FileRenameVM(); // \OpenAPI\Client\cloud\fastreport\model\FileRenameVM

try {
    $result = $apiInstance->templatesRenameFile($id, $file_rename_vm);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TemplatesApi->templatesRenameFile: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string
file_rename_vm	\OpenAPI\Client\cloud\fastreport\model\FileRenameVM		[optional]

Return type

\OpenAPI\Client\cloud\fastreport\model\TemplateVM

Authorization

ApiKey, JWT

HTTP request headers

• 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]

templatesStaticPreview()

templatesStaticPreview($id, $preview_template_vm): \OpenAPI\Client\cloud\fastreport\model\ExportVM

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\TemplatesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 'id_example'; // string | template id
$preview_template_vm = new \OpenAPI\Client\cloud\fastreport\model\PreviewTemplateVM(); // \OpenAPI\Client\cloud\fastreport\model\PreviewTemplateVM | Model with parameters

try {
    $result = $apiInstance->templatesStaticPreview($id, $preview_template_vm);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TemplatesApi->templatesStaticPreview: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	template id
preview_template_vm	\OpenAPI\Client\cloud\fastreport\model\PreviewTemplateVM	Model with parameters	[optional]

Return type

\OpenAPI\Client\cloud\fastreport\model\ExportVM

Authorization

ApiKey, JWT

HTTP request headers

• 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()

templatesUpdateContent($id, $update_file_content_vm)

Updates contnet of the template. The method is deprecated, use the UpdateContentV2 method instead!

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\TemplatesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 'id_example'; // string | template id
$update_file_content_vm = new \OpenAPI\Client\cloud\fastreport\model\UpdateFileContentVM(); // \OpenAPI\Client\cloud\fastreport\model\UpdateFileContentVM | VM with only byte[] with new content

try {
    $apiInstance->templatesUpdateContent($id, $update_file_content_vm);
} catch (Exception $e) {
    echo 'Exception when calling TemplatesApi->templatesUpdateContent: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	template id
update_file_content_vm	\OpenAPI\Client\cloud\fastreport\model\UpdateFileContentVM	VM with only byte[] with new content	[optional]

Return type

void (empty response body)

Authorization

ApiKey, JWT

HTTP request headers

• 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()

templatesUpdateContentV2($id, $file_content)

Updates contnet of the template.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\TemplatesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 'id_example'; // string | template id
$file_content = "/path/to/file.txt"; // \SplFileObject

try {
    $apiInstance->templatesUpdateContentV2($id, $file_content);
} catch (Exception $e) {
    echo 'Exception when calling TemplatesApi->templatesUpdateContentV2: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	template id
file_content	\SplFileObject**\SplFileObject**

Return type

void (empty response body)

Authorization

ApiKey, JWT

HTTP request headers

• Content-Type: multipart/form-data
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

templatesUpdateIcon()

templatesUpdateIcon($id, $file_icon_vm): \OpenAPI\Client\cloud\fastreport\model\TemplateVM

Update a files's icon

User with Update Icon permission can access this method.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\TemplatesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 'id_example'; // string
$file_icon_vm = new \OpenAPI\Client\cloud\fastreport\model\FileIconVM(); // \OpenAPI\Client\cloud\fastreport\model\FileIconVM

try {
    $result = $apiInstance->templatesUpdateIcon($id, $file_icon_vm);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TemplatesApi->templatesUpdateIcon: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string
file_icon_vm	\OpenAPI\Client\cloud\fastreport\model\FileIconVM		[optional]

Return type

\OpenAPI\Client\cloud\fastreport\model\TemplateVM

Authorization

ApiKey, JWT

HTTP request headers

• 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()

templatesUpdatePermissions($id, $update_file_permissions_vm)

Update permissions

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\TemplatesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 'id_example'; // string | 
$update_file_permissions_vm = new \OpenAPI\Client\cloud\fastreport\model\UpdateFilePermissionsVM(); // \OpenAPI\Client\cloud\fastreport\model\UpdateFilePermissionsVM | 

try {
    $apiInstance->templatesUpdatePermissions($id, $update_file_permissions_vm);
} catch (Exception $e) {
    echo 'Exception when calling TemplatesApi->templatesUpdatePermissions: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string
update_file_permissions_vm	\OpenAPI\Client\cloud\fastreport\model\UpdateFilePermissionsVM		[optional]

Return type

void (empty response body)

Authorization

ApiKey, JWT

HTTP request headers

• 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]

templatesUpdateTags()

templatesUpdateTags($id, $file_tags_update_vm): \OpenAPI\Client\cloud\fastreport\model\TemplateVM

Update tags

User with Update Tags permission can access this method.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\TemplatesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 'id_example'; // string
$file_tags_update_vm = new \OpenAPI\Client\cloud\fastreport\model\FileTagsUpdateVM(); // \OpenAPI\Client\cloud\fastreport\model\FileTagsUpdateVM

try {
    $result = $apiInstance->templatesUpdateTags($id, $file_tags_update_vm);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TemplatesApi->templatesUpdateTags: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string
file_tags_update_vm	\OpenAPI\Client\cloud\fastreport\model\FileTagsUpdateVM		[optional]

Return type

\OpenAPI\Client\cloud\fastreport\model\TemplateVM

Authorization

ApiKey, JWT

HTTP request headers

• 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]

templatesUploadFile()

templatesUploadFile($id, $template_create_vm): \OpenAPI\Client\cloud\fastreport\model\TemplateVM

Upload a file to the specified folder. The method is deprecated, use the UploadFileV2 method instead!

User with Create Entity permission can access this method.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\TemplatesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 'id_example'; // string | Identifier of folder
$template_create_vm = new \OpenAPI\Client\cloud\fastreport\model\TemplateCreateVM(); // \OpenAPI\Client\cloud\fastreport\model\TemplateCreateVM | file's view model

try {
    $result = $apiInstance->templatesUploadFile($id, $template_create_vm);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TemplatesApi->templatesUploadFile: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	Identifier of folder
template_create_vm	\OpenAPI\Client\cloud\fastreport\model\TemplateCreateVM	file's view model	[optional]

Return type

\OpenAPI\Client\cloud\fastreport\model\TemplateVM

Authorization

ApiKey, JWT

HTTP request headers

• 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]

templatesUploadFileV2()

templatesUploadFileV2($id, $file_content, $tags, $icon): \OpenAPI\Client\cloud\fastreport\model\TemplateVM

Alternative api for upload a file to the specified folder!

User with Create Entity permission can access this method.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer (JWT) authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\TemplatesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 'id_example'; // string | Identifier of folder
$file_content = "/path/to/file.txt"; // \SplFileObject
$tags = array('tags_example'); // string[]
$icon = "/path/to/file.txt"; // \SplFileObject

try {
    $result = $apiInstance->templatesUploadFileV2($id, $file_content, $tags, $icon);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TemplatesApi->templatesUploadFileV2: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	Identifier of folder
file_content	\SplFileObject**\SplFileObject**
tags	string[]		[optional]
icon	\SplFileObject**\SplFileObject**		[optional]

Return type

\OpenAPI\Client\cloud\fastreport\model\TemplateVM

Authorization

ApiKey, JWT

HTTP request headers

• Content-Type: multipart/form-data
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]