Subscriptions

Subscriptions

GetSubscription

Returns the subscription by id

Request

GET /api/manage/v1/Subscriptions/{id}

Parameters

Name	Type	Value	Notes
*id	string		Identifier of subscription

Responses

Status Code	Description	Samples
200	Succesfully returned
400	The request is wrong
403	You don't have permissions for the operation
404	Subscription is not found
500	Try again, if error still here - text our support

GetSubscriptions

Returns a list of all subscriptions of current user

Request

GET /api/manage/v1/Subscriptions[?skip&take]

Parameters

Name	Type	Value	Notes
skip	integer	0	Variable for pagination, defautl value is 0
take	integer	10	Variable for pagination, default value is 10

Responses

Status Code	Description	Samples
200	Succesfully returned
400	unrealistic skip 'n take provided

RenameSubscription

Rename subscription

Request

PUT /api/manage/v1/Subscriptions/{subscriptionId}/rename

Parameters

Name	Type	Value	Notes
*subscriptionId	string		id
*body			rename VM

Responses

Status Code	Description	Samples
200	Successfully renamed
400	Request is wrong
402	Subscription is outdated
403	Not enough permissions
404	There is no subscription with such id (or user have no permission)

UpdatePreviewType

Update subscription's preview type

Request

PUT /api/manage/v1/Subscriptions/{subscriptionId}/PreviewType

Parameters

Name	Type	Value	Notes
*subscriptionId	string		id
*body			update VM

Responses

Status Code	Description	Samples
200	Successfully updated
400	Request is wrong
402	Subscription is outdated
403	Not enough permissions
404	There is no subscription with such id (or user have no permission)

UpdateLocale

Update subscription's default locale

Request

PUT /api/manage/v1/Subscriptions/{subscriptionId}/Locale

Parameters

Name	Type	Value	Notes
*subscriptionId	string		id
*body			update VM

Responses

Status Code	Description	Samples
200	Successfully renamed
400	Request is wrong
402	Subscription is outdated
403	Not enough permissions
404	There is no subscription with such id (or user have no permission)

UpdateDefaultPermissions

Change subscription's default permissions for new entities

Request

PUT /api/manage/v1/Subscriptions/{subscriptionId}/defaultPermissions

Parameters

Name	Type	Value	Notes
*subscriptionId	string		id
*body			update default permissions VM

Responses

Status Code	Description	Samples
200	Successfully changed
400	Request is wrong
402	Subscription is outdated
403	Not enough permissions
404	There is no subscription with such id

GetDefaultPermissions

Get subscription's default permissions for new entities

Request

GET /api/manage/v1/Subscriptions/{subscriptionId}/defaultPermissions

Parameters

Name	Type	Value	Notes
*subscriptionId	string		id

Responses

Status Code	Description	Samples
200	Successfully returned
400	Request is wrong
402	Subscription is outdated
403	Not enough permissions
404	There is no subscription with such id

GetPermissions

Get permissions for a subscription by id

Request

GET /api/manage/v1/Subscriptions/{id}/permissions

Parameters

Name	Type	Value	Notes
*id	string

Responses

Status Code	Description	Samples
200	Succesfully returned
400	Request is wrong
402	Subscription is outdated
403	Not enough permissions
404	There is no subscription with such id

UpdatePermissions

Update permissions

Request

POST /api/manage/v1/Subscriptions/{id}/permissions

Parameters

Name	Type	Value	Notes
*id	string
body

Responses

Status Code	Description	Samples
204	Succesfully updated
400	Request is wrong
402	Subscription is outdated
403	Not enough permissions
404	There is no subscription with such id

GetMyPermissions

Get user's permissions for a subscription by id

Request

GET /api/manage/v1/Subscriptions/{subId}/mypermissions

Parameters

Name	Type	Value	Notes
*subId	string		subscription id

Responses

Status Code	Description	Samples
200	Succesfully returned

UpdateSubscriptionDomains

Update subscription's allowed domains

Request

PUT /api/manage/v1/Subscriptions/{subscriptionId}/Domains

Parameters

Name	Type	Value	Notes
*subscriptionId	string		id
*body			update VM

Responses

Status Code	Description	Samples
200	Successfully renamed
400	Request is wrong
402	Subscription is outdated
403	Not enough permissions
404	There is no subscription with such id (or user have no permission)

Definitions

SubscriptionVM

Name	Type	Notes
id	string
name	string
locale	string
current	SubscriptionPeriodVM[]
old	SubscriptionPeriodVM[]
templatesFolder	SubscriptionFolder[]
reportsFolder	SubscriptionFolder[]
exportsFolder	SubscriptionFolder[]
previewType	PreviewType
tags	array
domains	array
$t	string

SubscriptionPeriodVM

Name	Type	Notes
startTime	string (date-time)
endTime	string (date-time)
plan	SubscriptionPlanVM[]
$t	string

SubscriptionPlanVM

Name	Type	Notes
id	string
isActive	boolean
displayName	string
timePeriodType	TimePeriodType
timePeriod	integer (int32)
readonlyTimeLimitType	TimePeriodType
readonlyTimeLimit	integer (int32)
templatesSpaceLimit	integer (int64)
reportsSpaceLimit	integer (int64)
exportsSpaceLimit	integer (int64)
fontsSpaceLimit	integer (int64)
fileUploadSizeLimit	integer (int64)
dataSourceLimit	integer (int32)
maxUsersCount	integer (int32)
groupLimit	integer (int32)
onlineDesigner	boolean
isDemo	boolean
urlToBuy	string
unlimitedPage	boolean
pageLimit	integer (int32)
tasks	TaskSettingsVM[]
$t	string

TimePeriodType

Enum Values

Second
Minute
Hour
Day
Week
Month
Year

TaskSettingsVM

Name	Type	Notes
isSchedulerEnabled	boolean
prepare	boolean
exportTemplate	boolean
exportReport	boolean
sendViaEmail	boolean
uploadToFTP	boolean
uploadToS3	boolean
uploadToTelegram	boolean
sendViaWebhook	boolean
fetchData	boolean
thumbnailReport	boolean
thumbnailTemplate	boolean
$t	string

SubscriptionFolder

Name	Type	Notes
folderId	string
bytesUsed	integer (int64)

PreviewType

ProblemDetails

Name	Type	Notes
type	string
title	string
status	integer (int32)
detail	string
instance	string

SubscriptionsVM

Name	Type	Notes
subscriptions	SubscriptionVM[]
count	integer (int64)
skip	integer (int32)
take	integer (int32)
$t	string

RenameSubscriptionVM

Name	Type	Notes
name	string
$t	string

UpdateSubscriptionPreviewTypeVM

Name	Type	Notes
previewType	PreviewType
$t	string

UpdateSubscriptionLocaleVM

Name	Type	Notes
locale	string
$t	string

UpdateDefaultPermissionsVM

Name	Type	Notes
filePermissions	UpdateFilePermissionsVM[]
groupPermissions	UpdateGroupPermissionsVM[]
dataSourcePermissions	UpdateDataSourcePermissionsVM[]
taskPermissions	UpdateTaskPermissionsVM[]
fontPermissions	UpdateUserFontPermissionsVM[]
$t	string

UpdateFilePermissionsVM

Name	Type	Notes
newPermissions	FilePermissionsCRUDVM[]
administrate	FileAdministrate
$t	string

FilePermissionsCRUDVM

Name	Type	Notes
ownerId	string
owner	FilePermissionCRUDVM[]
groups	object
other	FilePermissionCRUDVM[]
anon	FilePermissionCRUDVM[]
$t	string

FilePermissionCRUDVM

Name	Type	Notes
create	FileCreate
delete	FileDelete
execute	FileExecute
get	FileGet
update	FileUpdate
administrate	FileAdministrate
$t	string

FileCreate

FileDelete

FileExecute

FileGet

FileUpdate

FileAdministrate

UpdateGroupPermissionsVM

Name	Type	Notes
newPermissions	GroupPermissionsCRUDVM[]
administrate	GroupAdministrate
$t	string

GroupPermissionsCRUDVM

Name	Type	Notes
ownerId	string
owner	GroupPermissionCRUDVM[]
groups	object
other	GroupPermissionCRUDVM[]
anon	GroupPermissionCRUDVM[]
$t	string

GroupPermissionCRUDVM

Name	Type	Notes
create	GroupCreate
delete	GroupDelete
execute	GroupExecute
get	GroupGet
update	GroupUpdate
administrate	GroupAdministrate
$t	string

GroupCreate

GroupDelete

GroupExecute

GroupGet

GroupUpdate

GroupAdministrate

UpdateDataSourcePermissionsVM

Name	Type	Notes
newPermissions	DataSourcePermissionsCRUDVM[]
administrate	DataSourceAdministrate
$t	string

DataSourcePermissionsCRUDVM

Name	Type	Notes
ownerId	string
owner	DataSourcePermissionCRUDVM[]
groups	object
other	DataSourcePermissionCRUDVM[]
anon	DataSourcePermissionCRUDVM[]
$t	string

DataSourcePermissionCRUDVM

Name	Type	Notes
create	DataSourceCreate
delete	DataSourceDelete
execute	DataSourceExecute
get	DataSourceGet
update	DataSourceUpdate
administrate	DataSourceAdministrate
$t	string

DataSourceCreate

DataSourceDelete

DataSourceExecute

DataSourceGet

DataSourceUpdate

DataSourceAdministrate

UpdateTaskPermissionsVM

Name	Type	Notes
administrate	TaskAdministrate
newPermissions	TaskPermissionsCRUDVM[]
$t	string

TaskAdministrate

TaskPermissionsCRUDVM

Name	Type	Notes
ownerId	string
owner	TaskPermissionCRUDVM[]
groups	object
other	TaskPermissionCRUDVM[]
anon	TaskPermissionCRUDVM[]
$t	string

TaskPermissionCRUDVM

Name	Type	Notes
create	TaskCreate
delete	TaskDelete
execute	TaskExecute
get	TaskGet
update	TaskUpdate
administrate	TaskAdministrate
$t	string

TaskCreate

TaskDelete

TaskExecute

TaskGet

TaskUpdate

UpdateUserFontPermissionsVM

Name	Type	Notes
newPermissions	UserFontPermissionsCRUDVM[]
administrate	FontAdministrate
$t	string

UserFontPermissionsCRUDVM

Name	Type	Notes
ownerId	string
owner	UserFontPermissionCRUDVM[]
groups	object
other	UserFontPermissionCRUDVM[]
anon	UserFontPermissionCRUDVM[]
$t	string

UserFontPermissionCRUDVM

Name	Type	Notes
create	FontCreate
delete	FontDelete
execute	FontExecute
get	FontGet
update	FontUpdate
administrate	FontAdministrate
$t	string

FontCreate

FontDelete

FontExecute

FontGet

FontUpdate

FontAdministrate

DefaultPermissionsVM

Name	Type	Notes
filePermissions	FilePermissionsCRUDVM[]
dataSourcePermissions	DataSourcePermissionsCRUDVM[]
groupPermissions	GroupPermissionsCRUDVM[]
taskPermissions	TaskPermissionsCRUDVM[]
fontPermissions	UserFontPermissionsCRUDVM[]
$t	string

SubscriptionPermissionsVM

Name	Type	Notes
permissions	SubscriptionPermissionsCRUDVM[]
$t	string

SubscriptionPermissionsCRUDVM

Name	Type	Notes
ownerId	string
owner	SubscriptionPermissionCRUDVM[]
groups	object
other	SubscriptionPermissionCRUDVM[]
anon	SubscriptionPermissionCRUDVM[]
$t	string

SubscriptionPermissionCRUDVM

Name	Type	Notes
create	SubscriptionCreate
delete	SubscriptionDelete
execute	SubscriptionExecute
get	SubscriptionGet
update	SubscriptionUpdate
administrate	SubscriptionAdministrate
$t	string

SubscriptionCreate

SubscriptionDelete

SubscriptionExecute

SubscriptionGet

SubscriptionUpdate

SubscriptionAdministrate

UpdateSubscriptionPermissionsVM

Name	Type	Notes
newPermissions	SubscriptionPermissionsCRUDVM[]
administrate	SubscriptionAdministrate
$t	string

MyPermissionsVM

Name	Type	Notes
subscription	SubscriptionPermissionCRUDVM[]
files	FilePermissionCRUDVM[]
datasources	DataSourcePermissionCRUDVM[]
groups	GroupPermissionCRUDVM[]
tasks	TaskPermissionCRUDVM[]
$t	string

UpdateSubscriptionDomainsVM

Name	Type	Notes
domains	array