ReportFolders

Reports

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
403	You don't have rights for the operation
404	folder is not found

UpdatePermissions

Update permissions

Request

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

Parameters

Name	Type	Value	Notes
*id	string
permissionsVM

Responses

Status Code	Description	Samples
200	Success
400	Bad Request
402	Client Error
403	Forbidden
404	Not Found
500	Server Error

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
403	You don't have rights for the operation
404	Folder not found

DeleteFolder

Delete specified folder

User with a Delete Entity permission can access this method.

Request

DELETE /api/rp/v1/Reports/Folder/{id}[?recursive]

Parameters

Name	Type	Value	Notes
*id	string		folder id
recursive	boolean	True	delete all childs

Responses

Status Code	Description	Samples
204	Folder succesfully deleted
400	Id is null
403	You don't have rights for the operation
402	Subscription is outdated
404	Folder not found

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
403	You don't have rights for the operation
404	Folder not found

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]

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

Responses

Status Code	Description	Samples
200	Gets all folders from a specified folder
400	folderId is null
403	You don't have rights for the operation
404	Folder not found

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
403	You don't have rights for the operation
404	Folder not found

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)
400	Error with the request.
404	Not found subscription
403	No permissions to get root folder

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
403	You don't have rights for the operation
402	Subscription is outdated
404	Folder not found

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
403	You don't have rights for the operation
402	Subscription is outdated
404	Folder not found

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
folderVm			create VM

Responses

Status Code	Description	Samples
200	New folder has been created)
400	Parent folder id is null
403	You don't have rights for the operation
402	subscription is outdated
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.
nameModel			User with a Update Name permision can access this method.

Responses

Status Code	Description	Samples
200	Folder name has been updated
400	folderId is null
403	You don't have rights for the operation
402	subscription is outdated
404	Folder not found

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
iconModel			Update icon model

Responses

Status Code	Description	Samples
200	Folder's icon has been updated
400	folderId is null
403	You don't have rights for the operation
402	subscription is outdated
404	Folder not found

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.
tagsModel			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 not found