Templates

Export

Export specified report template to a specified format

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

Request

POST /api/rp/v1/Templates/File/{id}/Export

Parameters

Name	Type	Value	Notes
*id	string		report id
exportTask			export parameters (string only)

Responses

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

Prepare

Prepare specified template to report

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

Request

POST /api/rp/v1/Templates/File/{id}/Prepare

Parameters

Name	Type	Value	Notes
*id	string		template id
prepareTask			Template prepare view model

Responses

Status Code	Description	Samples
200	Specified template has been prepared
400	Report Id is null
403	You don't have rights for the operation
402	subscription is outdated
404	Template or folder not found

UploadFile

Upload a file to the specified folder !

User with Create Entity permission can access this method.

Request

POST /api/rp/v1/Templates/Folder/{id}/File

Parameters

Name	Type	Value	Notes
*id	string		Identifier of folder
fileVM			file's view model

Responses

Status Code	Description	Samples
200	File has been uploaded
400	fileVM view model is not valid
403	You don't have rights for the operation
402	Client Error
404	Not Found

GetPermissions

Get all file permissions

Request

GET /api/rp/v1/Templates/File/{id}/permissions

Parameters

Name	Type	Value	Notes
*id	string

Responses

Status Code	Description	Samples
200	got permissions successfully
400	id is not valid
403	You don't have rights for the operation
404	file is not found

UpdatePermissions

Update permissions

Request

POST /api/rp/v1/Templates/File/{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

GetFile

Get specified file

User with Get Entity permission can access this method.

Request

GET /api/rp/v1/Templates/File/{id}

Parameters

Name	Type	Value	Notes
*id	string		file id

Responses

Status Code	Description	Samples
200	Returns the specified file
400	Id is null
403	You don't have rights for the operation
404	File not found
500	Exception thrown

DeleteFile

Delete specified file

User with Delete permission can access the method.

Request

DELETE /api/rp/v1/Templates/File/{id}

Parameters

Name	Type	Value	Notes
*id	string		file id

Responses

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

GetFilesCount

Get count of files what contains in a specified folder

User with Get Count permission can access this method.

Request

GET /api/rp/v1/Templates/Folder/{id}/CountFiles

Parameters

Name	Type	Value	Notes
*id	string		folder id

Responses

Status Code	Description	Samples
200	Returns count of the files in a specified folder
400	FolderId is null
403	You don't have rights for the operation
404	Folder not found
500	Exception thrown

GetFilesList

Get all files from specified folder

User with Get Entity permission can access this method.

Request

GET /api/rp/v1/Templates/Folder/{id}/ListFiles[?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	Returns list of the files from a specified folder
400	FolderId is null
403	You don't have rights for the operation
404	File or folder not found
500	Exception thrown

MoveFile

Move file to a specified folder

User with Update Place permission can access this method.

Request

POST /api/rp/v1/Templates/File/{id}/Move/{folderId}

Parameters

Name	Type	Value	Notes
*id	string		file id
*folderId	string		folder id

Responses

Status Code	Description	Samples
200	File has been moved
400	fileId or folderId is null
403	You don't have rights for the operation
402	Subscription is outdated
404	File or folder not found
500	Exception thrown

CopyFile

Copy file to a specified folder

Request

POST /api/rp/v1/Templates/File/{id}/Copy/{folderId}

Parameters

Name	Type	Value	Notes
*id	string		file id
*folderId	string		folder id

Responses

Status Code	Description	Samples
200	File has been copied
400	fileId or folderId is null
403	You don't have rights for the operation
402	Subscription is outdated
404	File or folder not found
500	Exception thrown

RenameFile

Rename a file

User with Update Name permission can access this method.

Request

PUT /api/rp/v1/Templates/File/{id}/Rename

Parameters

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

Responses

Status Code	Description	Samples
200	File name has been updated
400	FileId is null
403	You don't have rights for the operation
402	Subscription is outdated
404	File not found
500	Exception thrown

UpdateIcon

Update a files's icon

User with Update Icon permission can access this method.

Request

PUT /api/rp/v1/Templates/File/{id}/Icon

Parameters

Name	Type	Value	Notes
*id	string		User with Update Icon permission can access this method.
iconModel			User with Update Icon permission can access this method.

Responses

Status Code	Description	Samples
200	File's icon has been updated
400	FileId is null
403	You don't have rights for the operation
402	Subscription is outdated
404	File not found
500	Exception thrown

UpdateTags

Update tags

User with Update Tags permission can access this method.

Request

PUT /api/rp/v1/Templates/File/{id}/UpdateTags

Parameters

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

Responses

Status Code	Description	Samples
200	Tags has been updated
400	FileId is null
403	You don't have rights for the operation
402	Subscription is outdated
404	File not found
500	Exception thrown