ReportFolders

Reports

Export

Export specified report folder to a specified format

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

Request

POST /api/rp/v1/Reports/Folder/{id}/Export

Parameters

Name	Type	Value	Notes
*id	string		report folder id
body			export parameters

Responses

Status Code	Description	Samples
200	Specified report folder has been exported
400	Report folder Id is null
403	You don't have rights for the operation
402	Subscription is outdated
404	Exports folder not found

GetPermissions

Get all folder permissions

Request

GET /api/rp/v1/Reports/Folder/{id}/permissions

Parameters

Name	Type	Value	Notes
*id	string

Responses

Status Code	Description	Samples
200	returned permissions
400	id is not valid
402	Subscription is blocked
403	You don't have rights for the operation
404	Folder or subscription not found

GetMyPermissions

Get user's permissions for a folder by id

Request

GET /api/rp/v1/Reports/Folder/{folderId}/mypermissions

Parameters

Name	Type	Value	Notes
*folderId	string		folder id

Responses

Status Code	Description	Samples
200	Succesfully returned
400	Bad Request

UpdatePermissions

Update permissions

Request

POST /api/rp/v1/Reports/{id}/permissions

Parameters

Name	Type	Value	Notes
*id	string
body

Responses

Status Code	Description	Samples
204	Folder's permissions has been updated
400	Id or VM is not valid
402	Subscription is outdated
403	You don't have rights for the operation
404	Folder or subscription not found
500	Try again, if error still here - text our support

DeleteFolder

Delete specified folder

User with a Delete Entity permission can access this method.

Request

DELETE /api/rp/v1/Reports/Folder/{id}

Parameters

Name	Type	Value	Notes
*id	string		folder id

Responses

Status Code	Description	Samples
204	Folder succesfully deleted
400	Id is null
402	Subscription is outdated
403	You don't have rights for the operation
404	Folder or subscription not found
500	Try again, if error still here - text our support

GetFolder

Get specified folder

User with a Get Entity permission can access this method.

Request

GET /api/rp/v1/Reports/Folder/{id}

Parameters

Name	Type	Value	Notes
*id	string		folder id

Responses

Status Code	Description	Samples
200	Returns specified folder
400	Id is null
402	Subscription is blocked
403	You don't have rights for the operation
404	Folder or subscription not found
500	Try again, if error still here - text our support

MoveFolderToBin

Move specified folder to recycle bin

User with a Delete Entity permission can access this method.

Request

DELETE /api/rp/v1/Reports/Folder/{id}/ToBin

Parameters

Name	Type	Value	Notes
*id	string		folder id

Responses

Status Code	Description	Samples
204	Folder succesfully deleted
400	Id is null
402	Subscription is outdated
403	You don't have rights for the operation
404	Folder or subscription not found
500	Try again, if error still here - text our support

RecoverFolder

Recover specified folder

User with a Delete Entity permission can access this method.

Request

POST /api/rp/v1/Reports/Folder/{id}/Recover[?recoveryPath]

Parameters

Name	Type	Value	Notes
*id	string		folder id
recoveryPath	string

Responses

Status Code	Description	Samples
204	Folder succesfully restored from bin
400	Id is null
402	Subscription is outdated
403	You don't have rights for the operation
404	Folder or subscription not found
500	Try again, if error still here - text our support

GetBreadcrumbs

Get specified folder breadcrumbs

User with a Get Entity permission can access this method.

Request

GET /api/rp/v1/Reports/Folder/{id}/Breadcrumbs

Parameters

Name	Type	Value	Notes
*id	string		folder id

Responses

Status Code	Description	Samples
200	Returns breadcrumbs parents list (starts from root folder)
400	folderId is null
402	Subscription is blocked
403	You don't have rights for the operation
404	Folder or subscription not found
500	Try again, if error still here - text our support

CalculateFolderSize

Get specified folder, calculate it's size

User with a Get Entity permission can access this method.

Request

GET /api/rp/v1/Reports/Folder/{id}/size

Parameters

Name	Type	Value	Notes
*id	string		folder id

Responses

Status Code	Description	Samples
200	Returns specified folder
400	Id is null
402	Subscription is blocked
403	You don't have rights for the operation
404	Folder or subscription not found
500	Try again, if error still here - text our support

GetOrCreate

Get specified folder

User with a Get Entity permission can access this method.

Request

GET /api/rp/v1/Reports/Folder/getOrCreate[?name&subscriptionId&parentId]

Parameters

Name	Type	Notes
name	string	folder name
subscriptionId	string	subscriptionId
parentId	string	parent folder id

Responses

Status Code	Description	Samples
200	Returns specified folder
400	Name or 1 of ids is not valid
402	Subscription is blocked
403	You don't have rights for the operation
404	Subscription not found
500	Try again, if error still here - text our support

GetFolders

Get all folders from specified folder

User with a Get Entity permission can access this method.

Request

GET /api/rp/v1/Reports/Folder/{id}/ListFolders[?skip&take&orderBy&desc&searchPattern&useRegex]

Parameters

Name	Type	Value	Notes
*id	string		folder id
skip	integer	0	number of files, that have to be skipped
take	integer	10	number of files, that have to be returned
orderBy
desc	boolean	False
searchPattern	string
useRegex	boolean	False

Responses

Status Code	Description	Samples
200	Gets all folders from a specified folder
400	1 of params is not valid
402	Subscription is blocked
403	You don't have rights for the operation
404	Folder or subscription not found
500	Try again, if error still here - text our support

GetFoldersCount

Get count of folders what contains in a specified folder

User with a Get Count permission can access this method.

Request

GET /api/rp/v1/Reports/Folder/{id}/CountFolders

Parameters

Name	Type	Value	Notes
*id	string		folder id

Responses

Status Code	Description	Samples
200	Returns count of folders in a specified folder
400	folderId is null
402	Subscription is blocked
403	You don't have rights for the operation
404	Folder or subscription not found
500	Try again, if error still here - text our support

GetRootFolder

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.

Request

GET /api/rp/v1/Reports/Root[?subscriptionId]

Parameters

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

Responses

Status Code	Description	Samples
200	Gets user's root folder (without parents)
402	Subscription is blocked
403	No permissions to get root folder
404	Not found subscription
500	Try again, if error still here - text our support

MoveFolder

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.

Request

POST /api/rp/v1/Reports/Folder/{id}/Move/{folderId}

Parameters

Name	Type	Value	Notes
*id	string		moving folder id
*folderId	string		destination folder id

Responses

Status Code	Description	Samples
200	Folder has been moved to a specified folder
400	folderId or parentFolderId is null
402	Subscription is outdated
403	You don't have rights for the operation
404	Folder or subscription not found
500	Try again, if error still here - text our support

CopyFolder

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.

Request

POST /api/rp/v1/Reports/Folder/{id}/Copy/{folderId}

Parameters

Name	Type	Value	Notes
*id	string		moving folder id
*folderId	string		destination folder id

Responses

Status Code	Description	Samples
200	Folder has been moved to a specified folder
400	folderId or parentFolderId is null
402	Subscription is outdated
403	You don't have rights for the operation
404	Folder or subscription not found
500	Try again, if error still here - text our support

PostFolder

Create folder

User with a Create Entity permisison can access this method.

Request

POST /api/rp/v1/Reports/Folder/{id}/Folder

Parameters

Name	Type	Value	Notes
*id	string		Identifier of parent folder id
body			create VM

Responses

Status Code	Description	Samples
200	New folder has been created)
400	Parent folder id or VM is not valid
402	subscription is outdated
403	You don't have rights for the operation
404	parent folder/subscription not found

RenameFolder

Rename a folder

User with a Update Name permision can access this method.

Request

PUT /api/rp/v1/Reports/Folder/{id}/Rename

Parameters

Name	Type	Value	Notes
*id	string		User with a Update Name permision can access this method.
body			User with a Update Name permision can access this method.

Responses

Status Code	Description	Samples
200	Folder name has been updated
400	folderId or VM is not valid
402	subscription is outdated
403	You don't have rights for the operation
404	Folder or subscription not found
500	Try again, if error still here - text our support

UpdateIcon

Update a folder's icon

User with a Update Icon permission can access this method.

Request

PUT /api/rp/v1/Reports/Folder/{id}/Icon

Parameters

Name	Type	Value	Notes
*id	string		Identifier of folder
body			Update icon model

Responses

Status Code	Description	Samples
200	Folder's icon has been updated
400	folderId or VM is not valid
402	subscription is outdated
403	You don't have rights for the operation
404	Folder or subscription not found
500	Try again, if error still here - text our support

UpdateTags

Update tags

User with a Update Tags permission can access this method.

Request

PUT /api/rp/v1/Reports/Folder/{id}/UpdateTags

Parameters

Name	Type	Value	Notes
*id	string		User with a Update Tags permission can access this method.
body			User with a Update Tags permission can access this method.

Responses

Status Code	Description	Samples
200	Tags has been updated
400	folderId or Tags is null
403	You don't have rights for the operation
402	subscription is outdated
404	Folder or subscription not found
500	Try again, if error still here - text our support