ExportsApi.md

OpenAPI\Client\ExportsApi

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

Method	HTTP request	Description
exportFolderAndFileClearRecycleBin()	DELETE /api/rp/v1/Exports/{subscriptionId}/ClearRecycleBin	Delete all folders and files from recycle bin
exportFolderAndFileCopyFiles()	POST /api/rp/v1/Exports/{subscriptionId}/CopyFiles	Copy folders and files to a specified folder
exportFolderAndFileCountRecycleBinFoldersAndFiles()	GET /api/rp/v1/Exports/{subscriptionId}/CountRecycleBinFolderAndFiles	Count all folders and files from recycle bin
exportFolderAndFileDeleteFiles()	POST /api/rp/v1/Exports/{subscriptionId}/DeleteFiles	Delete folders and files
exportFolderAndFileGetCount()	GET /api/rp/v1/Exports/Folder/{id}/CountFolderAndFiles	Get count of files and folders what contains in a specified folder
exportFolderAndFileGetFoldersAndFiles()	GET /api/rp/v1/Exports/Folder/{id}/ListFolderAndFiles	Get all folders and files from specified folder
exportFolderAndFileGetRecycleBinFoldersAndFiles()	GET /api/rp/v1/Exports/{subscriptionId}/ListRecycleBinFolderAndFiles	Get all folders and files from recycle bin
exportFolderAndFileMoveFiles()	POST /api/rp/v1/Exports/{subscriptionId}/MoveFiles	Move folders and files to a specified folder
exportFolderAndFileMoveFilesToBin()	POST /api/rp/v1/Exports/{subscriptionId}/ToBin	Move folders and files to bin
exportFolderAndFileRecoverAllFromRecycleBin()	POST /api/rp/v1/Exports/{subscriptionId}/RecoverRecycleBin	Recover all folders and files from recycle bin
exportFolderAndFileRecoverFiles()	POST /api/rp/v1/Exports/{subscriptionId}/RecoverFiles	Recover folders and files from bin
exportFoldersCalculateFolderSize()	GET /api/rp/v1/Exports/Folder/{id}/size	Get specified folder, calculate it's size
exportFoldersCopyFolder()	POST /api/rp/v1/Exports/Folder/{id}/Copy/{folderId}	Move folder to a specified folder
exportFoldersDeleteFolder()	DELETE /api/rp/v1/Exports/Folder/{id}	Delete specified folder
exportFoldersGetBreadcrumbs()	GET /api/rp/v1/Exports/Folder/{id}/Breadcrumbs	Get specified folder breadcrumbs
exportFoldersGetFolder()	GET /api/rp/v1/Exports/Folder/{id}	Get specified folder
exportFoldersGetFolders()	GET /api/rp/v1/Exports/Folder/{id}/ListFolders	Get all folders from specified folder
exportFoldersGetFoldersCount()	GET /api/rp/v1/Exports/Folder/{id}/CountFolders	Get count of folders what contains in a specified folder
exportFoldersGetOrCreate()	GET /api/rp/v1/Exports/Folder/getOrCreate	Get specified folder
exportFoldersGetPermissions()	GET /api/rp/v1/Exports/Folder/{id}/permissions	Get all folder permissions
exportFoldersGetRootFolder()	GET /api/rp/v1/Exports/Root	Get user's root folder (without parents)
exportFoldersMoveFolder()	POST /api/rp/v1/Exports/Folder/{id}/Move/{folderId}	Move folder to a specified folder
exportFoldersMoveFolderToBin()	DELETE /api/rp/v1/Exports/Folder/{id}/ToBin	Move specified folder to recycle bin
exportFoldersPostFolder()	POST /api/rp/v1/Exports/Folder/{id}/Folder	Create folder
exportFoldersRecoverFolder()	POST /api/rp/v1/Exports/Folder/{id}/Recover	Recover specified folder
exportFoldersRenameFolder()	PUT /api/rp/v1/Exports/Folder/{id}/Rename	Rename a folder
exportFoldersUpdateIcon()	PUT /api/rp/v1/Exports/Folder/{id}/Icon	Update a folder's icon
exportFoldersUpdatePermissions()	POST /api/rp/v1/Exports/{id}/permissions	Update permissions
exportFoldersUpdateTags()	PUT /api/rp/v1/Exports/Folder/{id}/UpdateTags	Update tags
exportsCopyFile()	POST /api/rp/v1/Exports/File/{id}/Copy/{folderId}	Copy file to a specified folder
exportsCreateSharingKey()	POST /api/rp/v1/Exports/File/{id}/sharingKey	Create a new key, that can be used to share access to a file (You need Administrate.Anon permission to create a new key)
exportsDeleteFile()	DELETE /api/rp/v1/Exports/File/{id}	Delete specified file
exportsDeleteSharingKey()	DELETE /api/rp/v1/Exports/File/{id}/sharingKey	Deletes a sharing key, making links, that utilizing it no longer work
exportsGetFile()	GET /api/rp/v1/Exports/File/{id}	Get export by specified id
exportsGetFileHistory()	GET /api/rp/v1/Exports/File/{id}/History	Returns list of actions, performed on this file
exportsGetFilesCount()	GET /api/rp/v1/Exports/Folder/{id}/CountFiles	Get count of files what contains in a specified folder
exportsGetFilesList()	GET /api/rp/v1/Exports/Folder/{id}/ListFiles	Get all files from specified folder. <br /> User with Get Entity permission can access this method. <br /> The method will returns minimal infomration about the file: <br /> id, name, size, editedTime, createdTime, tags, status, statusReason.
exportsGetPermissions()	GET /api/rp/v1/Exports/File/{id}/permissions
exportsGetSharingKeys()	GET /api/rp/v1/Exports/File/{id}/sharingKeys	Returns all sharing keys, associated with the file
exportsMoveFile()	POST /api/rp/v1/Exports/File/{id}/Move/{folderId}	Move file to a specified folder
exportsMoveFileToBin()	DELETE /api/rp/v1/Exports/File/{id}/ToBin	Move specified file to recycle bin
exportsRecoverFile()	POST /api/rp/v1/Exports/File/{id}/Recover	Recover specified file from bin
exportsRenameFile()	PUT /api/rp/v1/Exports/File/{id}/Rename	Rename a file
exportsUpdateIcon()	PUT /api/rp/v1/Exports/File/{id}/Icon	Update a files's icon
exportsUpdatePermissions()	POST /api/rp/v1/Exports/File/{id}/permissions	Update permissions
exportsUpdateTags()	PUT /api/rp/v1/Exports/File/{id}/UpdateTags	Update tags

exportFolderAndFileClearRecycleBin()

exportFolderAndFileClearRecycleBin($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\ExportsApi(
    // 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->exportFolderAndFileClearRecycleBin($subscription_id);
} catch (Exception $e) {
    echo 'Exception when calling ExportsApi->exportFolderAndFileClearRecycleBin: ', $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]

exportFolderAndFileCopyFiles()

exportFolderAndFileCopyFiles($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\ExportsApi(
    // 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->exportFolderAndFileCopyFiles($subscription_id, $selected_files_vm);
} catch (Exception $e) {
    echo 'Exception when calling ExportsApi->exportFolderAndFileCopyFiles: ', $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]

exportFolderAndFileCountRecycleBinFoldersAndFiles()

exportFolderAndFileCountRecycleBinFoldersAndFiles($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\ExportsApi(
    // 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->exportFolderAndFileCountRecycleBinFoldersAndFiles($subscription_id, $search_pattern, $use_regex);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExportsApi->exportFolderAndFileCountRecycleBinFoldersAndFiles: ', $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]

exportFolderAndFileDeleteFiles()

exportFolderAndFileDeleteFiles($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\ExportsApi(
    // 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->exportFolderAndFileDeleteFiles($subscription_id, $selected_files_vm);
} catch (Exception $e) {
    echo 'Exception when calling ExportsApi->exportFolderAndFileDeleteFiles: ', $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]

exportFolderAndFileGetCount()

exportFolderAndFileGetCount($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\ExportsApi(
    // 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->exportFolderAndFileGetCount($id, $search_pattern, $use_regex);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExportsApi->exportFolderAndFileGetCount: ', $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]

exportFolderAndFileGetFoldersAndFiles()

exportFolderAndFileGetFoldersAndFiles($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\ExportsApi(
    // 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->exportFolderAndFileGetFoldersAndFiles($id, $skip, $take, $order_by, $desc, $search_pattern, $use_regex);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExportsApi->exportFolderAndFileGetFoldersAndFiles: ', $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]

exportFolderAndFileGetRecycleBinFoldersAndFiles()

exportFolderAndFileGetRecycleBinFoldersAndFiles($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\ExportsApi(
    // 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->exportFolderAndFileGetRecycleBinFoldersAndFiles($subscription_id, $skip, $take, $order_by, $desc, $search_pattern, $use_regex);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExportsApi->exportFolderAndFileGetRecycleBinFoldersAndFiles: ', $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]

exportFolderAndFileMoveFiles()

exportFolderAndFileMoveFiles($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\ExportsApi(
    // 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->exportFolderAndFileMoveFiles($subscription_id, $selected_files_vm);
} catch (Exception $e) {
    echo 'Exception when calling ExportsApi->exportFolderAndFileMoveFiles: ', $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]

exportFolderAndFileMoveFilesToBin()

exportFolderAndFileMoveFilesToBin($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\ExportsApi(
    // 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->exportFolderAndFileMoveFilesToBin($subscription_id, $selected_files_vm);
} catch (Exception $e) {
    echo 'Exception when calling ExportsApi->exportFolderAndFileMoveFilesToBin: ', $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]

exportFolderAndFileRecoverAllFromRecycleBin()

exportFolderAndFileRecoverAllFromRecycleBin($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\ExportsApi(
    // 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->exportFolderAndFileRecoverAllFromRecycleBin($subscription_id);
} catch (Exception $e) {
    echo 'Exception when calling ExportsApi->exportFolderAndFileRecoverAllFromRecycleBin: ', $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]

exportFolderAndFileRecoverFiles()

exportFolderAndFileRecoverFiles($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\ExportsApi(
    // 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->exportFolderAndFileRecoverFiles($subscription_id, $selected_files_vm);
} catch (Exception $e) {
    echo 'Exception when calling ExportsApi->exportFolderAndFileRecoverFiles: ', $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]

exportFoldersCalculateFolderSize()

exportFoldersCalculateFolderSize($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\ExportsApi(
    // 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->exportFoldersCalculateFolderSize($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExportsApi->exportFoldersCalculateFolderSize: ', $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]

exportFoldersCopyFolder()

exportFoldersCopyFolder($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\ExportsApi(
    // 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->exportFoldersCopyFolder($id, $folder_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExportsApi->exportFoldersCopyFolder: ', $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]

exportFoldersDeleteFolder()

exportFoldersDeleteFolder($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\ExportsApi(
    // 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->exportFoldersDeleteFolder($id);
} catch (Exception $e) {
    echo 'Exception when calling ExportsApi->exportFoldersDeleteFolder: ', $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]

exportFoldersGetBreadcrumbs()

exportFoldersGetBreadcrumbs($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\ExportsApi(
    // 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->exportFoldersGetBreadcrumbs($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExportsApi->exportFoldersGetBreadcrumbs: ', $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]

exportFoldersGetFolder()

exportFoldersGetFolder($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\ExportsApi(
    // 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->exportFoldersGetFolder($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExportsApi->exportFoldersGetFolder: ', $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]

exportFoldersGetFolders()

exportFoldersGetFolders($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\ExportsApi(
    // 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->exportFoldersGetFolders($id, $skip, $take, $order_by, $desc, $search_pattern, $use_regex);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExportsApi->exportFoldersGetFolders: ', $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]

exportFoldersGetFoldersCount()

exportFoldersGetFoldersCount($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\ExportsApi(
    // 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->exportFoldersGetFoldersCount($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExportsApi->exportFoldersGetFoldersCount: ', $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]

exportFoldersGetOrCreate()

exportFoldersGetOrCreate($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\ExportsApi(
    // 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->exportFoldersGetOrCreate($name, $subscription_id, $parent_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExportsApi->exportFoldersGetOrCreate: ', $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]

exportFoldersGetPermissions()

exportFoldersGetPermissions($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\ExportsApi(
    // 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->exportFoldersGetPermissions($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExportsApi->exportFoldersGetPermissions: ', $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]

exportFoldersGetRootFolder()

exportFoldersGetRootFolder($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\ExportsApi(
    // 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->exportFoldersGetRootFolder($subscription_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExportsApi->exportFoldersGetRootFolder: ', $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]

exportFoldersMoveFolder()

exportFoldersMoveFolder($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\ExportsApi(
    // 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->exportFoldersMoveFolder($id, $folder_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExportsApi->exportFoldersMoveFolder: ', $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]

exportFoldersMoveFolderToBin()

exportFoldersMoveFolderToBin($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\ExportsApi(
    // 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->exportFoldersMoveFolderToBin($id);
} catch (Exception $e) {
    echo 'Exception when calling ExportsApi->exportFoldersMoveFolderToBin: ', $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]

exportFoldersPostFolder()

exportFoldersPostFolder($id, $export_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\ExportsApi(
    // 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
$export_folder_create_vm = new \OpenAPI\Client\cloud\fastreport\model\ExportFolderCreateVM(); // \OpenAPI\Client\cloud\fastreport\model\ExportFolderCreateVM | create VM

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

Parameters

Name	Type	Description	Notes
id	string	Identifier of parent folder id
export_folder_create_vm	\OpenAPI\Client\cloud\fastreport\model\ExportFolderCreateVM	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]

exportFoldersRecoverFolder()

exportFoldersRecoverFolder($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\ExportsApi(
    // 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->exportFoldersRecoverFolder($id, $recovery_path);
} catch (Exception $e) {
    echo 'Exception when calling ExportsApi->exportFoldersRecoverFolder: ', $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]

exportFoldersRenameFolder()

exportFoldersRenameFolder($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\ExportsApi(
    // 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->exportFoldersRenameFolder($id, $folder_rename_vm);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExportsApi->exportFoldersRenameFolder: ', $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]

exportFoldersUpdateIcon()

exportFoldersUpdateIcon($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\ExportsApi(
    // 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->exportFoldersUpdateIcon($id, $folder_icon_vm);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExportsApi->exportFoldersUpdateIcon: ', $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]

exportFoldersUpdatePermissions()

exportFoldersUpdatePermissions($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\ExportsApi(
    // 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->exportFoldersUpdatePermissions($id, $update_file_permissions_vm);
} catch (Exception $e) {
    echo 'Exception when calling ExportsApi->exportFoldersUpdatePermissions: ', $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]

exportFoldersUpdateTags()

exportFoldersUpdateTags($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\ExportsApi(
    // 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->exportFoldersUpdateTags($id, $folder_tags_update_vm);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExportsApi->exportFoldersUpdateTags: ', $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]

exportsCopyFile()

exportsCopyFile($id, $folder_id): \OpenAPI\Client\cloud\fastreport\model\ExportVM

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\ExportsApi(
    // 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->exportsCopyFile($id, $folder_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExportsApi->exportsCopyFile: ', $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\ExportVM

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]

exportsCreateSharingKey()

exportsCreateSharingKey($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\ExportsApi(
    // 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->exportsCreateSharingKey($id, $create_file_share_vm);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExportsApi->exportsCreateSharingKey: ', $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]

exportsDeleteFile()

exportsDeleteFile($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\ExportsApi(
    // 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->exportsDeleteFile($id);
} catch (Exception $e) {
    echo 'Exception when calling ExportsApi->exportsDeleteFile: ', $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]

exportsDeleteSharingKey()

exportsDeleteSharingKey($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\ExportsApi(
    // 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->exportsDeleteSharingKey($id, $key);
} catch (Exception $e) {
    echo 'Exception when calling ExportsApi->exportsDeleteSharingKey: ', $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]

exportsGetFile()

exportsGetFile($id): \OpenAPI\Client\cloud\fastreport\model\ExportVM

Get export by specified id

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\ExportsApi(
    // 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 | id of export

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

Parameters

Name	Type	Description	Notes
id	string	id of export

Return type

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

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]

exportsGetFileHistory()

exportsGetFileHistory($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\ExportsApi(
    // 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->exportsGetFileHistory($id, $skip, $take);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExportsApi->exportsGetFileHistory: ', $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]

exportsGetFilesCount()

exportsGetFilesCount($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\ExportsApi(
    // 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->exportsGetFilesCount($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExportsApi->exportsGetFilesCount: ', $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]

exportsGetFilesList()

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

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\ExportsApi(
    // 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->exportsGetFilesList($id, $skip, $take, $search_pattern, $order_by, $desc, $use_regex);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExportsApi->exportsGetFilesList: ', $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\ExportsVM

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]

exportsGetPermissions()

exportsGetPermissions($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\ExportsApi(
    // 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->exportsGetPermissions($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExportsApi->exportsGetPermissions: ', $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]

exportsGetSharingKeys()

exportsGetSharingKeys($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\ExportsApi(
    // 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->exportsGetSharingKeys($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExportsApi->exportsGetSharingKeys: ', $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]

exportsMoveFile()

exportsMoveFile($id, $folder_id): \OpenAPI\Client\cloud\fastreport\model\ExportVM

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\ExportsApi(
    // 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->exportsMoveFile($id, $folder_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExportsApi->exportsMoveFile: ', $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\ExportVM

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]

exportsMoveFileToBin()

exportsMoveFileToBin($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\ExportsApi(
    // 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->exportsMoveFileToBin($id);
} catch (Exception $e) {
    echo 'Exception when calling ExportsApi->exportsMoveFileToBin: ', $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]

exportsRecoverFile()

exportsRecoverFile($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\ExportsApi(
    // 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->exportsRecoverFile($id, $recovery_path);
} catch (Exception $e) {
    echo 'Exception when calling ExportsApi->exportsRecoverFile: ', $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]

exportsRenameFile()

exportsRenameFile($id, $file_rename_vm): \OpenAPI\Client\cloud\fastreport\model\ExportVM

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\ExportsApi(
    // 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->exportsRenameFile($id, $file_rename_vm);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExportsApi->exportsRenameFile: ', $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\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]

exportsUpdateIcon()

exportsUpdateIcon($id, $file_icon_vm): \OpenAPI\Client\cloud\fastreport\model\ExportVM

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\ExportsApi(
    // 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->exportsUpdateIcon($id, $file_icon_vm);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExportsApi->exportsUpdateIcon: ', $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\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]

exportsUpdatePermissions()

exportsUpdatePermissions($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\ExportsApi(
    // 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->exportsUpdatePermissions($id, $update_file_permissions_vm);
} catch (Exception $e) {
    echo 'Exception when calling ExportsApi->exportsUpdatePermissions: ', $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]

exportsUpdateTags()

exportsUpdateTags($id, $file_tags_update_vm): \OpenAPI\Client\cloud\fastreport\model\ExportVM

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\ExportsApi(
    // 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->exportsUpdateTags($id, $file_tags_update_vm);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExportsApi->exportsUpdateTags: ', $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\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]