{ "openapi": "3.0.1", "info": { "title": "FastReport Cloud", "version": "v1" }, "paths": { "/api/manage/v1/ApiKeys": { "get": { "tags": [ "ApiKeys" ], "summary": "Returns list with all apikeys of current user", "description": "Always work, it should make only 200 response (except if user is not authorized).", "operationId": "ApiKeys_GetApiKeys", "responses": { "200": { "description": "Succesfully retured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiKeysVM" } } } }, "401": { "description": "User is not authorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Exception somehow thrown (barely possible)" } } }, "post": { "tags": [ "ApiKeys" ], "summary": "Create a new apikey, 5 apikeys for user. Hardcoded for ddos.", "operationId": "ApiKeys_CreateApiKey", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateApiKeyVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateApiKeyVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateApiKeyVM" } } }, "required": true }, "responses": { "200": { "description": "Succesfully created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiKeyVM" } } } }, "400": { "description": "wrong model provided or exception thrown (user's attempts to create sixth key for example throwns an exception)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "User is not authorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "ApiKeys" ], "summary": "Delete an apikey", "operationId": "ApiKeys_DeleteApiKey", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteApiKeyVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeleteApiKeyVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeleteApiKeyVM" } } }, "required": true }, "responses": { "204": { "description": "Succesfully deleted" }, "400": { "description": "The request is wrong", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "User is not authorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "No such apikey found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "exception thrown" } } } }, "/api/v1/Configuration": { "get": { "tags": [ "Configuration" ], "summary": "returns information about server configuration", "operationId": "Configuration_Get", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServerConfigurationVM" } } } } } } }, "/api/v1/ContactGroups/group": { "post": { "tags": [ "ContactGroups" ], "summary": "Creates contact group", "operationId": "ContactGroups_Create", "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateContactGroupVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateContactGroupVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateContactGroupVM" } } } }, "responses": { "200": { "description": "Contact group was created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactGroupVM" } } } }, "400": { "description": "Bad VM provided", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Not enough permissions for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Subscription was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/api/v1/ContactGroups/{id}": { "get": { "tags": [ "ContactGroups" ], "summary": "Returns contact group by id", "operationId": "ContactGroups_Get", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "Contact group was found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactGroupVM" } } } }, "400": { "description": "Bad id provided", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Not enough permissions for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Subscription or group was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } }, "put": { "tags": [ "ContactGroups" ], "summary": "Updates contact group by id", "operationId": "ContactGroups_Update", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateContactGroupVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateContactGroupVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateContactGroupVM" } } } }, "responses": { "200": { "description": "Contact group was updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactGroupVM" } } } }, "400": { "description": "Bad VM or id provided", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Not enough permissions for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Subscription or group was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } }, "delete": { "tags": [ "ContactGroups" ], "summary": "Removes contact by id", "operationId": "ContactGroups_Delete", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "204": { "description": "Contact group was deleted" }, "400": { "description": "Bad id provided", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Not enough permissions for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Subscription or group was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/api/v1/ContactGroups/subscription/{subscriptionId}/groups": { "get": { "tags": [ "ContactGroups" ], "summary": "Returns contact groups by subscriptionId", "operationId": "ContactGroups_GetList", "parameters": [ { "name": "subscriptionId", "in": "path", "description": "", "required": true, "schema": { "pattern": "(^$)|(^[A-Fa-f0-9]{24}$)", "type": "string" } }, { "name": "skip", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "take", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "default": 10 } } ], "responses": { "200": { "description": "Contact groups were found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactGroupsVM" } } } }, "403": { "description": "Not enough permissions for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Subscription was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "400": { "description": "Bad id provided", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/api/v1/Contacts/contact": { "post": { "tags": [ "Contacts" ], "summary": "Creates new contact", "operationId": "Contacts_Create", "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateContactVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateContactVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateContactVM" } } } }, "responses": { "200": { "description": "Contact was created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactVM" } } } }, "400": { "description": "Bad VM provided", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Not enough permissions for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Subscription was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/api/v1/Contacts/{id}": { "get": { "tags": [ "Contacts" ], "summary": "Returns contact group by id", "operationId": "Contacts_Get", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "Contact was found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactVM" } } } }, "400": { "description": "Bad id provided", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Not enough permissions for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Subscription or contact was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } }, "put": { "tags": [ "Contacts" ], "summary": "Updates contact by id", "operationId": "Contacts_Update", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateContactVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateContactVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateContactVM" } } } }, "responses": { "200": { "description": "Contact was updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactVM" } } } }, "400": { "description": "Bad VM or id provided", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Not enough permissions for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Subscription or contact was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } }, "delete": { "tags": [ "Contacts" ], "summary": "Removes contact by id", "operationId": "Contacts_Delete", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad id provided", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Not enough permissions for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Subscription or contact was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" }, "200": { "description": "Contact was deleted" } } } }, "/api/v1/Contacts/subscription/{subscriptionId}/contacts": { "get": { "tags": [ "Contacts" ], "summary": "Allows to search for contacts", "operationId": "Contacts_GetList", "parameters": [ { "name": "subscriptionId", "in": "path", "description": "", "required": true, "schema": { "pattern": "(^$)|(^[A-Fa-f0-9]{24}$)", "type": "string" } }, { "name": "skip", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "take", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "default": 10 } }, { "name": "searchPattern", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Contacts were found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactsVM" } } } }, "400": { "description": "Bad id provided", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Not enough permissions for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Subscription was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/api/v1/Contacts/group/{groupId}/contacts": { "get": { "tags": [ "Contacts" ], "summary": "Returns contacts by group id", "operationId": "Contacts_GetByGroup", "parameters": [ { "name": "groupId", "in": "path", "description": "", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } }, { "name": "skip", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "take", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "default": 10 } } ], "responses": { "200": { "description": "Contacts were found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactsVM" } } } }, "400": { "description": "Bad id provided", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Not enough permissions for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Subscription or group was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/api/data/v1/DataSources/{subscriptionId}/count": { "get": { "tags": [ "DataSources" ], "summary": "Returns a number of data sources in subscription", "operationId": "DataSources_CountDataSourcesAsync", "parameters": [ { "name": "subscriptionId", "in": "path", "description": "subscripiton id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "Everything is all right", "content": { "application/json": { "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "id is not hex24", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have permisison to get data sources from this subscription (or in your default (1st) subscription)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "there is no subscription with provided id found, or user don't even have a subscription", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/data/v1/DataSources": { "post": { "tags": [ "DataSources" ], "summary": "Create new data source", "operationId": "DataSources_CreateDataSource", "requestBody": { "description": "create viewmodel", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDataSourceVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateDataSourceVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateDataSourceVM" } } } }, "responses": { "200": { "description": "Everything is all right", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataSourceVM" } } } }, "400": { "description": "VM is not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated or have not enough limits", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have permisison to create data sources from this subscription (or in your default (1st) subscription)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "There is no subscription with provided id found, or user don't even have a subscription", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } }, "get": { "tags": [ "DataSources" ], "summary": "Returns all of the data sources, that current user have permission for in a subscription
\r\nThe method will return minimal infomration about the datasources:
\r\nid, name, editedTime, status.", "operationId": "DataSources_GetAvailableDataSources", "parameters": [ { "name": "subscriptionId", "in": "query", "description": "id of subscription where the datasources are located", "schema": { "pattern": "(^$)|(^[A-Fa-f0-9]{24}$)", "type": "string" } }, { "name": "skip", "in": "query", "description": "how many data sources will be skipped", "schema": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32", "default": 0 } }, { "name": "take", "in": "query", "description": "how many data sources will be taken", "schema": { "maximum": 120, "minimum": 1, "type": "integer", "format": "int32", "default": 10 } }, { "name": "orderBy", "in": "query", "description": "field to order by", "schema": { "$ref": "#/components/schemas/DataSourceSorting" } }, { "name": "desc", "in": "query", "description": "descending sort", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Everything is all right", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataSourcesVM" } } } }, "400": { "description": "One of params is not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated or have not enough limits", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have permisison to get data sources from this subscription (or in your default (1st) subscription)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "There is no subscription with provided id found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/data/v1/DataSources/{id}": { "delete": { "tags": [ "DataSources" ], "summary": "Delete data source by id", "operationId": "DataSources_DeleteDataSource", "parameters": [ { "name": "id", "in": "path", "description": "data source id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "204": { "description": "Everything is all right" }, "400": { "description": "id is not hex24", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated or have not enough limits", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have permisison to delete data sources from this subscription (or in your default (1st) subscription)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "There is no data source or subscription with provided id found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } }, "get": { "tags": [ "DataSources" ], "summary": "Get data source by id", "operationId": "DataSources_GetDataSource", "parameters": [ { "name": "id", "in": "path", "description": "data source id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "Everything is all right", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataSourceVM" } } } }, "400": { "description": "id is not hex24", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated or have not enough limits", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have permisison to get data sources from this subscription (or in your default (1st) subscription)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "There is no data source or subscription with provided id found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/api/data/v1/DataSources/{id}/fetch": { "get": { "tags": [ "DataSources" ], "summary": "This should connect to a database and set data structure", "operationId": "DataSources_FetchData", "parameters": [ { "name": "id", "in": "path", "description": "datasource's id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "204": { "description": "Everything is all right" }, "400": { "description": "id is not hex24", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated or have not enough limits", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have permisison to fetch data sources from this subscription (or in your default (1st) subscription)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "There is no data source or subscription with provided id found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/api/data/v1/DataSources/parameterTypes/{dataSourceType}": { "get": { "tags": [ "DataSources" ], "summary": "Get data source parameter DataType's", "operationId": "DataSources_GetParameterTypes", "parameters": [ { "name": "dataSourceType", "in": "path", "description": "data source type (MsSql, MySql, etc.)", "required": true, "schema": { "$ref": "#/components/schemas/DataSourceConnectionType" } } ], "responses": { "200": { "description": "Everything is all right", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataSourceParameterTypesVM" } } } }, "400": { "description": "Data source doesn't support parameters or wrong data source name", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/api/data/v1/DataSources/{id}/permissions": { "get": { "tags": [ "DataSources" ], "summary": "Get all Data source permissions", "operationId": "DataSources_GetPermissions", "parameters": [ { "name": "id", "in": "path", "description": "data source id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "Everything is all right", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataSourcePermissionsVM" } } } }, "400": { "description": "id is not hex24", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated or have not enough limits", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have permisison to get data sources' permissions from this subscription (or in your default (1st) subscription)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "There is no data source or subscription with provided id found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } }, "post": { "tags": [ "DataSources" ], "summary": "Update permissions", "operationId": "DataSources_UpdatePermissions", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDataSourcePermissionsVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateDataSourcePermissionsVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateDataSourcePermissionsVM" } } } }, "responses": { "204": { "description": "Everything is all right" }, "400": { "description": "id is not hex24 or VM is not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated or have not enough limits", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have permisison to update data sources' permissions from this subscription (or in your default (1st) subscription)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "There is no data source or subscription with provided id found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/api/data/v1/DataSources/{id}/mypermissions": { "get": { "tags": [ "DataSources" ], "summary": "Get current user's permissions to Data source", "operationId": "DataSources_GetMyPermissions", "parameters": [ { "name": "id", "in": "path", "description": "data source id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "got permissions successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataSourcePermissionCRUDVM" } } } }, "400": { "description": "The request is wrong", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "There is no data source or subscription with provided id found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" } } } }, "/api/data/v1/DataSources/{id}/rename": { "put": { "tags": [ "DataSources" ], "summary": "Rename data source by id", "operationId": "DataSources_RenameDataSource", "parameters": [ { "name": "id", "in": "path", "description": "data source id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "description": "rename viewmodel", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RenameDataSourceVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RenameDataSourceVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RenameDataSourceVM" } } } }, "responses": { "200": { "description": "Everything is all right", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataSourceVM" } } } }, "400": { "description": "id is not hex24 or VM is not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated or have not enough limits", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have permisison to update data sources' name from this subscription (or in your default (1st) subscription)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "There is no data source or subscription with provided id found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/api/data/v1/DataSources/{id}/connectionString": { "put": { "tags": [ "DataSources" ], "summary": "Update data source's connection string by id", "operationId": "DataSources_UpdateConnectionString", "parameters": [ { "name": "id", "in": "path", "description": "data source id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "description": "update viewmodel", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDataSourceConnectionStringVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateDataSourceConnectionStringVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateDataSourceConnectionStringVM" } } } }, "responses": { "200": { "description": "Everything is all right", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataSourceVM" } } } }, "400": { "description": "id is not hex24 or VM is not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated or have not enough limits", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have permisison to update data sources' connection string from this subscription (or in your default (1st) subscription)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "There is no data source or subscription with provided id found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/api/data/v1/DataSources/{id}/updateSubscription": { "put": { "tags": [ "DataSources" ], "summary": "Update data source's subscription", "operationId": "DataSources_UpdateSubscriptionDataSource", "parameters": [ { "name": "id", "in": "path", "description": "data source id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "description": "update subscription viewmodel", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDataSourceSubscriptionVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateDataSourceSubscriptionVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateDataSourceSubscriptionVM" } } } }, "responses": { "200": { "description": "Everything is all right" }, "400": { "description": "id is not hex24 or VM is not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated or have not enough limits", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have permisison to get data sources or create them in new subscription", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "There is no data source or subscription with provided id found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/api/data/v1/DataSources/{id}/selectCommands": { "put": { "tags": [ "DataSources" ], "summary": "Update data source's select commands by id", "operationId": "DataSources_UpdateSelectCommands", "parameters": [ { "name": "id", "in": "path", "description": "data source id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "description": "update viewmodel", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDataSourceSelectCommandsVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateDataSourceSelectCommandsVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateDataSourceSelectCommandsVM" } } } }, "responses": { "200": { "description": "Everything is all right", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataSourceVM" } } } }, "400": { "description": "id is not hex24 or VM is not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated or have not enough limits", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have permisison to update data sources' connection string from this subscription (or in your default (1st) subscription)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "There is no data source or subscription with provided id found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/download/e/{id}/thumbnail": { "get": { "tags": [ "Download" ], "summary": "Returns export's thumbnail", "operationId": "Download_GetExportThumbnail", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "Specified thumbnail was found", "content": { "text/plain": { "schema": { "type": "string", "format": "binary" } }, "application/json": { "schema": { "type": "string", "format": "binary" } }, "image/png": { "schema": { "type": "string", "format": "binary" } }, "image/jpeg": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Bad id provided", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "image/png": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "image/jpeg": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is blocked", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "image/png": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "image/jpeg": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Not enough permissions for the operation", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "image/png": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "image/jpeg": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Specified thumbnail was not found or user do not has access to it", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "image/png": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "image/jpeg": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/download/e/{id}": { "get": { "tags": [ "Download" ], "summary": "Returns a export file with specified id", "operationId": "Download_GetExport", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } }, { "name": "preview", "in": "query", "description": "", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Specified file was found", "content": { "text/plain": { "schema": { "type": "string", "format": "binary" } }, "application/json": { "schema": { "type": "string", "format": "binary" } }, "application/octet-stream": { "schema": { "type": "string", "format": "binary" } }, "application/pdf": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Bad id provided", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/octet-stream": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/pdf": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is blocked", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/octet-stream": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/pdf": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Not enough permissions for the operation", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/octet-stream": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/pdf": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Specified file was not found or user do not has access to the file", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/octet-stream": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/pdf": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/download/es/{archiveName}": { "get": { "tags": [ "Download" ], "summary": "Returns a zip archive with selected ids", "operationId": "Download_GetExports", "parameters": [ { "name": "fileIds", "in": "query", "description": "ids separated with a ',' sign", "schema": { "type": "string" } }, { "name": "folderIds", "in": "query", "description": "ids separated with a ',' sign", "schema": { "type": "string" } }, { "name": "archiveName", "in": "path", "description": "name of the created archive", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Specified files was found", "content": { "text/plain": { "schema": { "type": "string", "format": "binary" } }, "application/json": { "schema": { "type": "string", "format": "binary" } }, "application/zip": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Bad id provided", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/zip": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is blocked", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/zip": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Not enough permissions for the operation", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/zip": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Specified files were not found or user do not has access to the file", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/zip": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/download/lastPreview/{reportId}": { "get": { "tags": [ "Download" ], "summary": "returns export, that was created from report with specified id.\r\nINTERNAL USAGE ONLY!", "operationId": "Download_GetLastSVGExport", "parameters": [ { "name": "reportId", "in": "path", "description": "", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "Specified file was found", "content": { "text/plain": { "schema": { "type": "string", "format": "binary" } }, "application/json": { "schema": { "type": "string", "format": "binary" } }, "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Bad id provided", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/octet-stream": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is blocked", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/octet-stream": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Not enough permissions for the operation", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/octet-stream": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Specified file was not found or user do not has access to the file", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/octet-stream": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/download/r/{id}/thumbnail": { "get": { "tags": [ "Download" ], "summary": "Returns report's thumbnail", "operationId": "Download_GetReportThumbnail", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "Specified thumbnail was found", "content": { "text/plain": { "schema": { "type": "string", "format": "binary" } }, "application/json": { "schema": { "type": "string", "format": "binary" } }, "image/png": { "schema": { "type": "string", "format": "binary" } }, "image/jpeg": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Bad id provided", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "image/png": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "image/jpeg": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is blocked", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "image/png": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "image/jpeg": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Not enough permissions for the operation", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "image/png": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "image/jpeg": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Specified thumbnail was not found or user do not has access to it", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "image/png": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "image/jpeg": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/download/r/{id}": { "get": { "tags": [ "Download" ], "summary": "Returns a prepared file with specified id", "operationId": "Download_GetReport", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "Specified file was found", "content": { "text/plain": { "schema": { "type": "string", "format": "binary" } }, "application/json": { "schema": { "type": "string", "format": "binary" } }, "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Bad id provided", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/octet-stream": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is blocked", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/octet-stream": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Not enough permissions", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/octet-stream": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Specified file was not found or user do not has access to the file", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/octet-stream": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/download/rs/{archiveName}": { "get": { "tags": [ "Download" ], "summary": "Returns a zip archive with selected files", "operationId": "Download_GetReports", "parameters": [ { "name": "fileIds", "in": "query", "description": "ids separated with a ',' sign", "schema": { "type": "string" } }, { "name": "folderIds", "in": "query", "description": "ids separated with a ',' sign", "schema": { "type": "string" } }, { "name": "archiveName", "in": "path", "description": "name of the created archive", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Files were downloaded", "content": { "text/plain": { "schema": { "type": "string", "format": "binary" } }, "application/json": { "schema": { "type": "string", "format": "binary" } }, "application/zip": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Wrong parameters provided", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/zip": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is blocked", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/zip": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/zip": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Files were not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/zip": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/download/t/{id}/thumbnail": { "get": { "tags": [ "Download" ], "summary": "Returns template's thumbnail", "operationId": "Download_GetTemplateThumbnail", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "Specified thumbnail was found", "content": { "text/plain": { "schema": { "type": "string", "format": "binary" } }, "application/json": { "schema": { "type": "string", "format": "binary" } }, "image/png": { "schema": { "type": "string", "format": "binary" } }, "image/jpeg": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Bad id provided", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "image/png": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "image/jpeg": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is blocked", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "image/png": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "image/jpeg": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Not enough permissions for the operation", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "image/png": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "image/jpeg": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Specified thumbnail was not found or user do not has access to it", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "image/png": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "image/jpeg": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/download/t/{id}": { "get": { "tags": [ "Download" ], "summary": "Returns a Template file with specified id", "operationId": "Download_GetTemplate", "parameters": [ { "name": "id", "in": "path", "description": "template id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "Specified file was found", "content": { "text/plain": { "schema": { "type": "string", "format": "binary" } }, "application/json": { "schema": { "type": "string", "format": "binary" } }, "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Bad id provided", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/octet-stream": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is blocked", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/octet-stream": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Not enough permissions", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/octet-stream": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Specified file was not found or user do not has access to the file", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/octet-stream": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/download/ts/{archiveName}": { "get": { "tags": [ "Download" ], "summary": "Returns a zip archive with selected files", "operationId": "Download_GetTemplates", "parameters": [ { "name": "fileIds", "in": "query", "description": "ids separated with a ',' sign", "schema": { "type": "string" } }, { "name": "folderIds", "in": "query", "description": "ids separated with a ',' sign", "schema": { "type": "string" } }, { "name": "archiveName", "in": "path", "description": "name of the created archive", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Files were downloaded", "content": { "text/plain": { "schema": { "type": "string", "format": "binary" } }, "application/json": { "schema": { "type": "string", "format": "binary" } }, "application/zip": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Wrong parameters provided", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/zip": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is blocked", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/zip": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/zip": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Files were not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/zip": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rp/v1/Exports/Folder/{id}/CountFolderAndFiles": { "get": { "tags": [ "Exports" ], "summary": "Get count of files and folders what contains in a specified folder", "description": "User with a Get Count permission can access this method.", "operationId": "ExportFolderAndFile_GetCount", "parameters": [ { "name": "id", "in": "path", "description": "folder id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } }, { "name": "searchPattern", "in": "query", "description": "string, that must be incuded in file or folder name to be counted
\r\n (leave undefined to count all files and folders)", "schema": { "maxLength": 100, "minLength": 0, "type": "string" } }, { "name": "useRegex", "in": "query", "description": "set this to true if you want to use regular expression to search", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Returns count of the files in a specified folder", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountVM" } } } }, "400": { "description": "Params are not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Payment required, subscription is blocked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Folder or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/api/rp/v1/Exports/Folder/{id}/ListFolderAndFiles": { "get": { "tags": [ "Exports" ], "summary": "Get all folders and files from specified folder", "description": "User with a Get Entity permission can access this method.", "operationId": "ExportFolderAndFile_GetFoldersAndFiles", "parameters": [ { "name": "id", "in": "path", "description": "folder id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } }, { "name": "skip", "in": "query", "description": "number of folder and files, that have to be skipped", "schema": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32", "default": 0 } }, { "name": "take", "in": "query", "description": "number of folder and files, that have to be returned", "schema": { "maximum": 120, "minimum": 1, "type": "integer", "format": "int32", "default": 10 } }, { "name": "orderBy", "in": "query", "description": "indicates a field to sort by", "schema": { "$ref": "#/components/schemas/FileSorting" } }, { "name": "desc", "in": "query", "description": "indicates if sorting is descending", "schema": { "type": "boolean", "default": false } }, { "name": "searchPattern", "in": "query", "description": "", "schema": { "maxLength": 100, "minLength": 0, "type": "string", "default": "" } }, { "name": "useRegex", "in": "query", "description": "", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Returns list of the files from a specified folder", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilesVM" } } } }, "400": { "description": "Params are not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Payment required, subscription is blocked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Subscription or folder not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rp/v1/Exports/{subscriptionId}/ListRecycleBinFolderAndFiles": { "get": { "tags": [ "Exports" ], "summary": "Get all folders and files from recycle bin", "description": "User with a Get DeletedFiles permission can access this method.", "operationId": "ExportFolderAndFile_GetRecycleBinFoldersAndFiles", "parameters": [ { "name": "subscriptionId", "in": "path", "description": "subscription id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } }, { "name": "skip", "in": "query", "description": "number of folder and files, that have to be skipped", "schema": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32", "default": 0 } }, { "name": "take", "in": "query", "description": "number of folder and files, that have to be returned", "schema": { "maximum": 120, "minimum": 1, "type": "integer", "format": "int32", "default": 10 } }, { "name": "orderBy", "in": "query", "description": "indicates a field to sort by", "schema": { "$ref": "#/components/schemas/FileSorting" } }, { "name": "desc", "in": "query", "description": "indicates if sorting is descending", "schema": { "type": "boolean", "default": false } }, { "name": "searchPattern", "in": "query", "description": "", "schema": { "maxLength": 100, "minLength": 0, "type": "string", "default": "" } }, { "name": "useRegex", "in": "query", "description": "", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Returns list of the files from a specified folder", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilesVM" } } } }, "400": { "description": "Params are not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Payment required, subscription is blocked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rp/v1/Exports/{subscriptionId}/CountRecycleBinFolderAndFiles": { "get": { "tags": [ "Exports" ], "summary": "Count all folders and files from recycle bin", "description": "User with a Get DeletedFiles permission can access this method.", "operationId": "ExportFolderAndFile_CountRecycleBinFoldersAndFiles", "parameters": [ { "name": "subscriptionId", "in": "path", "description": "subscription id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } }, { "name": "searchPattern", "in": "query", "description": "", "schema": { "maxLength": 100, "minLength": 0, "type": "string", "default": "" } }, { "name": "useRegex", "in": "query", "description": "", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Returns list of the files from a specified folder", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountVM" } } } }, "400": { "description": "Params are not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Payment required, subscription is blocked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rp/v1/Exports/{subscriptionId}/ClearRecycleBin": { "delete": { "tags": [ "Exports" ], "summary": "Delete all folders and files from recycle bin", "description": "User with a Delete RecycleBin permission can access this method.", "operationId": "ExportFolderAndFile_ClearRecycleBin", "parameters": [ { "name": "subscriptionId", "in": "path", "description": "subscription id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "204": { "description": "All folders and files in bin have been deleted" }, "400": { "description": "Subscription id is not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Payment required, subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rp/v1/Exports/{subscriptionId}/RecoverRecycleBin": { "post": { "tags": [ "Exports" ], "summary": "Recover all folders and files from recycle bin", "description": "User with a Create RecycleBin permission can access this method.", "operationId": "ExportFolderAndFile_RecoverAllFromRecycleBin", "parameters": [ { "name": "subscriptionId", "in": "path", "description": "subscription id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "204": { "description": "All folders and files in bin have been restored" }, "400": { "description": "Subscription id is not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Payment required, subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rp/v1/Exports/{subscriptionId}/DeleteFiles": { "post": { "tags": [ "Exports" ], "summary": "Delete folders and files", "description": "User with a Delete permission can access this method.", "operationId": "ExportFolderAndFile_DeleteFiles", "parameters": [ { "name": "subscriptionId", "in": "path", "description": "id of current subscription", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "description": "VM with files' ids and params of their destination", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectedFilesVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SelectedFilesVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SelectedFilesVM" } } } }, "responses": { "204": { "description": "All folders and files have been deleted" }, "400": { "description": "Subscription id or VM is not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Payment required, subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rp/v1/Exports/{subscriptionId}/RecoverFiles": { "post": { "tags": [ "Exports" ], "summary": "Recover folders and files from bin", "description": "User with a SubscriptionCreate permission can access this method.", "operationId": "ExportFolderAndFile_RecoverFiles", "parameters": [ { "name": "subscriptionId", "in": "path", "description": "id of current subscription", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "description": "VM with files' ids and params of their destination", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectedFilesVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SelectedFilesVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SelectedFilesVM" } } } }, "responses": { "204": { "description": "All folders and files have been recovered" }, "400": { "description": "Subscription id or VM is not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Payment required, subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rp/v1/Exports/{subscriptionId}/ToBin": { "post": { "tags": [ "Exports" ], "summary": "Move folders and files to bin", "description": "User with a Delete permission can access this method.", "operationId": "ExportFolderAndFile_MoveFilesToBin", "parameters": [ { "name": "subscriptionId", "in": "path", "description": "id of current subscription", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "description": "VM with files' ids and params of their destination", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectedFilesVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SelectedFilesVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SelectedFilesVM" } } } }, "responses": { "204": { "description": "All folders and files have been moved to bin" }, "400": { "description": "Subscription id or VM is not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Payment required, subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rp/v1/Exports/{subscriptionId}/CopyFiles": { "post": { "tags": [ "Exports" ], "summary": "Copy folders and files to a specified folder", "description": "User with a Get permission for a files and Create permission for a destination folder can access this method.", "operationId": "ExportFolderAndFile_CopyFiles", "parameters": [ { "name": "subscriptionId", "in": "path", "description": "id of current subscription", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "description": "VM with files' ids and params of their destination", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectedFilesVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SelectedFilesVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SelectedFilesVM" } } } }, "responses": { "204": { "description": "All folders and files have been copied" }, "400": { "description": "FolderId is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Payment required, subscription is blocked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "File or folder not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" } } } }, "/api/rp/v1/Exports/{subscriptionId}/MoveFiles": { "post": { "tags": [ "Exports" ], "summary": "Move folders and files to a specified folder", "description": "User with a Update Place permission for a files and Create permission for a destination folder can access this method.", "operationId": "ExportFolderAndFile_MoveFiles", "parameters": [ { "name": "subscriptionId", "in": "path", "description": "id of current subscription", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "description": "VM with files' ids and params of their destination", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectedFilesVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SelectedFilesVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SelectedFilesVM" } } } }, "responses": { "204": { "description": "All folders and files have been moved" }, "400": { "description": "FolderId is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Payment required, subscription is blocked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "File or folder not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" } } } }, "/api/rp/v1/Exports/Folder/{id}/permissions": { "get": { "tags": [ "Exports" ], "summary": "Get all folder permissions", "operationId": "ExportFolders_GetPermissions", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "returned permissions", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilePermissionsVM" } } } }, "400": { "description": "id is not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is blocked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Folder or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rp/v1/Exports/Folder/{folderId}/mypermissions": { "get": { "tags": [ "Exports" ], "summary": "Get user's permissions for a folder by id", "operationId": "ExportFolders_GetMyPermissions", "parameters": [ { "name": "folderId", "in": "path", "description": "folder id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "Succesfully returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilePermissionCRUDVM" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rp/v1/Exports/{id}/permissions": { "post": { "tags": [ "Exports" ], "summary": "Update permissions", "operationId": "ExportFolders_UpdatePermissions", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateFilePermissionsVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateFilePermissionsVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateFilePermissionsVM" } } } }, "responses": { "204": { "description": "Folder's permissions has been updated" }, "400": { "description": "Id or VM is not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Folder or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/api/rp/v1/Exports/Folder/{id}": { "delete": { "tags": [ "Exports" ], "summary": "Delete specified folder", "description": "User with a Delete Entity permission can access this method.", "operationId": "ExportFolders_DeleteFolder", "parameters": [ { "name": "id", "in": "path", "description": "folder id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "204": { "description": "Folder succesfully deleted" }, "400": { "description": "Id is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Folder or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } }, "get": { "tags": [ "Exports" ], "summary": "Get specified folder", "description": "User with a Get Entity permission can access this method.", "operationId": "ExportFolders_GetFolder", "parameters": [ { "name": "id", "in": "path", "description": "folder id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "Returns specified folder", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileVM" } } } }, "400": { "description": "Id is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is blocked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Folder or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/api/rp/v1/Exports/Folder/{id}/ToBin": { "delete": { "tags": [ "Exports" ], "summary": "Move specified folder to recycle bin", "description": "User with a Delete Entity permission can access this method.", "operationId": "ExportFolders_MoveFolderToBin", "parameters": [ { "name": "id", "in": "path", "description": "folder id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "204": { "description": "Folder succesfully deleted" }, "400": { "description": "Id is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Folder or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/api/rp/v1/Exports/Folder/{id}/Recover": { "post": { "tags": [ "Exports" ], "summary": "Recover specified folder", "description": "User with a Delete Entity permission can access this method.", "operationId": "ExportFolders_RecoverFolder", "parameters": [ { "name": "id", "in": "path", "description": "folder id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } }, { "name": "recoveryPath", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "204": { "description": "Folder succesfully restored from bin" }, "400": { "description": "Id is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Folder or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/api/rp/v1/Exports/Folder/{id}/Breadcrumbs": { "get": { "tags": [ "Exports" ], "summary": "Get specified folder breadcrumbs", "description": "User with a Get Entity permission can access this method.", "operationId": "ExportFolders_GetBreadcrumbs", "parameters": [ { "name": "id", "in": "path", "description": "folder id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "Returns breadcrumbs parents list (starts from root folder)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BreadcrumbsVM" } } } }, "400": { "description": "folderId is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is blocked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Folder or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/api/rp/v1/Exports/Folder/{id}/size": { "get": { "tags": [ "Exports" ], "summary": "Get specified folder, calculate it's size", "description": "User with a Get Entity permission can access this method.", "operationId": "ExportFolders_CalculateFolderSize", "parameters": [ { "name": "id", "in": "path", "description": "folder id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "Returns specified folder", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FolderSizeVM" } } } }, "400": { "description": "Id is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is blocked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Folder or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/api/rp/v1/Exports/Folder/getOrCreate": { "get": { "tags": [ "Exports" ], "summary": "Get specified folder", "description": "User with a Get Entity permission can access this method.", "operationId": "ExportFolders_GetOrCreate", "parameters": [ { "name": "name", "in": "query", "description": "folder name", "schema": { "maxLength": 50, "minLength": 0, "type": "string" } }, { "name": "subscriptionId", "in": "query", "description": "subscriptionId", "schema": { "pattern": "(^$)|(^[A-Fa-f0-9]{24}$)", "type": "string" } }, { "name": "parentId", "in": "query", "description": "parent folder id", "schema": { "pattern": "(^$)|(^[A-Fa-f0-9]{24}$)", "type": "string" } } ], "responses": { "200": { "description": "Returns specified folder", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileVM" } } } }, "400": { "description": "Name or 1 of ids is not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is blocked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/api/rp/v1/Exports/Folder/{id}/ListFolders": { "get": { "tags": [ "Exports" ], "summary": "Get all folders from specified folder", "description": "User with a Get Entity permission can access this method.", "operationId": "ExportFolders_GetFolders", "parameters": [ { "name": "id", "in": "path", "description": "folder id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } }, { "name": "skip", "in": "query", "description": "number of files, that have to be skipped", "schema": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32", "default": 0 } }, { "name": "take", "in": "query", "description": "number of files, that have to be returned", "schema": { "maximum": 120, "minimum": 1, "type": "integer", "format": "int32", "default": 10 } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "$ref": "#/components/schemas/FileSorting" } }, { "name": "desc", "in": "query", "description": "", "schema": { "type": "boolean", "default": false } }, { "name": "searchPattern", "in": "query", "description": "", "schema": { "maxLength": 100, "minLength": 0, "type": "string", "default": "" } }, { "name": "useRegex", "in": "query", "description": "", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Gets all folders from a specified folder", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilesVM" } } } }, "400": { "description": "1 of params is not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is blocked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Folder or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/api/rp/v1/Exports/Folder/{id}/CountFolders": { "get": { "tags": [ "Exports" ], "summary": "Get count of folders what contains in a specified folder", "description": "User with a Get Count permission can access this method.", "operationId": "ExportFolders_GetFoldersCount", "parameters": [ { "name": "id", "in": "path", "description": "folder id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "Returns count of folders in a specified folder", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountVM" } } } }, "400": { "description": "folderId is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is blocked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Folder or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/api/rp/v1/Exports/Root": { "get": { "tags": [ "Exports" ], "summary": "Get user's root folder (without parents)", "description": "> Breakchange. Now user model doesn't contain a root folders.\r\nThis method can return error 400 and 404 when subscription is not found.", "operationId": "ExportFolders_GetRootFolder", "parameters": [ { "name": "subscriptionId", "in": "query", "schema": { "pattern": "(^$)|(^[A-Fa-f0-9]{24}$)", "type": "string" } } ], "responses": { "200": { "description": "Gets user's root folder (without parents)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileVM" } } } }, "402": { "description": "Subscription is blocked" }, "403": { "description": "No permissions to get root folder" }, "404": { "description": "Not found subscription" }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/api/rp/v1/Exports/Folder/{id}/Move/{folderId}": { "post": { "tags": [ "Exports" ], "summary": "Move folder to a specified folder", "description": "User with a Update Place permission for a folder and Create Entity\r\nfor a Parent Folder can access this method.", "operationId": "ExportFolders_MoveFolder", "parameters": [ { "name": "id", "in": "path", "description": "moving folder id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } }, { "name": "folderId", "in": "path", "description": "destination folder id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "Folder has been moved to a specified folder", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileVM" } } } }, "400": { "description": "folderId or parentFolderId is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Folder or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/api/rp/v1/Exports/Folder/{id}/Copy/{folderId}": { "post": { "tags": [ "Exports" ], "summary": "Move folder to a specified folder", "description": "User with a Update Place permission for a folder and Create Entity\r\nfor a Parent Folder can access this method.", "operationId": "ExportFolders_CopyFolder", "parameters": [ { "name": "id", "in": "path", "description": "moving folder id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } }, { "name": "folderId", "in": "path", "description": "destination folder id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "Folder has been moved to a specified folder", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileVM" } } } }, "400": { "description": "folderId or parentFolderId is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Folder or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/api/rp/v1/Exports/Folder/{id}/Folder": { "post": { "tags": [ "Exports" ], "summary": "Create folder", "description": "User with a Create Entity permisison can access this method.", "operationId": "ExportFolders_PostFolder", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of parent folder id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "description": "create VM", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportFolderCreateVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExportFolderCreateVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ExportFolderCreateVM" } } } }, "responses": { "200": { "description": "New folder has been created)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileVM" } } } }, "400": { "description": "Parent folder id or VM is not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "parent folder/subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rp/v1/Exports/Folder/{id}/Rename": { "put": { "tags": [ "Exports" ], "summary": "Rename a folder", "description": "User with a Update Name permision can access this method.", "operationId": "ExportFolders_RenameFolder", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FolderRenameVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FolderRenameVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FolderRenameVM" } } } }, "responses": { "200": { "description": "Folder name has been updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileVM" } } } }, "400": { "description": "folderId or VM is not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Folder or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/api/rp/v1/Exports/Folder/{id}/Icon": { "put": { "tags": [ "Exports" ], "summary": "Update a folder's icon", "description": "User with a Update Icon permission can access this method.", "operationId": "ExportFolders_UpdateIcon", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of folder", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "description": "Update icon model", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FolderIconVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FolderIconVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FolderIconVM" } } } }, "responses": { "200": { "description": "Folder's icon has been updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileVM" } } } }, "400": { "description": "folderId or VM is not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Folder or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/api/rp/v1/Exports/Folder/{id}/UpdateTags": { "put": { "tags": [ "Exports" ], "summary": "Update tags", "description": "User with a Update Tags permission can access this method.", "operationId": "ExportFolders_UpdateTags", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FolderTagsUpdateVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FolderTagsUpdateVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FolderTagsUpdateVM" } } } }, "responses": { "200": { "description": "Tags has been updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileVM" } } } }, "400": { "description": "folderId or Tags is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Folder or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/api/rp/v1/Exports/File/{id}": { "get": { "tags": [ "Exports" ], "summary": "Get export by specified id", "operationId": "Exports_GetFile", "parameters": [ { "name": "id", "in": "path", "description": "id of export", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "Export is found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportVM" } } } }, "400": { "description": "id is not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You have no get permission", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Export or subscription is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } }, "delete": { "tags": [ "Exports" ], "summary": "Delete specified file", "description": "User with Delete permission can access the method.", "operationId": "Exports_DeleteFile", "parameters": [ { "name": "id", "in": "path", "description": "file id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "204": { "description": "File succesfully deleted" }, "400": { "description": "Id is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "File or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Exception thrown" } } } }, "/api/rp/v1/Exports/File/TaskMessage/{taskMessageId}": { "get": { "tags": [ "Exports" ], "summary": "Get export by specified task message id", "operationId": "Exports_GetByTaskMessageId", "parameters": [ { "name": "taskMessageId", "in": "path", "description": "task message id", "required": true, "schema": { "pattern": "^([0-9a-f]{8}([-][0-9a-f]{4}){3}[-][0-9a-f]{12})$", "type": "string" } } ], "responses": { "200": { "description": "Export is found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportVM" } } } }, "400": { "description": "id is not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Export or subscription is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/api/rp/v1/Exports/File/Task/{taskId}": { "get": { "tags": [ "Exports" ], "summary": "Get exports by specified task id", "operationId": "Exports_GetByTaskId", "parameters": [ { "name": "taskId", "in": "path", "description": "task id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "Exports are found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportsVM" } } } }, "400": { "description": "id is not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Export or subscription is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/api/rp/v1/Exports/File/{id}/Copy/{folderId}": { "post": { "tags": [ "Exports" ], "summary": "Copy file to a specified folder", "operationId": "Exports_CopyFile", "parameters": [ { "name": "id", "in": "path", "description": "file id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } }, { "name": "folderId", "in": "path", "description": "folder id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "File has been copied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportVM" } } } }, "400": { "description": "FileId or folderId is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "File, subscription or folder not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Exception thrown" } } } }, "/api/rp/v1/Exports/File/{id}/sharingKey": { "post": { "tags": [ "Exports" ], "summary": "Create a new key, that can be used to share access to a file\r\n(You need Administrate.Anon permission to create a new key)", "operationId": "Exports_CreateSharingKey", "parameters": [ { "name": "id", "in": "path", "description": "file id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "description": "parameters for sharing key creation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateFileShareVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateFileShareVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateFileShareVM" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileSharingKeysVM" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" } } }, "delete": { "tags": [ "Exports" ], "summary": "Deletes a sharing key, making links, that utilizing it no longer work", "operationId": "Exports_DeleteSharingKey", "parameters": [ { "name": "id", "in": "path", "description": "file id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } }, { "name": "key", "in": "path", "description": "key to delete", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" } } } }, "/api/rp/v1/Exports/File/{id}/sharingKeys": { "get": { "tags": [ "Exports" ], "summary": "Returns all sharing keys, associated with the file", "operationId": "Exports_GetSharingKeys", "parameters": [ { "name": "id", "in": "path", "description": "file id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileSharingKeysVM" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" } } } }, "/api/rp/v1/Exports/File/{id}/ToBin": { "delete": { "tags": [ "Exports" ], "summary": "Move specified file to recycle bin", "description": "User with Delete permission can access the method.", "operationId": "Exports_MoveFileToBin", "parameters": [ { "name": "id", "in": "path", "description": "file id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "204": { "description": "File succesfully deleted" }, "400": { "description": "Id is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "File or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Exception thrown" } } } }, "/api/rp/v1/Exports/File/{id}/Recover": { "post": { "tags": [ "Exports" ], "summary": "Recover specified file from bin", "description": "User with Delete permission can access the method.", "operationId": "Exports_RecoverFile", "parameters": [ { "name": "id", "in": "path", "description": "file id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } }, { "name": "recoveryPath", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "204": { "description": "File succesfully recovered" }, "400": { "description": "Id is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "File or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Exception thrown" } } } }, "/api/rp/v1/Exports/File/{id}/History": { "get": { "tags": [ "Exports" ], "summary": "Returns list of actions, performed on this file", "operationId": "Exports_GetFileHistory", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } }, { "name": "skip", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "take", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "default": 10 } } ], "responses": { "200": { "description": "Returns the actions", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuditActionsVM" } } } }, "400": { "description": "Id is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "File or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rp/v1/Exports/Folder/{id}/CountFiles": { "get": { "tags": [ "Exports" ], "summary": "Get count of files what contains in a specified folder", "description": "User with Get Count permission can access this method.", "operationId": "Exports_GetFilesCount", "parameters": [ { "name": "id", "in": "path", "description": "folder id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "Returns count of the files in a specified folder", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountVM" } } } }, "400": { "description": "FolderId is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Folder or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Exception thrown" } } } }, "/api/rp/v1/Exports/Folder/{id}/ListFiles": { "get": { "tags": [ "Exports" ], "summary": "Get all files from specified folder.
\r\nUser with Get Entity permission can access this method.
\r\nThe method will returns minimal infomration about the file:
\r\nid, name, size, editedTime, createdTime, tags, status, statusReason.", "operationId": "Exports_GetFilesList", "parameters": [ { "name": "id", "in": "path", "description": "folder id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } }, { "name": "skip", "in": "query", "description": "number of files, that have to be skipped", "schema": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32", "default": 0 } }, { "name": "take", "in": "query", "description": "number of files, that have to be returned", "schema": { "maximum": 120, "minimum": 1, "type": "integer", "format": "int32", "default": 10 } }, { "name": "searchPattern", "in": "query", "description": "", "schema": { "maxLength": 100, "minLength": 0, "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "$ref": "#/components/schemas/FileSorting" } }, { "name": "desc", "in": "query", "description": "", "schema": { "type": "boolean", "default": false } }, { "name": "useRegex", "in": "query", "description": "", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Returns list of the files from a specified folder", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportsVM" } } } }, "400": { "description": "Invalid params", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "File, subscription or folder not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Exception thrown" } } } }, "/api/rp/v1/Exports/File/{id}/permissions": { "get": { "tags": [ "Exports" ], "operationId": "Exports_GetPermissions", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilePermissionsVM" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "post": { "tags": [ "Exports" ], "summary": "Update permissions", "operationId": "Exports_UpdatePermissions", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateFilePermissionsVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateFilePermissionsVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateFilePermissionsVM" } } } }, "responses": { "204": { "description": "File's permissions has been updated" }, "400": { "description": "FileId or VM is not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "File or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Exception thrown" } } } }, "/api/rp/v1/Exports/File/{id}/mypermissions": { "get": { "tags": [ "Exports" ], "summary": "Get current user's permissions to file", "operationId": "Exports_GetMyPermissions", "parameters": [ { "name": "id", "in": "path", "description": "file id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "got permissions successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilePermissionCRUDVM" } } } }, "400": { "description": "Invalid params", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "File, subscription or folder not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" } } } }, "/api/rp/v1/Exports/File/{id}/Move/{folderId}": { "post": { "tags": [ "Exports" ], "summary": "Move file to a specified folder", "description": "User with a Update Place permission for a folder and Create Entity\r\nfor a Parent Folder can access this method.", "operationId": "Exports_MoveFile", "parameters": [ { "name": "id", "in": "path", "description": "file id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } }, { "name": "folderId", "in": "path", "description": "folder id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "File has been moved", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportVM" } } } }, "400": { "description": "fileId or folderId is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "File, subscription or folder not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Exception thrown" } } } }, "/api/rp/v1/Exports/File/{id}/Rename": { "put": { "tags": [ "Exports" ], "summary": "Rename a file", "description": "User with Update Name permission can access this method.", "operationId": "Exports_RenameFile", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileRenameVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FileRenameVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FileRenameVM" } } } }, "responses": { "200": { "description": "File name has been updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportVM" } } } }, "400": { "description": "FileId is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "File or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Exception thrown" } } } }, "/api/rp/v1/Exports/File/{id}/Icon": { "put": { "tags": [ "Exports" ], "summary": "Update a files's icon", "description": "User with Update Icon permission can access this method.", "operationId": "Exports_UpdateIcon", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileIconVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FileIconVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FileIconVM" } } } }, "responses": { "200": { "description": "File's icon has been updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportVM" } } } }, "400": { "description": "FileId is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "File or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Exception thrown" } } } }, "/api/rp/v1/Exports/File/{id}/UpdateTags": { "put": { "tags": [ "Exports" ], "summary": "Update tags", "description": "User with Update Tags permission can access this method.", "operationId": "Exports_UpdateTags", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileTagsUpdateVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FileTagsUpdateVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FileTagsUpdateVM" } } } }, "responses": { "200": { "description": "Tags has been updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportVM" } } } }, "400": { "description": "FileId is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "File or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Exception thrown" } } } }, "/api/manage/v1/Groups/{id}/permissions": { "post": { "tags": [ "Groups" ], "summary": "Update permissions", "operationId": "Groups_UpdatePermissions", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateGroupPermissionsVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateGroupPermissionsVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateGroupPermissionsVM" } } } }, "responses": { "204": { "description": "Permissions are updated" }, "400": { "description": "id or VM is not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You have no permissions to work with groups", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Group or subscription is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } }, "get": { "tags": [ "Groups" ], "summary": "Gets group permissions by identifier", "operationId": "Groups_GetPermissions", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of group", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "Succesfully retured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupPermissionsVM" } } } }, "400": { "description": "The request is wrong", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Group with this identifier or subscription is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/manage/v1/Groups/{id}": { "get": { "tags": [ "Groups" ], "summary": "Gets group by identifier", "operationId": "Groups_GetGroup", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of group", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "Succesfully retured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupVM" } } } }, "400": { "description": "The request is wrong", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Group with this identifier or subscription is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Exception thrown" } } }, "delete": { "tags": [ "Groups" ], "summary": "Delete group by identifier", "operationId": "Groups_DeleteGroup", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of group", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "204": { "description": "Succesfully delete" }, "400": { "description": "The request is wrong", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscripiton is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Group with this identifier or subscription is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Exception thrown" } } } }, "/api/manage/v1/Groups": { "get": { "tags": [ "Groups" ], "summary": "Returns a list of current user's groups
\r\nThis method will return following data about groups :
\r\nId, Name, Created time (UTC), Edited time (UTC), creator id,
\r\neditor id, subscription id", "operationId": "Groups_GetGroupList", "parameters": [ { "name": "skip", "in": "query", "description": "How many groups need to skip", "schema": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32", "default": 0 } }, { "name": "take", "in": "query", "description": "How many groups need to take", "schema": { "maximum": 120, "minimum": 1, "type": "integer", "format": "int32", "default": 10 } } ], "responses": { "200": { "description": "Succesfully retured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupsVM" } } } }, "400": { "description": "The request is wrong", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "User is unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Subscription is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "post": { "tags": [ "Groups" ], "summary": "Create a new user group", "operationId": "Groups_CreateGroup", "requestBody": { "description": "Model for creating", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateGroupVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateGroupVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateGroupVM" } } } }, "responses": { "200": { "description": "Succesfully created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupVM" } } } }, "400": { "description": "The request is wrong", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Information from view model is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/manage/v1/Groups/{id}/rename": { "put": { "tags": [ "Groups" ], "summary": "Rename group by identifier", "operationId": "Groups_RenameGroup", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of group", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "description": "Model for renaming", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RenameGroupVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RenameGroupVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RenameGroupVM" } } }, "required": true }, "responses": { "200": { "description": "Succesfully renamed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupVM" } } } }, "400": { "description": "The request is wrong", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Group with this identifier or subscription is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Exception thrown" } } } }, "/api/manage/v1/Groups/{id}/mypermissions": { "get": { "tags": [ "Groups" ], "summary": "Get current user's permissions to group", "operationId": "Groups_GetMyPermissions", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of group", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "Succesfully retured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupPermissionCRUDVM" } } } }, "400": { "description": "The request is wrong", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Group with this identifier or subscription is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" } } } }, "/api/manage/v1/Groups/{id}/Users": { "get": { "tags": [ "GroupUsers" ], "summary": "Returns users in the group by identifier", "operationId": "GroupUsers_GetUsersInGroup", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of group", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } }, { "name": "skip", "in": "query", "description": "how many to skip", "schema": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32", "default": 0 } }, { "name": "take", "in": "query", "description": "how many to take", "schema": { "maximum": 120, "minimum": 1, "type": "integer", "format": "int32", "default": 10 } } ], "responses": { "200": { "description": "Succesfully retured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupUsersVM" } } } }, "400": { "description": "The request is wrong", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Group with this identifier or subscription is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Exception thrown" } } } }, "/api/manage/v1/Groups/{id}/Users/{userId}": { "put": { "tags": [ "GroupUsers" ], "summary": "Add user to the group by identifier", "operationId": "GroupUsers_AddUserToGroup", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of group", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } }, { "name": "userId", "in": "path", "description": "Identifier of user", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Succesfully retured" }, "400": { "description": "The request is wrong", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Group with this identifier, subscription or user is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Exception thrown" } } }, "delete": { "tags": [ "GroupUsers" ], "summary": "Remove user from the group by identifier", "operationId": "GroupUsers_RemoveFromGroup", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of group", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } }, { "name": "userId", "in": "path", "description": "Identifier of user", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Succesfully removed" }, "400": { "description": "The request is wrong", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Group with this identifier, subscription or user is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Exception thrown" } } } }, "/api/manage/v1/Groups/{id}/leave": { "delete": { "tags": [ "GroupUsers" ], "summary": "Leave from the group", "operationId": "GroupUsers_LeaveFromGroup", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of group", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "204": { "description": "Succesfully removed" }, "400": { "description": "The request is wrong", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Group with this identifier or subscription is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Exception thrown" } } } }, "/api/backend/v1/HealthCheck": { "get": { "tags": [ "HealthCheck" ], "summary": "healthcheck", "operationId": "HealthCheckData_Get", "responses": { "200": { "description": "Our backend is alive!" } } } }, "/api/rp/v1/Reports/Folder/{id}/CountFolderAndFiles": { "get": { "tags": [ "Reports" ], "summary": "Get count of files and folders what contains in a specified folder", "description": "User with a Get Count permission can access this method.", "operationId": "ReportFolderAndFile_GetCount", "parameters": [ { "name": "id", "in": "path", "description": "folder id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } }, { "name": "searchPattern", "in": "query", "description": "string, that must be incuded in file or folder name to be counted
\r\n (leave undefined to count all files and folders)", "schema": { "maxLength": 100, "minLength": 0, "type": "string" } }, { "name": "useRegex", "in": "query", "description": "set this to true if you want to use regular expression to search", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Returns count of the files in a specified folder", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountVM" } } } }, "400": { "description": "Params are not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Payment required, subscription is blocked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Folder or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/api/rp/v1/Reports/Folder/{id}/ListFolderAndFiles": { "get": { "tags": [ "Reports" ], "summary": "Get all folders and files from specified folder", "description": "User with a Get Entity permission can access this method.", "operationId": "ReportFolderAndFile_GetFoldersAndFiles", "parameters": [ { "name": "id", "in": "path", "description": "folder id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } }, { "name": "skip", "in": "query", "description": "number of folder and files, that have to be skipped", "schema": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32", "default": 0 } }, { "name": "take", "in": "query", "description": "number of folder and files, that have to be returned", "schema": { "maximum": 120, "minimum": 1, "type": "integer", "format": "int32", "default": 10 } }, { "name": "orderBy", "in": "query", "description": "indicates a field to sort by", "schema": { "$ref": "#/components/schemas/FileSorting" } }, { "name": "desc", "in": "query", "description": "indicates if sorting is descending", "schema": { "type": "boolean", "default": false } }, { "name": "searchPattern", "in": "query", "description": "", "schema": { "maxLength": 100, "minLength": 0, "type": "string", "default": "" } }, { "name": "useRegex", "in": "query", "description": "", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Returns list of the files from a specified folder", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilesVM" } } } }, "400": { "description": "Params are not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Payment required, subscription is blocked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Subscription or folder not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rp/v1/Reports/{subscriptionId}/ListRecycleBinFolderAndFiles": { "get": { "tags": [ "Reports" ], "summary": "Get all folders and files from recycle bin", "description": "User with a Get DeletedFiles permission can access this method.", "operationId": "ReportFolderAndFile_GetRecycleBinFoldersAndFiles", "parameters": [ { "name": "subscriptionId", "in": "path", "description": "subscription id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } }, { "name": "skip", "in": "query", "description": "number of folder and files, that have to be skipped", "schema": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32", "default": 0 } }, { "name": "take", "in": "query", "description": "number of folder and files, that have to be returned", "schema": { "maximum": 120, "minimum": 1, "type": "integer", "format": "int32", "default": 10 } }, { "name": "orderBy", "in": "query", "description": "indicates a field to sort by", "schema": { "$ref": "#/components/schemas/FileSorting" } }, { "name": "desc", "in": "query", "description": "indicates if sorting is descending", "schema": { "type": "boolean", "default": false } }, { "name": "searchPattern", "in": "query", "description": "", "schema": { "maxLength": 100, "minLength": 0, "type": "string", "default": "" } }, { "name": "useRegex", "in": "query", "description": "", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Returns list of the files from a specified folder", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilesVM" } } } }, "400": { "description": "Params are not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Payment required, subscription is blocked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rp/v1/Reports/{subscriptionId}/CountRecycleBinFolderAndFiles": { "get": { "tags": [ "Reports" ], "summary": "Count all folders and files from recycle bin", "description": "User with a Get DeletedFiles permission can access this method.", "operationId": "ReportFolderAndFile_CountRecycleBinFoldersAndFiles", "parameters": [ { "name": "subscriptionId", "in": "path", "description": "subscription id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } }, { "name": "searchPattern", "in": "query", "description": "", "schema": { "maxLength": 100, "minLength": 0, "type": "string", "default": "" } }, { "name": "useRegex", "in": "query", "description": "", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Returns list of the files from a specified folder", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountVM" } } } }, "400": { "description": "Params are not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Payment required, subscription is blocked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rp/v1/Reports/{subscriptionId}/ClearRecycleBin": { "delete": { "tags": [ "Reports" ], "summary": "Delete all folders and files from recycle bin", "description": "User with a Delete RecycleBin permission can access this method.", "operationId": "ReportFolderAndFile_ClearRecycleBin", "parameters": [ { "name": "subscriptionId", "in": "path", "description": "subscription id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "204": { "description": "All folders and files in bin have been deleted" }, "400": { "description": "Subscription id is not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Payment required, subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rp/v1/Reports/{subscriptionId}/RecoverRecycleBin": { "post": { "tags": [ "Reports" ], "summary": "Recover all folders and files from recycle bin", "description": "User with a Create RecycleBin permission can access this method.", "operationId": "ReportFolderAndFile_RecoverAllFromRecycleBin", "parameters": [ { "name": "subscriptionId", "in": "path", "description": "subscription id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "204": { "description": "All folders and files in bin have been restored" }, "400": { "description": "Subscription id is not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Payment required, subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rp/v1/Reports/{subscriptionId}/DeleteFiles": { "post": { "tags": [ "Reports" ], "summary": "Delete folders and files", "description": "User with a Delete permission can access this method.", "operationId": "ReportFolderAndFile_DeleteFiles", "parameters": [ { "name": "subscriptionId", "in": "path", "description": "id of current subscription", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "description": "VM with files' ids and params of their destination", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectedFilesVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SelectedFilesVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SelectedFilesVM" } } } }, "responses": { "204": { "description": "All folders and files have been deleted" }, "400": { "description": "Subscription id or VM is not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Payment required, subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rp/v1/Reports/{subscriptionId}/RecoverFiles": { "post": { "tags": [ "Reports" ], "summary": "Recover folders and files from bin", "description": "User with a SubscriptionCreate permission can access this method.", "operationId": "ReportFolderAndFile_RecoverFiles", "parameters": [ { "name": "subscriptionId", "in": "path", "description": "id of current subscription", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "description": "VM with files' ids and params of their destination", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectedFilesVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SelectedFilesVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SelectedFilesVM" } } } }, "responses": { "204": { "description": "All folders and files have been recovered" }, "400": { "description": "Subscription id or VM is not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Payment required, subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rp/v1/Reports/{subscriptionId}/ToBin": { "post": { "tags": [ "Reports" ], "summary": "Move folders and files to bin", "description": "User with a Delete permission can access this method.", "operationId": "ReportFolderAndFile_MoveFilesToBin", "parameters": [ { "name": "subscriptionId", "in": "path", "description": "id of current subscription", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "description": "VM with files' ids and params of their destination", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectedFilesVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SelectedFilesVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SelectedFilesVM" } } } }, "responses": { "204": { "description": "All folders and files have been moved to bin" }, "400": { "description": "Subscription id or VM is not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Payment required, subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rp/v1/Reports/{subscriptionId}/CopyFiles": { "post": { "tags": [ "Reports" ], "summary": "Copy folders and files to a specified folder", "description": "User with a Get permission for a files and Create permission for a destination folder can access this method.", "operationId": "ReportFolderAndFile_CopyFiles", "parameters": [ { "name": "subscriptionId", "in": "path", "description": "id of current subscription", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "description": "VM with files' ids and params of their destination", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectedFilesVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SelectedFilesVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SelectedFilesVM" } } } }, "responses": { "204": { "description": "All folders and files have been copied" }, "400": { "description": "FolderId is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Payment required, subscription is blocked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "File or folder not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" } } } }, "/api/rp/v1/Reports/{subscriptionId}/MoveFiles": { "post": { "tags": [ "Reports" ], "summary": "Move folders and files to a specified folder", "description": "User with a Update Place permission for a files and Create permission for a destination folder can access this method.", "operationId": "ReportFolderAndFile_MoveFiles", "parameters": [ { "name": "subscriptionId", "in": "path", "description": "id of current subscription", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "description": "VM with files' ids and params of their destination", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectedFilesVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SelectedFilesVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SelectedFilesVM" } } } }, "responses": { "204": { "description": "All folders and files have been moved" }, "400": { "description": "FolderId is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Payment required, subscription is blocked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "File or folder not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" } } } }, "/api/rp/v1/Reports/Folder/{id}/Export": { "post": { "tags": [ "Reports" ], "summary": "Export specified report folder to a specified format", "description": "User with Execute Export permission on report folder and\r\nCreate Entity on an export folder can access this method.", "operationId": "ReportFolders_Export", "parameters": [ { "name": "id", "in": "path", "description": "report folder id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "description": "export parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportReportVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExportReportVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ExportReportVM" } } } }, "responses": { "200": { "description": "Specified report folder has been exported", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileVM" } } } }, "400": { "description": "Report folder Id is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Exports folder not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rp/v1/Reports/Folder/{id}/permissions": { "get": { "tags": [ "Reports" ], "summary": "Get all folder permissions", "operationId": "ReportFolders_GetPermissions", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "returned permissions", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilePermissionsVM" } } } }, "400": { "description": "id is not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is blocked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Folder or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rp/v1/Reports/Folder/{folderId}/mypermissions": { "get": { "tags": [ "Reports" ], "summary": "Get user's permissions for a folder by id", "operationId": "ReportFolders_GetMyPermissions", "parameters": [ { "name": "folderId", "in": "path", "description": "folder id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "Succesfully returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilePermissionCRUDVM" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rp/v1/Reports/{id}/permissions": { "post": { "tags": [ "Reports" ], "summary": "Update permissions", "operationId": "ReportFolders_UpdatePermissions", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateFilePermissionsVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateFilePermissionsVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateFilePermissionsVM" } } } }, "responses": { "204": { "description": "Folder's permissions has been updated" }, "400": { "description": "Id or VM is not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Folder or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/api/rp/v1/Reports/Folder/{id}": { "delete": { "tags": [ "Reports" ], "summary": "Delete specified folder", "description": "User with a Delete Entity permission can access this method.", "operationId": "ReportFolders_DeleteFolder", "parameters": [ { "name": "id", "in": "path", "description": "folder id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "204": { "description": "Folder succesfully deleted" }, "400": { "description": "Id is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Folder or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } }, "get": { "tags": [ "Reports" ], "summary": "Get specified folder", "description": "User with a Get Entity permission can access this method.", "operationId": "ReportFolders_GetFolder", "parameters": [ { "name": "id", "in": "path", "description": "folder id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "Returns specified folder", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileVM" } } } }, "400": { "description": "Id is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is blocked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Folder or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/api/rp/v1/Reports/Folder/{id}/ToBin": { "delete": { "tags": [ "Reports" ], "summary": "Move specified folder to recycle bin", "description": "User with a Delete Entity permission can access this method.", "operationId": "ReportFolders_MoveFolderToBin", "parameters": [ { "name": "id", "in": "path", "description": "folder id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "204": { "description": "Folder succesfully deleted" }, "400": { "description": "Id is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Folder or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/api/rp/v1/Reports/Folder/{id}/Recover": { "post": { "tags": [ "Reports" ], "summary": "Recover specified folder", "description": "User with a Delete Entity permission can access this method.", "operationId": "ReportFolders_RecoverFolder", "parameters": [ { "name": "id", "in": "path", "description": "folder id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } }, { "name": "recoveryPath", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "204": { "description": "Folder succesfully restored from bin" }, "400": { "description": "Id is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Folder or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/api/rp/v1/Reports/Folder/{id}/Breadcrumbs": { "get": { "tags": [ "Reports" ], "summary": "Get specified folder breadcrumbs", "description": "User with a Get Entity permission can access this method.", "operationId": "ReportFolders_GetBreadcrumbs", "parameters": [ { "name": "id", "in": "path", "description": "folder id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "Returns breadcrumbs parents list (starts from root folder)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BreadcrumbsVM" } } } }, "400": { "description": "folderId is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is blocked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Folder or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/api/rp/v1/Reports/Folder/{id}/size": { "get": { "tags": [ "Reports" ], "summary": "Get specified folder, calculate it's size", "description": "User with a Get Entity permission can access this method.", "operationId": "ReportFolders_CalculateFolderSize", "parameters": [ { "name": "id", "in": "path", "description": "folder id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "Returns specified folder", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FolderSizeVM" } } } }, "400": { "description": "Id is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is blocked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Folder or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/api/rp/v1/Reports/Folder/getOrCreate": { "get": { "tags": [ "Reports" ], "summary": "Get specified folder", "description": "User with a Get Entity permission can access this method.", "operationId": "ReportFolders_GetOrCreate", "parameters": [ { "name": "name", "in": "query", "description": "folder name", "schema": { "maxLength": 50, "minLength": 0, "type": "string" } }, { "name": "subscriptionId", "in": "query", "description": "subscriptionId", "schema": { "pattern": "(^$)|(^[A-Fa-f0-9]{24}$)", "type": "string" } }, { "name": "parentId", "in": "query", "description": "parent folder id", "schema": { "pattern": "(^$)|(^[A-Fa-f0-9]{24}$)", "type": "string" } } ], "responses": { "200": { "description": "Returns specified folder", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileVM" } } } }, "400": { "description": "Name or 1 of ids is not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is blocked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/api/rp/v1/Reports/Folder/{id}/ListFolders": { "get": { "tags": [ "Reports" ], "summary": "Get all folders from specified folder", "description": "User with a Get Entity permission can access this method.", "operationId": "ReportFolders_GetFolders", "parameters": [ { "name": "id", "in": "path", "description": "folder id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } }, { "name": "skip", "in": "query", "description": "number of files, that have to be skipped", "schema": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32", "default": 0 } }, { "name": "take", "in": "query", "description": "number of files, that have to be returned", "schema": { "maximum": 120, "minimum": 1, "type": "integer", "format": "int32", "default": 10 } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "$ref": "#/components/schemas/FileSorting" } }, { "name": "desc", "in": "query", "description": "", "schema": { "type": "boolean", "default": false } }, { "name": "searchPattern", "in": "query", "description": "", "schema": { "maxLength": 100, "minLength": 0, "type": "string", "default": "" } }, { "name": "useRegex", "in": "query", "description": "", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Gets all folders from a specified folder", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilesVM" } } } }, "400": { "description": "1 of params is not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is blocked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Folder or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/api/rp/v1/Reports/Folder/{id}/CountFolders": { "get": { "tags": [ "Reports" ], "summary": "Get count of folders what contains in a specified folder", "description": "User with a Get Count permission can access this method.", "operationId": "ReportFolders_GetFoldersCount", "parameters": [ { "name": "id", "in": "path", "description": "folder id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "Returns count of folders in a specified folder", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountVM" } } } }, "400": { "description": "folderId is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is blocked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Folder or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/api/rp/v1/Reports/Root": { "get": { "tags": [ "Reports" ], "summary": "Get user's root folder (without parents)", "description": "> Breakchange. Now user model doesn't contain a root folders.\r\nThis method can return error 400 and 404 when subscription is not found.", "operationId": "ReportFolders_GetRootFolder", "parameters": [ { "name": "subscriptionId", "in": "query", "schema": { "pattern": "(^$)|(^[A-Fa-f0-9]{24}$)", "type": "string" } } ], "responses": { "200": { "description": "Gets user's root folder (without parents)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileVM" } } } }, "402": { "description": "Subscription is blocked" }, "403": { "description": "No permissions to get root folder" }, "404": { "description": "Not found subscription" }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/api/rp/v1/Reports/Folder/{id}/Move/{folderId}": { "post": { "tags": [ "Reports" ], "summary": "Move folder to a specified folder", "description": "User with a Update Place permission for a folder and Create Entity\r\nfor a Parent Folder can access this method.", "operationId": "ReportFolders_MoveFolder", "parameters": [ { "name": "id", "in": "path", "description": "moving folder id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } }, { "name": "folderId", "in": "path", "description": "destination folder id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "Folder has been moved to a specified folder", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileVM" } } } }, "400": { "description": "folderId or parentFolderId is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Folder or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/api/rp/v1/Reports/Folder/{id}/Copy/{folderId}": { "post": { "tags": [ "Reports" ], "summary": "Move folder to a specified folder", "description": "User with a Update Place permission for a folder and Create Entity\r\nfor a Parent Folder can access this method.", "operationId": "ReportFolders_CopyFolder", "parameters": [ { "name": "id", "in": "path", "description": "moving folder id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } }, { "name": "folderId", "in": "path", "description": "destination folder id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "Folder has been moved to a specified folder", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileVM" } } } }, "400": { "description": "folderId or parentFolderId is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Folder or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/api/rp/v1/Reports/Folder/{id}/Folder": { "post": { "tags": [ "Reports" ], "summary": "Create folder", "description": "User with a Create Entity permisison can access this method.", "operationId": "ReportFolders_PostFolder", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of parent folder id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "description": "create VM", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportFolderCreateVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReportFolderCreateVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReportFolderCreateVM" } } } }, "responses": { "200": { "description": "New folder has been created)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileVM" } } } }, "400": { "description": "Parent folder id or VM is not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "parent folder/subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rp/v1/Reports/Folder/{id}/Rename": { "put": { "tags": [ "Reports" ], "summary": "Rename a folder", "description": "User with a Update Name permision can access this method.", "operationId": "ReportFolders_RenameFolder", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FolderRenameVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FolderRenameVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FolderRenameVM" } } } }, "responses": { "200": { "description": "Folder name has been updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileVM" } } } }, "400": { "description": "folderId or VM is not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Folder or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/api/rp/v1/Reports/Folder/{id}/Icon": { "put": { "tags": [ "Reports" ], "summary": "Update a folder's icon", "description": "User with a Update Icon permission can access this method.", "operationId": "ReportFolders_UpdateIcon", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of folder", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "description": "Update icon model", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FolderIconVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FolderIconVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FolderIconVM" } } } }, "responses": { "200": { "description": "Folder's icon has been updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileVM" } } } }, "400": { "description": "folderId or VM is not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Folder or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/api/rp/v1/Reports/Folder/{id}/UpdateTags": { "put": { "tags": [ "Reports" ], "summary": "Update tags", "description": "User with a Update Tags permission can access this method.", "operationId": "ReportFolders_UpdateTags", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FolderTagsUpdateVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FolderTagsUpdateVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FolderTagsUpdateVM" } } } }, "responses": { "200": { "description": "Tags has been updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileVM" } } } }, "400": { "description": "folderId or Tags is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Folder or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/api/rp/v1/Reports/File/{id}/Export": { "post": { "tags": [ "Reports" ], "summary": "Export specified report to a specified format", "description": "User with Execute Export permission on prepared report and\r\nCreate Entity on an export folder can access this method.", "operationId": "Reports_Export", "parameters": [ { "name": "id", "in": "path", "description": "report id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "description": "export parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportReportVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExportReportVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ExportReportVM" } } } }, "responses": { "200": { "description": "Specified report has been exported", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportVM" } } } }, "204": { "description": "Specified report has been exported" }, "400": { "description": "Report Id is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Exports folder not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rp/v1/Reports/File/{id}/StaticPreview": { "post": { "tags": [ "Reports" ], "summary": "Make preview for the report.\r\nGenerate a new or return exist prepared svg files.\r\nIf template was changed will be returned a new.\r\nPass the `` parameter to check prepared timestamp", "operationId": "Reports_StaticPreview", "parameters": [ { "name": "id", "in": "path", "description": "template id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "description": "Model with parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PreviewReportVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PreviewReportVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PreviewReportVM" } } } }, "responses": { "200": { "description": "Specified template has been prepared", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportVM" } } } }, "204": { "description": "Specified template has been prepared" }, "400": { "description": "Template Id is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Template or folder not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rp/v2/Reports/Folder/{id}/File": { "post": { "tags": [ "Reports" ], "summary": "Alternative api for upload a file to the specified folder!", "description": "User with Create Entity permission can access this method.", "operationId": "Reports_UploadFileV2", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of folder", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "FileContent" ], "type": "object", "properties": { "TemplateId": { "pattern": "(^$)|(^[A-Fa-f0-9]{24}$)", "type": "string", "nullable": true }, "Tags": { "maxLength": 50, "minLength": 1, "maxItems": 3, "type": "array", "items": { "type": "string" }, "nullable": true }, "Icon": { "type": "string", "format": "binary", "nullable": true }, "FileContent": { "type": "string", "format": "binary" } } }, "encoding": { "TemplateId": { "style": "form" }, "Tags": { "style": "form" }, "Icon": { "style": "form" }, "FileContent": { "style": "form" } } } } }, "responses": { "200": { "description": "File has been uploaded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportVM" } } } }, "400": { "description": "fileVM view model is not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "folder/subscription is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rp/v1/Reports/File/TaskMessage/{taskMessageId}": { "get": { "tags": [ "Reports" ], "summary": "Get report by specified task message id", "operationId": "Reports_GetByTaskMessageId", "parameters": [ { "name": "taskMessageId", "in": "path", "description": "task message id", "required": true, "schema": { "pattern": "^([0-9a-f]{8}([-][0-9a-f]{4}){3}[-][0-9a-f]{12})$", "type": "string" } } ], "responses": { "200": { "description": "Report is found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportVM" } } } }, "400": { "description": "id is not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Report or subscription is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/api/rp/v1/Reports/File/Task/{taskId}": { "get": { "tags": [ "Reports" ], "summary": "Get reports by specified task id", "operationId": "Reports_GetByTaskId", "parameters": [ { "name": "taskId", "in": "path", "description": "task id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "Reports are found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportsVM" } } } }, "400": { "description": "id is not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Report or subscription is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/api/rp/v1/Reports/File/{id}/Copy/{folderId}": { "post": { "tags": [ "Reports" ], "summary": "Copy file to a specified folder", "operationId": "Reports_CopyFile", "parameters": [ { "name": "id", "in": "path", "description": "file id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } }, { "name": "folderId", "in": "path", "description": "folder id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "File has been copied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportVM" } } } }, "400": { "description": "FileId or folderId is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "File, subscription or folder not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Exception thrown" } } } }, "/api/rp/v1/Reports/File/{id}/sharingKey": { "post": { "tags": [ "Reports" ], "summary": "Create a new key, that can be used to share access to a file\r\n(You need Administrate.Anon permission to create a new key)", "operationId": "Reports_CreateSharingKey", "parameters": [ { "name": "id", "in": "path", "description": "file id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "description": "parameters for sharing key creation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateFileShareVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateFileShareVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateFileShareVM" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileSharingKeysVM" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" } } }, "delete": { "tags": [ "Reports" ], "summary": "Deletes a sharing key, making links, that utilizing it no longer work", "operationId": "Reports_DeleteSharingKey", "parameters": [ { "name": "id", "in": "path", "description": "file id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } }, { "name": "key", "in": "path", "description": "key to delete", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" } } } }, "/api/rp/v1/Reports/File/{id}/sharingKeys": { "get": { "tags": [ "Reports" ], "summary": "Returns all sharing keys, associated with the file", "operationId": "Reports_GetSharingKeys", "parameters": [ { "name": "id", "in": "path", "description": "file id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileSharingKeysVM" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" } } } }, "/api/rp/v1/Reports/File/{id}": { "delete": { "tags": [ "Reports" ], "summary": "Delete specified file", "description": "User with Delete permission can access the method.", "operationId": "Reports_DeleteFile", "parameters": [ { "name": "id", "in": "path", "description": "file id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "204": { "description": "File succesfully deleted" }, "400": { "description": "Id is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "File or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Exception thrown" } } }, "get": { "tags": [ "Reports" ], "summary": "Get specified file", "description": "User with Get Entity permission can access this method.", "operationId": "Reports_GetFile", "parameters": [ { "name": "id", "in": "path", "description": "file id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "Returns the specified file", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportVM" } } } }, "400": { "description": "Id is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "File or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Exception thrown" } } } }, "/api/rp/v1/Reports/File/{id}/ToBin": { "delete": { "tags": [ "Reports" ], "summary": "Move specified file to recycle bin", "description": "User with Delete permission can access the method.", "operationId": "Reports_MoveFileToBin", "parameters": [ { "name": "id", "in": "path", "description": "file id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "204": { "description": "File succesfully deleted" }, "400": { "description": "Id is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "File or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Exception thrown" } } } }, "/api/rp/v1/Reports/File/{id}/Recover": { "post": { "tags": [ "Reports" ], "summary": "Recover specified file from bin", "description": "User with Delete permission can access the method.", "operationId": "Reports_RecoverFile", "parameters": [ { "name": "id", "in": "path", "description": "file id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } }, { "name": "recoveryPath", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "204": { "description": "File succesfully recovered" }, "400": { "description": "Id is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "File or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Exception thrown" } } } }, "/api/rp/v1/Reports/File/{id}/History": { "get": { "tags": [ "Reports" ], "summary": "Returns list of actions, performed on this file", "operationId": "Reports_GetFileHistory", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } }, { "name": "skip", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "take", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "default": 10 } } ], "responses": { "200": { "description": "Returns the actions", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuditActionsVM" } } } }, "400": { "description": "Id is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "File or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rp/v1/Reports/Folder/{id}/CountFiles": { "get": { "tags": [ "Reports" ], "summary": "Get count of files what contains in a specified folder", "description": "User with Get Count permission can access this method.", "operationId": "Reports_GetFilesCount", "parameters": [ { "name": "id", "in": "path", "description": "folder id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "Returns count of the files in a specified folder", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountVM" } } } }, "400": { "description": "FolderId is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Folder or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Exception thrown" } } } }, "/api/rp/v1/Reports/Folder/{id}/ListFiles": { "get": { "tags": [ "Reports" ], "summary": "Get all files from specified folder.
\r\nUser with Get Entity permission can access this method.
\r\nThe method will returns minimal infomration about the file:
\r\nid, name, size, editedTime, createdTime, tags, status, statusReason.", "operationId": "Reports_GetFilesList", "parameters": [ { "name": "id", "in": "path", "description": "folder id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } }, { "name": "skip", "in": "query", "description": "number of files, that have to be skipped", "schema": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32", "default": 0 } }, { "name": "take", "in": "query", "description": "number of files, that have to be returned", "schema": { "maximum": 120, "minimum": 1, "type": "integer", "format": "int32", "default": 10 } }, { "name": "searchPattern", "in": "query", "description": "", "schema": { "maxLength": 100, "minLength": 0, "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "$ref": "#/components/schemas/FileSorting" } }, { "name": "desc", "in": "query", "description": "", "schema": { "type": "boolean", "default": false } }, { "name": "useRegex", "in": "query", "description": "", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Returns list of the files from a specified folder", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportsVM" } } } }, "400": { "description": "Invalid params", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "File, subscription or folder not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Exception thrown" } } } }, "/api/rp/v1/Reports/File/{id}/permissions": { "get": { "tags": [ "Reports" ], "operationId": "Reports_GetPermissions", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilePermissionsVM" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "post": { "tags": [ "Reports" ], "summary": "Update permissions", "operationId": "Reports_UpdatePermissions", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateFilePermissionsVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateFilePermissionsVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateFilePermissionsVM" } } } }, "responses": { "204": { "description": "File's permissions has been updated" }, "400": { "description": "FileId or VM is not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "File or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Exception thrown" } } } }, "/api/rp/v1/Reports/File/{id}/mypermissions": { "get": { "tags": [ "Reports" ], "summary": "Get current user's permissions to file", "operationId": "Reports_GetMyPermissions", "parameters": [ { "name": "id", "in": "path", "description": "file id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "got permissions successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilePermissionCRUDVM" } } } }, "400": { "description": "Invalid params", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "File, subscription or folder not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" } } } }, "/api/rp/v1/Reports/File/{id}/Move/{folderId}": { "post": { "tags": [ "Reports" ], "summary": "Move file to a specified folder", "description": "User with a Update Place permission for a folder and Create Entity\r\nfor a Parent Folder can access this method.", "operationId": "Reports_MoveFile", "parameters": [ { "name": "id", "in": "path", "description": "file id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } }, { "name": "folderId", "in": "path", "description": "folder id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "File has been moved", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportVM" } } } }, "400": { "description": "fileId or folderId is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "File, subscription or folder not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Exception thrown" } } } }, "/api/rp/v1/Reports/File/{id}/Rename": { "put": { "tags": [ "Reports" ], "summary": "Rename a file", "description": "User with Update Name permission can access this method.", "operationId": "Reports_RenameFile", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileRenameVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FileRenameVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FileRenameVM" } } } }, "responses": { "200": { "description": "File name has been updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportVM" } } } }, "400": { "description": "FileId is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "File or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Exception thrown" } } } }, "/api/rp/v1/Reports/File/{id}/Icon": { "put": { "tags": [ "Reports" ], "summary": "Update a files's icon", "description": "User with Update Icon permission can access this method.", "operationId": "Reports_UpdateIcon", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileIconVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FileIconVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FileIconVM" } } } }, "responses": { "200": { "description": "File's icon has been updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportVM" } } } }, "400": { "description": "FileId is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "File or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Exception thrown" } } } }, "/api/rp/v1/Reports/File/{id}/UpdateTags": { "put": { "tags": [ "Reports" ], "summary": "Update tags", "description": "User with Update Tags permission can access this method.", "operationId": "Reports_UpdateTags", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileTagsUpdateVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FileTagsUpdateVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FileTagsUpdateVM" } } } }, "responses": { "200": { "description": "Tags has been updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportVM" } } } }, "400": { "description": "FileId is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "File or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Exception thrown" } } } }, "/api/rp/v1/Reports/Folder/{id}/File": { "post": { "tags": [ "Reports" ], "summary": "Upload a file to the specified folder. The method is deprecated, use the UploadFileV2 method instead!", "description": "User with Create Entity permission can access this method.", "operationId": "Reports_UploadFile", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of folder", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "description": "file's view model", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportCreateVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReportCreateVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReportCreateVM" } } } }, "responses": { "200": { "description": "File has been uploaded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportVM" } } } }, "400": { "description": "fileVM view model is not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "folder/subscription is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "deprecated": true } }, "/api/manage/v1/Subscriptions/{subscriptionId}/groups": { "get": { "tags": [ "SubscriptionGroups" ], "summary": "returns groups of the subscription or subscription user", "operationId": "SubscriptionGroups_GetGroupsList", "parameters": [ { "name": "subscriptionId", "in": "path", "description": "subscripiton id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } }, { "name": "userId", "in": "query", "description": "user Id (optional)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Everything is all right (list of groups may be empty)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupsVM" } } } }, "400": { "description": "id is not hex24", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is blocked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have permisison to get groups from this subscription (or in your default (1st) subscription)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "there is no subscription with provided id found, or user don't even have a subscription", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/manage/v1/Subscriptions/{subscriptionId}/count": { "get": { "tags": [ "SubscriptionGroups" ], "summary": "Returns a number of groups in subscription", "operationId": "SubscriptionGroups_CountGroupsAsync", "parameters": [ { "name": "subscriptionId", "in": "path", "description": "subscripiton id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "Everything is all right", "content": { "application/json": { "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "id is not hex24", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is blocked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have permisison to get groups from this subscription (or in your default (1st) subscription)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "there is no subscription with provided id found, or user don't even have a subscription", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/manage/v1/Subscriptions/{subscriptionId}/invites": { "get": { "tags": [ "SubscriptionInvites" ], "summary": "Get list of invites in a subscription,\r\nthe added users will be displayed in the list of users of the subscription,\r\nand these users will also have an active subscription.", "operationId": "SubscriptionInvites_GetInvites", "parameters": [ { "name": "subscriptionId", "in": "path", "description": "Idenitifier of subscription", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "Succesfully added", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionInvitesVM" } } } }, "400": { "description": "The request is wrong", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Subscription or user is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Exception thrown" } } } }, "/api/manage/v1/Subscriptions/{subscriptionId}/invite": { "post": { "tags": [ "SubscriptionInvites" ], "summary": "Create invite to subscription", "operationId": "SubscriptionInvites_CreateInvite", "parameters": [ { "name": "subscriptionId", "in": "path", "description": "id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "description": "create VM", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSubscriptionInviteVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateSubscriptionInviteVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateSubscriptionInviteVM" } } } }, "responses": { "200": { "description": "Successfully created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionInviteVM" } } } }, "400": { "description": "Request is wrong", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Not enough permissions", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "there is no subscription with such id", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "exception caught" } } } }, "/api/manage/v1/Subscriptions/{subscriptionId}/invite/{accesstoken}": { "delete": { "tags": [ "SubscriptionInvites" ], "summary": "Delete invite with specified token", "operationId": "SubscriptionInvites_DeleteInvite", "parameters": [ { "name": "subscriptionId", "in": "path", "description": "id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } }, { "name": "accesstoken", "in": "path", "description": "invite's token", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Successfully deleted" }, "400": { "description": "Request is wrong", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Not enough permissions", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "there is no subscription with such id", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "exception caught" } } } }, "/api/manage/v1/Subscriptions/{subscriptionId}/invite/{accessToken}/accept": { "get": { "tags": [ "SubscriptionInvites" ], "summary": "Add a user to the subscription using invite,\r\nthe added users will be displayed in the list of users of the subscription,\r\nand these users will also have an active subscription.", "operationId": "SubscriptionInvites_AcceptInvite", "parameters": [ { "name": "subscriptionId", "in": "path", "description": "Idenitifier of subscription", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } }, { "name": "accessToken", "in": "path", "description": "access token of the subscription", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "User already in subscription" }, "204": { "description": "Succesfully added" }, "400": { "description": "The request is wrong", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Subscription or user is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Exception thrown" } } } }, "/api/manage/v1/SubscriptionPlans/{id}": { "get": { "tags": [ "SubscriptionPlans" ], "summary": "Returns a subscription plan. Not all subscriptions can be issued for customer.", "operationId": "SubscriptionPlans_GetSubscriptionPlan", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of subsctiption plan", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "Succesfully returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionPlanVM" } } } }, "400": { "description": "The request is wrong", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Subscription plan with this id is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Exception thrown" } } } }, "/api/manage/v1/SubscriptionPlans": { "get": { "tags": [ "SubscriptionPlans" ], "summary": "Returns a list of active subscription plans that can be issued to the user.", "description": "If no active subscription plans, then the endpoint will return empty list", "operationId": "SubscriptionPlans_GetSubscriptionPlans", "parameters": [ { "name": "skip", "in": "query", "description": "Variable for pagination, defautl value is 0", "schema": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32", "default": 0 } }, { "name": "take", "in": "query", "description": "Variable for pagination, default value is 10", "schema": { "maximum": 120, "minimum": 1, "type": "integer", "format": "int32", "default": 10 } } ], "responses": { "200": { "description": "Succesfully returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionPlansVM" } } } }, "400": { "description": "The request is wrong", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/manage/v1/Subscriptions/{id}": { "get": { "tags": [ "Subscriptions" ], "summary": "Returns the subscription by id", "operationId": "Subscriptions_GetSubscription", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of subscription", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "Succesfully returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionVM" } } } }, "400": { "description": "The request is wrong", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Subscription is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/api/manage/v1/Subscriptions": { "get": { "tags": [ "Subscriptions" ], "summary": "Returns a list of all subscriptions of current user", "operationId": "Subscriptions_GetSubscriptions", "parameters": [ { "name": "skip", "in": "query", "description": "Variable for pagination, defautl value is 0", "schema": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32", "default": 0 } }, { "name": "take", "in": "query", "description": "Variable for pagination, default value is 10", "schema": { "maximum": 120, "minimum": 1, "type": "integer", "format": "int32", "default": 10 } } ], "responses": { "200": { "description": "Succesfully returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionsVM" } } } }, "400": { "description": "unrealistic skip 'n take provided", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/manage/v1/Subscriptions/{subscriptionId}/rename": { "put": { "tags": [ "Subscriptions" ], "summary": "Rename subscription", "operationId": "Subscriptions_RenameSubscription", "parameters": [ { "name": "subscriptionId", "in": "path", "description": "id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "description": "rename VM", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RenameSubscriptionVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RenameSubscriptionVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RenameSubscriptionVM" } } }, "required": true }, "responses": { "200": { "description": "Successfully renamed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionVM" } } } }, "400": { "description": "Request is wrong", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Not enough permissions", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "There is no subscription with such id (or user have no permission)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/manage/v1/Subscriptions/{subscriptionId}/Locale": { "put": { "tags": [ "Subscriptions" ], "summary": "Update subscription's default locale", "operationId": "Subscriptions_UpdateLocale", "parameters": [ { "name": "subscriptionId", "in": "path", "description": "id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "description": "update VM", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSubscriptionLocaleVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateSubscriptionLocaleVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateSubscriptionLocaleVM" } } }, "required": true }, "responses": { "200": { "description": "Successfully renamed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionVM" } } } }, "400": { "description": "Request is wrong", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Not enough permissions", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "There is no subscription with such id (or user have no permission)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/manage/v1/Subscriptions/{subscriptionId}/defaultPermissions": { "put": { "tags": [ "Subscriptions" ], "summary": "Change subscription's default permissions for new entities", "operationId": "Subscriptions_UpdateDefaultPermissions", "parameters": [ { "name": "subscriptionId", "in": "path", "description": "id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "description": "update default permissions VM", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDefaultPermissionsVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateDefaultPermissionsVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateDefaultPermissionsVM" } } }, "required": true }, "responses": { "200": { "description": "Successfully changed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DefaultPermissionsVM" } } } }, "400": { "description": "Request is wrong", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Not enough permissions", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "There is no subscription with such id", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "get": { "tags": [ "Subscriptions" ], "summary": "Get subscription's default permissions for new entities", "operationId": "Subscriptions_GetDefaultPermissions", "parameters": [ { "name": "subscriptionId", "in": "path", "description": "id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "Successfully returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DefaultPermissionsVM" } } } }, "400": { "description": "Request is wrong", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Not enough permissions", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "There is no subscription with such id", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/manage/v1/Subscriptions/{id}/permissions": { "get": { "tags": [ "Subscriptions" ], "summary": "Get permissions for a subscription by id", "operationId": "Subscriptions_GetPermissions", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "Succesfully returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionPermissionsVM" } } } }, "400": { "description": "Request is wrong", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Not enough permissions", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "There is no subscription with such id", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } }, "post": { "tags": [ "Subscriptions" ], "summary": "Update permissions", "operationId": "Subscriptions_UpdatePermissions", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSubscriptionPermissionsVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateSubscriptionPermissionsVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateSubscriptionPermissionsVM" } } } }, "responses": { "204": { "description": "Succesfully updated" }, "400": { "description": "Request is wrong", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Not enough permissions", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "There is no subscription with such id", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/api/manage/v1/Subscriptions/{subId}/mypermissions": { "get": { "tags": [ "Subscriptions" ], "summary": "Get user's permissions for a subscription by id", "operationId": "Subscriptions_GetMyPermissions", "parameters": [ { "name": "subId", "in": "path", "description": "subscription id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "Succesfully returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MyPermissionsVM" } } } } } } }, "/api/manage/v1/Subscriptions/{subscriptionId}/users/{userId}": { "put": { "tags": [ "SubscriptionUsers" ], "summary": "Add a user to the subscription,\r\nthe added users will be displayed in the list of users of the subscription,\r\nand these users will also have an active subscription.", "operationId": "SubscriptionUsers_AddUser", "parameters": [ { "name": "subscriptionId", "in": "path", "description": "Idenitifier of subscription", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } }, { "name": "userId", "in": "path", "description": "Idenitifier of user", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Succesfully added" }, "400": { "description": "The request is wrong", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Subscription or user is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Exception thrown" } } }, "delete": { "tags": [ "SubscriptionUsers" ], "summary": "Delete a user from the subscription,\r\nthe added users will be displayed in the list of users of the subscription,\r\nand these users will also have an active subscription.", "operationId": "SubscriptionUsers_RemoveUser", "parameters": [ { "name": "subscriptionId", "in": "path", "description": "Idenitifier of subscription", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } }, { "name": "userId", "in": "path", "description": "Idenitifier of user", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Succesfully deleted" }, "400": { "description": "The request is wrong", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription id outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Subscription or user is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Exception thrown" } } } }, "/api/manage/v1/Subscriptions/{subscriptionId}/leave": { "delete": { "tags": [ "SubscriptionUsers" ], "summary": "Allows user to leave subscription,.", "operationId": "SubscriptionUsers_LeaveSubscripiton", "parameters": [ { "name": "subscriptionId", "in": "path", "description": "Idenitifier of subscription", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "204": { "description": "Succesfully deleted" }, "400": { "description": "The request is wrong", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "User is unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription id outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Subscription or user is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Exception thrown" } } } }, "/api/manage/v1/Subscriptions/{subscriptionId}/users": { "get": { "tags": [ "SubscriptionUsers" ], "summary": "Returns all users of subscription", "operationId": "SubscriptionUsers_GetUsers", "parameters": [ { "name": "subscriptionId", "in": "path", "description": "Idenitifier of subscription", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } }, { "name": "skip", "in": "query", "description": "How many entities skip", "schema": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32", "default": 0 } }, { "name": "take", "in": "query", "description": "How many entities take", "schema": { "maximum": 120, "minimum": 1, "type": "integer", "format": "int32", "default": 10 } } ], "responses": { "200": { "description": "Succesfully returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionUsersVM" } } } }, "400": { "description": "The request is wrong", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Subscription is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Exception thrown" } } } }, "/api/manage/v1/Subscriptions/{subscriptionId}/UsersCount": { "get": { "tags": [ "SubscriptionUsers" ], "summary": "Returns a number of users in subscription", "operationId": "SubscriptionUsers_CountUsersAsync", "parameters": [ { "name": "subscriptionId", "in": "path", "description": "", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "Succesfully returned", "content": { "application/json": { "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "The request is wrong", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Subscription is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Exception thrown" } } } }, "/api/tasks/v1/Tasks": { "post": { "tags": [ "Tasks" ], "summary": "Create a new task", "operationId": "Tasks_CreateTask", "requestBody": { "description": "task's view model. You have to specify task type by placing parameter \"$t\": \"Vm name\",\r\n this parameters always must be on the first place", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTaskBaseVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateTaskBaseVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateTaskBaseVM" } } } }, "responses": { "200": { "description": "Task was created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskBaseVM" } } } }, "400": { "description": "Bad VM provided", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Not enough permissions for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Subscription was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } }, "get": { "tags": [ "Tasks" ], "summary": "Get tasks list", "operationId": "Tasks_GetList", "parameters": [ { "name": "skip", "in": "query", "description": "number of tasks, that have to be skipped", "schema": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32", "default": 0 } }, { "name": "take", "in": "query", "description": "number of tasks, that have to be returned", "schema": { "maximum": 120, "minimum": 1, "type": "integer", "format": "int32", "default": 10 } }, { "name": "subscriptionId", "in": "query", "description": "subscription id", "schema": { "pattern": "(^$)|(^[A-Fa-f0-9]{24}$)", "type": "string" } }, { "name": "searchPattern", "in": "query", "description": "", "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "Tasks were found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TasksVM" } } } }, "400": { "description": "Bad id provided", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Not enough permissions for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Subscription or tasks were not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/api/tasks/v1/Tasks/{taskId}": { "delete": { "tags": [ "Tasks" ], "summary": "Delete a task from a storage", "operationId": "Tasks_DeleteTask", "parameters": [ { "name": "taskId", "in": "path", "description": "deleting task id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "204": { "description": "Task was deleted" }, "400": { "description": "Bad id provided", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Not enough permissions for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Subscription or task was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } }, "get": { "tags": [ "Tasks" ], "summary": "Get a task by a specified id", "operationId": "Tasks_Get", "parameters": [ { "name": "taskId", "in": "path", "description": "a task id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "Task was found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskBaseVM" } } } }, "400": { "description": "Bad id provided", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Not enough permissions for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Subscription or task was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } }, "put": { "tags": [ "Tasks" ], "summary": "Update a task", "operationId": "Tasks_UpdateTask", "parameters": [ { "name": "taskId", "in": "path", "description": "updating task id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "description": "task's view model. You have to specify task type by placing parameter \"$t\": \"Vm name\",\r\n this parameters always must be on first place", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTaskBaseVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateTaskBaseVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateTaskBaseVM" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskBaseVM" } } } }, "400": { "description": "Bad id or VM provided", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Not enough permissions for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Subscription or task was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" }, "204": { "description": "Task was updated" } } } }, "/api/tasks/v1/Tasks/{id}/permissions": { "get": { "tags": [ "Tasks" ], "summary": "Get all Task permissions", "operationId": "Tasks_GetPermissions", "parameters": [ { "name": "id", "in": "path", "description": "task id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "Task was found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskPermissionsVM" } } } }, "400": { "description": "Bad id provided", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Not enough permissions for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Subscription or task was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } }, "post": { "tags": [ "Tasks" ], "summary": "Update permissions", "operationId": "Tasks_UpdatePermissions", "parameters": [ { "name": "id", "in": "path", "description": "task id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "description": "new permissions. You have to specify VM type by placing parameter \"$t\": \"Vm name\",\r\n this parameters always must be on first place", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTaskPermissionsVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateTaskPermissionsVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateTaskPermissionsVM" } } } }, "responses": { "204": { "description": "Task was updated" }, "400": { "description": "Bad id or VM provided", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Not enough permissions for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Subscription or task was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/api/tasks/v1/Tasks/{id}/mypermissions": { "get": { "tags": [ "Tasks" ], "summary": "Get current user's permissions to Task", "operationId": "Tasks_GetMyPermissions", "parameters": [ { "name": "id", "in": "path", "description": "task id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "got permissions successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskPermissionCRUDVM" } } } }, "400": { "description": "The request is wrong", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Subscription or task was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" } } } }, "/api/tasks/v1/Tasks/{taskId}/rename": { "put": { "tags": [ "Tasks" ], "summary": "Rename a task", "operationId": "Tasks_RenameTask", "parameters": [ { "name": "taskId", "in": "path", "description": "renaming task id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } }, { "name": "newName", "in": "query", "description": "task's new Name", "schema": { "maxLength": 50, "minLength": 1, "type": "string" } } ], "responses": { "200": { "description": "Task was found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskBaseVM" } } } }, "400": { "description": "Bad id or name provided", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Not enough permissions for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Subscription or task was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/api/tasks/v1/Tasks/run": { "post": { "tags": [ "Tasks" ], "summary": "Run a task from request body", "operationId": "Tasks_RunTask", "requestBody": { "description": "task's view model. You have to specify task type by placing parameter \"$t\": \"Vm name\",\r\n this parameters always must be on the first place", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunTaskBaseVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RunTaskBaseVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RunTaskBaseVM" } } } }, "responses": { "200": { "description": "Task was executed" }, "403": { "description": "Not enough permissions for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Subscription was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "400": { "description": "Bad VM provided", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/api/tasks/v1/Tasks/{taskId}/run": { "post": { "tags": [ "Tasks" ], "summary": "Run a task by id", "operationId": "Tasks_RunTaskById", "parameters": [ { "name": "taskId", "in": "path", "description": "task id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "Task was executed" }, "400": { "description": "Bad id provided", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Not enough permissions for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Subscription or task was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/api/rp/v1/Templates/Folder/{id}/CountFolderAndFiles": { "get": { "tags": [ "Templates" ], "summary": "Get count of files and folders what contains in a specified folder", "description": "User with a Get Count permission can access this method.", "operationId": "TemplateFolderAndFile_GetCount", "parameters": [ { "name": "id", "in": "path", "description": "folder id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } }, { "name": "searchPattern", "in": "query", "description": "string, that must be incuded in file or folder name to be counted
\r\n (leave undefined to count all files and folders)", "schema": { "maxLength": 100, "minLength": 0, "type": "string" } }, { "name": "useRegex", "in": "query", "description": "set this to true if you want to use regular expression to search", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Returns count of the files in a specified folder", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountVM" } } } }, "400": { "description": "Params are not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Payment required, subscription is blocked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Folder or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/api/rp/v1/Templates/Folder/{id}/ListFolderAndFiles": { "get": { "tags": [ "Templates" ], "summary": "Get all folders and files from specified folder", "description": "User with a Get Entity permission can access this method.", "operationId": "TemplateFolderAndFile_GetFoldersAndFiles", "parameters": [ { "name": "id", "in": "path", "description": "folder id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } }, { "name": "skip", "in": "query", "description": "number of folder and files, that have to be skipped", "schema": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32", "default": 0 } }, { "name": "take", "in": "query", "description": "number of folder and files, that have to be returned", "schema": { "maximum": 120, "minimum": 1, "type": "integer", "format": "int32", "default": 10 } }, { "name": "orderBy", "in": "query", "description": "indicates a field to sort by", "schema": { "$ref": "#/components/schemas/FileSorting" } }, { "name": "desc", "in": "query", "description": "indicates if sorting is descending", "schema": { "type": "boolean", "default": false } }, { "name": "searchPattern", "in": "query", "description": "", "schema": { "maxLength": 100, "minLength": 0, "type": "string", "default": "" } }, { "name": "useRegex", "in": "query", "description": "", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Returns list of the files from a specified folder", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilesVM" } } } }, "400": { "description": "Params are not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Payment required, subscription is blocked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Subscription or folder not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rp/v1/Templates/{subscriptionId}/ListRecycleBinFolderAndFiles": { "get": { "tags": [ "Templates" ], "summary": "Get all folders and files from recycle bin", "description": "User with a Get DeletedFiles permission can access this method.", "operationId": "TemplateFolderAndFile_GetRecycleBinFoldersAndFiles", "parameters": [ { "name": "subscriptionId", "in": "path", "description": "subscription id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } }, { "name": "skip", "in": "query", "description": "number of folder and files, that have to be skipped", "schema": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32", "default": 0 } }, { "name": "take", "in": "query", "description": "number of folder and files, that have to be returned", "schema": { "maximum": 120, "minimum": 1, "type": "integer", "format": "int32", "default": 10 } }, { "name": "orderBy", "in": "query", "description": "indicates a field to sort by", "schema": { "$ref": "#/components/schemas/FileSorting" } }, { "name": "desc", "in": "query", "description": "indicates if sorting is descending", "schema": { "type": "boolean", "default": false } }, { "name": "searchPattern", "in": "query", "description": "", "schema": { "maxLength": 100, "minLength": 0, "type": "string", "default": "" } }, { "name": "useRegex", "in": "query", "description": "", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Returns list of the files from a specified folder", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilesVM" } } } }, "400": { "description": "Params are not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Payment required, subscription is blocked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rp/v1/Templates/{subscriptionId}/CountRecycleBinFolderAndFiles": { "get": { "tags": [ "Templates" ], "summary": "Count all folders and files from recycle bin", "description": "User with a Get DeletedFiles permission can access this method.", "operationId": "TemplateFolderAndFile_CountRecycleBinFoldersAndFiles", "parameters": [ { "name": "subscriptionId", "in": "path", "description": "subscription id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } }, { "name": "searchPattern", "in": "query", "description": "", "schema": { "maxLength": 100, "minLength": 0, "type": "string", "default": "" } }, { "name": "useRegex", "in": "query", "description": "", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Returns list of the files from a specified folder", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountVM" } } } }, "400": { "description": "Params are not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Payment required, subscription is blocked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rp/v1/Templates/{subscriptionId}/ClearRecycleBin": { "delete": { "tags": [ "Templates" ], "summary": "Delete all folders and files from recycle bin", "description": "User with a Delete RecycleBin permission can access this method.", "operationId": "TemplateFolderAndFile_ClearRecycleBin", "parameters": [ { "name": "subscriptionId", "in": "path", "description": "subscription id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "204": { "description": "All folders and files in bin have been deleted" }, "400": { "description": "Subscription id is not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Payment required, subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rp/v1/Templates/{subscriptionId}/RecoverRecycleBin": { "post": { "tags": [ "Templates" ], "summary": "Recover all folders and files from recycle bin", "description": "User with a Create RecycleBin permission can access this method.", "operationId": "TemplateFolderAndFile_RecoverAllFromRecycleBin", "parameters": [ { "name": "subscriptionId", "in": "path", "description": "subscription id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "204": { "description": "All folders and files in bin have been restored" }, "400": { "description": "Subscription id is not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Payment required, subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rp/v1/Templates/{subscriptionId}/DeleteFiles": { "post": { "tags": [ "Templates" ], "summary": "Delete folders and files", "description": "User with a Delete permission can access this method.", "operationId": "TemplateFolderAndFile_DeleteFiles", "parameters": [ { "name": "subscriptionId", "in": "path", "description": "id of current subscription", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "description": "VM with files' ids and params of their destination", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectedFilesVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SelectedFilesVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SelectedFilesVM" } } } }, "responses": { "204": { "description": "All folders and files have been deleted" }, "400": { "description": "Subscription id or VM is not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Payment required, subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rp/v1/Templates/{subscriptionId}/RecoverFiles": { "post": { "tags": [ "Templates" ], "summary": "Recover folders and files from bin", "description": "User with a SubscriptionCreate permission can access this method.", "operationId": "TemplateFolderAndFile_RecoverFiles", "parameters": [ { "name": "subscriptionId", "in": "path", "description": "id of current subscription", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "description": "VM with files' ids and params of their destination", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectedFilesVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SelectedFilesVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SelectedFilesVM" } } } }, "responses": { "204": { "description": "All folders and files have been recovered" }, "400": { "description": "Subscription id or VM is not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Payment required, subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rp/v1/Templates/{subscriptionId}/ToBin": { "post": { "tags": [ "Templates" ], "summary": "Move folders and files to bin", "description": "User with a Delete permission can access this method.", "operationId": "TemplateFolderAndFile_MoveFilesToBin", "parameters": [ { "name": "subscriptionId", "in": "path", "description": "id of current subscription", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "description": "VM with files' ids and params of their destination", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectedFilesVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SelectedFilesVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SelectedFilesVM" } } } }, "responses": { "204": { "description": "All folders and files have been moved to bin" }, "400": { "description": "Subscription id or VM is not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Payment required, subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rp/v1/Templates/{subscriptionId}/CopyFiles": { "post": { "tags": [ "Templates" ], "summary": "Copy folders and files to a specified folder", "description": "User with a Get permission for a files and Create permission for a destination folder can access this method.", "operationId": "TemplateFolderAndFile_CopyFiles", "parameters": [ { "name": "subscriptionId", "in": "path", "description": "id of current subscription", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "description": "VM with files' ids and params of their destination", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectedFilesVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SelectedFilesVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SelectedFilesVM" } } } }, "responses": { "204": { "description": "All folders and files have been copied" }, "400": { "description": "FolderId is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Payment required, subscription is blocked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "File or folder not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" } } } }, "/api/rp/v1/Templates/{subscriptionId}/MoveFiles": { "post": { "tags": [ "Templates" ], "summary": "Move folders and files to a specified folder", "description": "User with a Update Place permission for a files and Create permission for a destination folder can access this method.", "operationId": "TemplateFolderAndFile_MoveFiles", "parameters": [ { "name": "subscriptionId", "in": "path", "description": "id of current subscription", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "description": "VM with files' ids and params of their destination", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectedFilesVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SelectedFilesVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SelectedFilesVM" } } } }, "responses": { "204": { "description": "All folders and files have been moved" }, "400": { "description": "FolderId is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Payment required, subscription is blocked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "File or folder not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" } } } }, "/api/rp/v1/Templates/Folder/{id}/Export": { "post": { "tags": [ "Templates" ], "summary": "Export specified template folder to a specified format", "description": "User with Execute Export permission on template folder and\r\nCreate Entity on an export folder can access this method.", "operationId": "TemplateFolders_Export", "parameters": [ { "name": "id", "in": "path", "description": "template folder id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "description": "export parameters (string only)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportTemplateVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExportTemplateVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ExportTemplateVM" } } } }, "responses": { "200": { "description": "Specified template folder has been exported", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileVM" } } } }, "400": { "description": "Template folder Id is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Exports folder not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rp/v1/Templates/Folder/{id}/Prepare": { "post": { "tags": [ "Templates" ], "summary": "Prepare specified template folder to report folder", "description": "User with Execute Prepare permission on report and\r\nCreate Entity on a prepared report folder can access this method.", "operationId": "TemplateFolders_Prepare", "parameters": [ { "name": "id", "in": "path", "description": "template id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "description": "Template folder prepare view model", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrepareTemplateVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PrepareTemplateVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PrepareTemplateVM" } } } }, "responses": { "200": { "description": "Specified template folder has been prepared", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileVM" } } } }, "400": { "description": "Template folder Id is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Template or report folder not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rp/v1/Templates/Folder/{id}/permissions": { "get": { "tags": [ "Templates" ], "summary": "Get all folder permissions", "operationId": "TemplateFolders_GetPermissions", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "returned permissions", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilePermissionsVM" } } } }, "400": { "description": "id is not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is blocked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Folder or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rp/v1/Templates/Folder/{folderId}/mypermissions": { "get": { "tags": [ "Templates" ], "summary": "Get user's permissions for a folder by id", "operationId": "TemplateFolders_GetMyPermissions", "parameters": [ { "name": "folderId", "in": "path", "description": "folder id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "Succesfully returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilePermissionCRUDVM" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rp/v1/Templates/{id}/permissions": { "post": { "tags": [ "Templates" ], "summary": "Update permissions", "operationId": "TemplateFolders_UpdatePermissions", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateFilePermissionsVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateFilePermissionsVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateFilePermissionsVM" } } } }, "responses": { "204": { "description": "Folder's permissions has been updated" }, "400": { "description": "Id or VM is not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Folder or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/api/rp/v1/Templates/Folder/{id}": { "delete": { "tags": [ "Templates" ], "summary": "Delete specified folder", "description": "User with a Delete Entity permission can access this method.", "operationId": "TemplateFolders_DeleteFolder", "parameters": [ { "name": "id", "in": "path", "description": "folder id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "204": { "description": "Folder succesfully deleted" }, "400": { "description": "Id is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Folder or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } }, "get": { "tags": [ "Templates" ], "summary": "Get specified folder", "description": "User with a Get Entity permission can access this method.", "operationId": "TemplateFolders_GetFolder", "parameters": [ { "name": "id", "in": "path", "description": "folder id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "Returns specified folder", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileVM" } } } }, "400": { "description": "Id is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is blocked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Folder or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/api/rp/v1/Templates/Folder/{id}/ToBin": { "delete": { "tags": [ "Templates" ], "summary": "Move specified folder to recycle bin", "description": "User with a Delete Entity permission can access this method.", "operationId": "TemplateFolders_MoveFolderToBin", "parameters": [ { "name": "id", "in": "path", "description": "folder id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "204": { "description": "Folder succesfully deleted" }, "400": { "description": "Id is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Folder or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/api/rp/v1/Templates/Folder/{id}/Recover": { "post": { "tags": [ "Templates" ], "summary": "Recover specified folder", "description": "User with a Delete Entity permission can access this method.", "operationId": "TemplateFolders_RecoverFolder", "parameters": [ { "name": "id", "in": "path", "description": "folder id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } }, { "name": "recoveryPath", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "204": { "description": "Folder succesfully restored from bin" }, "400": { "description": "Id is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Folder or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/api/rp/v1/Templates/Folder/{id}/Breadcrumbs": { "get": { "tags": [ "Templates" ], "summary": "Get specified folder breadcrumbs", "description": "User with a Get Entity permission can access this method.", "operationId": "TemplateFolders_GetBreadcrumbs", "parameters": [ { "name": "id", "in": "path", "description": "folder id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "Returns breadcrumbs parents list (starts from root folder)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BreadcrumbsVM" } } } }, "400": { "description": "folderId is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is blocked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Folder or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/api/rp/v1/Templates/Folder/{id}/size": { "get": { "tags": [ "Templates" ], "summary": "Get specified folder, calculate it's size", "description": "User with a Get Entity permission can access this method.", "operationId": "TemplateFolders_CalculateFolderSize", "parameters": [ { "name": "id", "in": "path", "description": "folder id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "Returns specified folder", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FolderSizeVM" } } } }, "400": { "description": "Id is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is blocked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Folder or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/api/rp/v1/Templates/Folder/getOrCreate": { "get": { "tags": [ "Templates" ], "summary": "Get specified folder", "description": "User with a Get Entity permission can access this method.", "operationId": "TemplateFolders_GetOrCreate", "parameters": [ { "name": "name", "in": "query", "description": "folder name", "schema": { "maxLength": 50, "minLength": 0, "type": "string" } }, { "name": "subscriptionId", "in": "query", "description": "subscriptionId", "schema": { "pattern": "(^$)|(^[A-Fa-f0-9]{24}$)", "type": "string" } }, { "name": "parentId", "in": "query", "description": "parent folder id", "schema": { "pattern": "(^$)|(^[A-Fa-f0-9]{24}$)", "type": "string" } } ], "responses": { "200": { "description": "Returns specified folder", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileVM" } } } }, "400": { "description": "Name or 1 of ids is not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is blocked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/api/rp/v1/Templates/Folder/{id}/ListFolders": { "get": { "tags": [ "Templates" ], "summary": "Get all folders from specified folder", "description": "User with a Get Entity permission can access this method.", "operationId": "TemplateFolders_GetFolders", "parameters": [ { "name": "id", "in": "path", "description": "folder id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } }, { "name": "skip", "in": "query", "description": "number of files, that have to be skipped", "schema": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32", "default": 0 } }, { "name": "take", "in": "query", "description": "number of files, that have to be returned", "schema": { "maximum": 120, "minimum": 1, "type": "integer", "format": "int32", "default": 10 } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "$ref": "#/components/schemas/FileSorting" } }, { "name": "desc", "in": "query", "description": "", "schema": { "type": "boolean", "default": false } }, { "name": "searchPattern", "in": "query", "description": "", "schema": { "maxLength": 100, "minLength": 0, "type": "string", "default": "" } }, { "name": "useRegex", "in": "query", "description": "", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Gets all folders from a specified folder", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilesVM" } } } }, "400": { "description": "1 of params is not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is blocked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Folder or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/api/rp/v1/Templates/Folder/{id}/CountFolders": { "get": { "tags": [ "Templates" ], "summary": "Get count of folders what contains in a specified folder", "description": "User with a Get Count permission can access this method.", "operationId": "TemplateFolders_GetFoldersCount", "parameters": [ { "name": "id", "in": "path", "description": "folder id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "Returns count of folders in a specified folder", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountVM" } } } }, "400": { "description": "folderId is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is blocked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Folder or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/api/rp/v1/Templates/Root": { "get": { "tags": [ "Templates" ], "summary": "Get user's root folder (without parents)", "description": "> Breakchange. Now user model doesn't contain a root folders.\r\nThis method can return error 400 and 404 when subscription is not found.", "operationId": "TemplateFolders_GetRootFolder", "parameters": [ { "name": "subscriptionId", "in": "query", "schema": { "pattern": "(^$)|(^[A-Fa-f0-9]{24}$)", "type": "string" } } ], "responses": { "200": { "description": "Gets user's root folder (without parents)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileVM" } } } }, "402": { "description": "Subscription is blocked" }, "403": { "description": "No permissions to get root folder" }, "404": { "description": "Not found subscription" }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/api/rp/v1/Templates/Folder/{id}/Move/{folderId}": { "post": { "tags": [ "Templates" ], "summary": "Move folder to a specified folder", "description": "User with a Update Place permission for a folder and Create Entity\r\nfor a Parent Folder can access this method.", "operationId": "TemplateFolders_MoveFolder", "parameters": [ { "name": "id", "in": "path", "description": "moving folder id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } }, { "name": "folderId", "in": "path", "description": "destination folder id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "Folder has been moved to a specified folder", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileVM" } } } }, "400": { "description": "folderId or parentFolderId is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Folder or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/api/rp/v1/Templates/Folder/{id}/Copy/{folderId}": { "post": { "tags": [ "Templates" ], "summary": "Move folder to a specified folder", "description": "User with a Update Place permission for a folder and Create Entity\r\nfor a Parent Folder can access this method.", "operationId": "TemplateFolders_CopyFolder", "parameters": [ { "name": "id", "in": "path", "description": "moving folder id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } }, { "name": "folderId", "in": "path", "description": "destination folder id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "Folder has been moved to a specified folder", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileVM" } } } }, "400": { "description": "folderId or parentFolderId is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Folder or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/api/rp/v1/Templates/Folder/{id}/Folder": { "post": { "tags": [ "Templates" ], "summary": "Create folder", "description": "User with a Create Entity permisison can access this method.", "operationId": "TemplateFolders_PostFolder", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of parent folder id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "description": "create VM", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateFolderCreateVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TemplateFolderCreateVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TemplateFolderCreateVM" } } } }, "responses": { "200": { "description": "New folder has been created)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileVM" } } } }, "400": { "description": "Parent folder id or VM is not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "parent folder/subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rp/v1/Templates/Folder/{id}/Rename": { "put": { "tags": [ "Templates" ], "summary": "Rename a folder", "description": "User with a Update Name permision can access this method.", "operationId": "TemplateFolders_RenameFolder", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FolderRenameVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FolderRenameVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FolderRenameVM" } } } }, "responses": { "200": { "description": "Folder name has been updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileVM" } } } }, "400": { "description": "folderId or VM is not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Folder or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/api/rp/v1/Templates/Folder/{id}/Icon": { "put": { "tags": [ "Templates" ], "summary": "Update a folder's icon", "description": "User with a Update Icon permission can access this method.", "operationId": "TemplateFolders_UpdateIcon", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of folder", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "description": "Update icon model", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FolderIconVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FolderIconVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FolderIconVM" } } } }, "responses": { "200": { "description": "Folder's icon has been updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileVM" } } } }, "400": { "description": "folderId or VM is not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Folder or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/api/rp/v1/Templates/Folder/{id}/UpdateTags": { "put": { "tags": [ "Templates" ], "summary": "Update tags", "description": "User with a Update Tags permission can access this method.", "operationId": "TemplateFolders_UpdateTags", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FolderTagsUpdateVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FolderTagsUpdateVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FolderTagsUpdateVM" } } } }, "responses": { "200": { "description": "Tags has been updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileVM" } } } }, "400": { "description": "folderId or Tags is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Folder or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/api/rp/v1/Templates/File/{id}/Export": { "post": { "tags": [ "Templates" ], "summary": "Export specified report template to a specified format", "description": "User with Execute Export permission on prepared report and\r\nCreate Entity on an export folder can access this method.", "operationId": "Templates_Export", "parameters": [ { "name": "id", "in": "path", "description": "template id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "description": "export parameters (string only)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportTemplateVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExportTemplateVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ExportTemplateVM" } } } }, "responses": { "200": { "description": "Specified report has been exported", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportVM" } } } }, "204": { "description": "Specified report has been exported" }, "400": { "description": "Report Id is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Exports folder not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rp/v1/Templates/File/{id}/Prepare": { "post": { "tags": [ "Templates" ], "summary": "Prepare specified template to report", "description": "User with Execute Prepare permission on report and\r\nCreate Entity on a prepared report folder can access this method.", "operationId": "Templates_Prepare", "parameters": [ { "name": "id", "in": "path", "description": "template id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "description": "Template prepare view model", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrepareTemplateVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PrepareTemplateVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PrepareTemplateVM" } } } }, "responses": { "200": { "description": "Specified template has been prepared", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportVM" } } } }, "204": { "description": "Specified template has been prepared" }, "400": { "description": "Report Id is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Template or folder not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rp/v2/Templates/File/{id}/Content": { "put": { "tags": [ "Templates" ], "summary": "Updates contnet of the template.", "operationId": "Templates_UpdateContentV2", "parameters": [ { "name": "id", "in": "path", "description": "template id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "FileContent" ], "type": "object", "properties": { "FileContent": { "type": "string", "format": "binary" } } }, "encoding": { "FileContent": { "style": "form" } } } } }, "responses": { "204": { "description": "Template has been updated" }, "404": { "description": "Template or subscription are not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "400": { "description": "Id or VM is not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Try again, if error still here - text our support" } } } }, "/api/rp/v1/Templates/File/{id}/Content": { "put": { "tags": [ "Templates" ], "summary": "Updates contnet of the template. The method is deprecated, use the UpdateContentV2 method instead!", "operationId": "Templates_UpdateContent", "parameters": [ { "name": "id", "in": "path", "description": "template id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "description": "VM with only byte[] with new content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateFileContentVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateFileContentVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateFileContentVM" } } } }, "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" } }, "deprecated": true } }, "/api/rp/v1/Templates/File/{id}/StaticPreview": { "post": { "tags": [ "Templates" ], "summary": "Make preview for the report.\r\nGenerate a new or return exist prepared svg files.\r\nIf template was changed will be returned a new.\r\nPass the `` parameter to check prepared timestamp", "operationId": "Templates_StaticPreview", "parameters": [ { "name": "id", "in": "path", "description": "template id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "description": "Model with parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PreviewTemplateVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PreviewTemplateVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PreviewTemplateVM" } } } }, "responses": { "200": { "description": "Specified template has been prepared", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportVM" } } } }, "204": { "description": "Specified template has been prepared" }, "400": { "description": "Template Id is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Template or folder not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rp/v2/Templates/Folder/{id}/File": { "post": { "tags": [ "Templates" ], "summary": "Alternative api for upload a file to the specified folder!", "description": "User with Create Entity permission can access this method.", "operationId": "Templates_UploadFileV2", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of folder", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "FileContent" ], "type": "object", "properties": { "Tags": { "maxLength": 50, "minLength": 1, "maxItems": 3, "type": "array", "items": { "type": "string" }, "nullable": true }, "Icon": { "type": "string", "format": "binary", "nullable": true }, "FileContent": { "type": "string", "format": "binary" } } }, "encoding": { "Tags": { "style": "form" }, "Icon": { "style": "form" }, "FileContent": { "style": "form" } } } } }, "responses": { "200": { "description": "File has been uploaded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateVM" } } } }, "400": { "description": "fileVM view model is not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "folder/subscription is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rp/v1/Templates/File/{id}/parameters": { "put": { "tags": [ "Templates" ], "operationId": "Templates_UpdateParameters", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportParametersVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReportParametersVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReportParametersVM" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateVM" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" } } } }, "/api/rp/v1/Templates/File/{id}/Copy/{folderId}": { "post": { "tags": [ "Templates" ], "summary": "Copy file to a specified folder", "operationId": "Templates_CopyFile", "parameters": [ { "name": "id", "in": "path", "description": "file id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } }, { "name": "folderId", "in": "path", "description": "folder id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "File has been copied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateVM" } } } }, "400": { "description": "FileId or folderId is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "File, subscription or folder not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Exception thrown" } } } }, "/api/rp/v1/Templates/File/{id}/sharingKey": { "post": { "tags": [ "Templates" ], "summary": "Create a new key, that can be used to share access to a file\r\n(You need Administrate.Anon permission to create a new key)", "operationId": "Templates_CreateSharingKey", "parameters": [ { "name": "id", "in": "path", "description": "file id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "description": "parameters for sharing key creation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateFileShareVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateFileShareVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateFileShareVM" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileSharingKeysVM" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" } } }, "delete": { "tags": [ "Templates" ], "summary": "Deletes a sharing key, making links, that utilizing it no longer work", "operationId": "Templates_DeleteSharingKey", "parameters": [ { "name": "id", "in": "path", "description": "file id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } }, { "name": "key", "in": "path", "description": "key to delete", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" } } } }, "/api/rp/v1/Templates/File/{id}/sharingKeys": { "get": { "tags": [ "Templates" ], "summary": "Returns all sharing keys, associated with the file", "operationId": "Templates_GetSharingKeys", "parameters": [ { "name": "id", "in": "path", "description": "file id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileSharingKeysVM" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" } } } }, "/api/rp/v1/Templates/File/{id}": { "delete": { "tags": [ "Templates" ], "summary": "Delete specified file", "description": "User with Delete permission can access the method.", "operationId": "Templates_DeleteFile", "parameters": [ { "name": "id", "in": "path", "description": "file id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "204": { "description": "File succesfully deleted" }, "400": { "description": "Id is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "File or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Exception thrown" } } }, "get": { "tags": [ "Templates" ], "summary": "Get specified file", "description": "User with Get Entity permission can access this method.", "operationId": "Templates_GetFile", "parameters": [ { "name": "id", "in": "path", "description": "file id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "Returns the specified file", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateVM" } } } }, "400": { "description": "Id is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "File or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Exception thrown" } } } }, "/api/rp/v1/Templates/File/{id}/ToBin": { "delete": { "tags": [ "Templates" ], "summary": "Move specified file to recycle bin", "description": "User with Delete permission can access the method.", "operationId": "Templates_MoveFileToBin", "parameters": [ { "name": "id", "in": "path", "description": "file id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "204": { "description": "File succesfully deleted" }, "400": { "description": "Id is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "File or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Exception thrown" } } } }, "/api/rp/v1/Templates/File/{id}/Recover": { "post": { "tags": [ "Templates" ], "summary": "Recover specified file from bin", "description": "User with Delete permission can access the method.", "operationId": "Templates_RecoverFile", "parameters": [ { "name": "id", "in": "path", "description": "file id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } }, { "name": "recoveryPath", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "204": { "description": "File succesfully recovered" }, "400": { "description": "Id is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "File or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Exception thrown" } } } }, "/api/rp/v1/Templates/File/{id}/History": { "get": { "tags": [ "Templates" ], "summary": "Returns list of actions, performed on this file", "operationId": "Templates_GetFileHistory", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } }, { "name": "skip", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "take", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "default": 10 } } ], "responses": { "200": { "description": "Returns the actions", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuditActionsVM" } } } }, "400": { "description": "Id is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "File or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rp/v1/Templates/Folder/{id}/CountFiles": { "get": { "tags": [ "Templates" ], "summary": "Get count of files what contains in a specified folder", "description": "User with Get Count permission can access this method.", "operationId": "Templates_GetFilesCount", "parameters": [ { "name": "id", "in": "path", "description": "folder id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "Returns count of the files in a specified folder", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountVM" } } } }, "400": { "description": "FolderId is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Folder or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Exception thrown" } } } }, "/api/rp/v1/Templates/Folder/{id}/ListFiles": { "get": { "tags": [ "Templates" ], "summary": "Get all files from specified folder.
\r\nUser with Get Entity permission can access this method.
\r\nThe method will returns minimal infomration about the file:
\r\nid, name, size, editedTime, createdTime, tags, status, statusReason.", "operationId": "Templates_GetFilesList", "parameters": [ { "name": "id", "in": "path", "description": "folder id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } }, { "name": "skip", "in": "query", "description": "number of files, that have to be skipped", "schema": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32", "default": 0 } }, { "name": "take", "in": "query", "description": "number of files, that have to be returned", "schema": { "maximum": 120, "minimum": 1, "type": "integer", "format": "int32", "default": 10 } }, { "name": "searchPattern", "in": "query", "description": "", "schema": { "maxLength": 100, "minLength": 0, "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "$ref": "#/components/schemas/FileSorting" } }, { "name": "desc", "in": "query", "description": "", "schema": { "type": "boolean", "default": false } }, { "name": "useRegex", "in": "query", "description": "", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Returns list of the files from a specified folder", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplatesVM" } } } }, "400": { "description": "Invalid params", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "File, subscription or folder not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Exception thrown" } } } }, "/api/rp/v1/Templates/File/{id}/permissions": { "get": { "tags": [ "Templates" ], "operationId": "Templates_GetPermissions", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilePermissionsVM" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "post": { "tags": [ "Templates" ], "summary": "Update permissions", "operationId": "Templates_UpdatePermissions", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateFilePermissionsVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateFilePermissionsVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateFilePermissionsVM" } } } }, "responses": { "204": { "description": "File's permissions has been updated" }, "400": { "description": "FileId or VM is not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "File or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Exception thrown" } } } }, "/api/rp/v1/Templates/File/{id}/mypermissions": { "get": { "tags": [ "Templates" ], "summary": "Get current user's permissions to file", "operationId": "Templates_GetMyPermissions", "parameters": [ { "name": "id", "in": "path", "description": "file id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "got permissions successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilePermissionCRUDVM" } } } }, "400": { "description": "Invalid params", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "File, subscription or folder not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" } } } }, "/api/rp/v1/Templates/File/{id}/Move/{folderId}": { "post": { "tags": [ "Templates" ], "summary": "Move file to a specified folder", "description": "User with a Update Place permission for a folder and Create Entity\r\nfor a Parent Folder can access this method.", "operationId": "Templates_MoveFile", "parameters": [ { "name": "id", "in": "path", "description": "file id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } }, { "name": "folderId", "in": "path", "description": "folder id", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "responses": { "200": { "description": "File has been moved", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateVM" } } } }, "400": { "description": "fileId or folderId is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "File, subscription or folder not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Exception thrown" } } } }, "/api/rp/v1/Templates/File/{id}/Rename": { "put": { "tags": [ "Templates" ], "summary": "Rename a file", "description": "User with Update Name permission can access this method.", "operationId": "Templates_RenameFile", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileRenameVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FileRenameVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FileRenameVM" } } } }, "responses": { "200": { "description": "File name has been updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateVM" } } } }, "400": { "description": "FileId is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "File or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Exception thrown" } } } }, "/api/rp/v1/Templates/File/{id}/Icon": { "put": { "tags": [ "Templates" ], "summary": "Update a files's icon", "description": "User with Update Icon permission can access this method.", "operationId": "Templates_UpdateIcon", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileIconVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FileIconVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FileIconVM" } } } }, "responses": { "200": { "description": "File's icon has been updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateVM" } } } }, "400": { "description": "FileId is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "File or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Exception thrown" } } } }, "/api/rp/v1/Templates/File/{id}/UpdateTags": { "put": { "tags": [ "Templates" ], "summary": "Update tags", "description": "User with Update Tags permission can access this method.", "operationId": "Templates_UpdateTags", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileTagsUpdateVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FileTagsUpdateVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FileTagsUpdateVM" } } } }, "responses": { "200": { "description": "Tags has been updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateVM" } } } }, "400": { "description": "FileId is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "File or subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Exception thrown" } } } }, "/api/rp/v1/Templates/Folder/{id}/File": { "post": { "tags": [ "Templates" ], "summary": "Upload a file to the specified folder. The method is deprecated, use the UploadFileV2 method instead!", "description": "User with Create Entity permission can access this method.", "operationId": "Templates_UploadFile", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of folder", "required": true, "schema": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" } } ], "requestBody": { "description": "file's view model", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateCreateVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TemplateCreateVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TemplateCreateVM" } } } }, "responses": { "200": { "description": "File has been uploaded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateVM" } } } }, "400": { "description": "fileVM view model is not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You don't have rights for the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "subscription is outdated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "folder/subscription is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "deprecated": true } }, "/api/manage/v1/notifications": { "delete": { "tags": [ "UserNotifications" ], "summary": "Use this endpoint to \"clear\" your notifications", "operationId": "UserNotifications_ClearNotifications", "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClearNotificationsVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ClearNotificationsVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ClearNotificationsVM" } } } }, "responses": { "204": { "description": "Notifications are cleared" }, "400": { "description": "Bad VM", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "User is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "get": { "tags": [ "UserNotifications" ], "summary": "Use this endpoint to recieve notifications", "operationId": "UserNotifications_GetNotifications", "parameters": [ { "name": "skip", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "take", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 5 } }, { "name": "subscriptionId", "in": "query", "schema": { "pattern": "(^$)|(^[A-Fa-f0-9]{24}$)", "type": "string", "default": "" } } ], "responses": { "200": { "description": "Notifications are getted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuditActionsVM" } } } } } } }, "/api/manage/v1/UserProfile": { "get": { "tags": [ "UserProfile" ], "summary": "Return current profile of the current user", "operationId": "UserProfile_GetMyProfile", "responses": { "200": { "description": "Succesfully returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserProfileVM" } } } } } }, "put": { "tags": [ "UserProfile" ], "summary": "Update profile of the current user", "description": "This method is only allowed for local sign in via intranet", "operationId": "UserProfile_UpdateMyProfile", "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateUserProfileVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateUserProfileVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateUserProfileVM" } } } }, "responses": { "204": { "description": "No Content" }, "400": { "description": "The request is wrong", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "Succesfully updated" } } } }, "/api/manage/v1/UserProfile/{userId}": { "get": { "tags": [ "UserProfile" ], "summary": "Return user profile by user identifier.\r\nIf the user did not provide information about himself or blocked, then the endpoint will return an empty model. (only id)", "operationId": "UserProfile_GetUserProfile", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "pattern": "(^000000000000000000000000$|^[0-9a-f]{24}$|^([0-9a-f]{8}([-][0-9a-f]{4}){3}[-][0-9a-f]{12})$)", "type": "string" } } ], "responses": { "200": { "description": "Succesfully returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserProfileVM" } } } }, "404": { "description": "User not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/manage/v1/UserSettings": { "get": { "tags": [ "UserSettings" ], "summary": "Return current user settings.", "operationId": "UserSettings_GetCurrentUserSettings", "responses": { "200": { "description": "Succesfully returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserSettingsVM" } } } }, "400": { "description": "Current user is null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "User not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "UserSettings" ], "summary": "Update settings of the current user", "operationId": "UserSettings_UpdateMySettings", "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateUserSettingsVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateUserSettingsVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateUserSettingsVM" } } } }, "responses": { "200": { "description": "Succesfully updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserSettingsVM" } } } }, "400": { "description": "The request is wrong", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "You have no permission for this action", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/manage/v1/UserSettings/accept": { "post": { "tags": [ "UserSettings" ], "summary": "Use this endpoint to accept current version of service license agreement", "operationId": "UserSettings_AcceptAgreements", "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AcceptAgreementsVM" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AcceptAgreementsVM" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AcceptAgreementsVM" } } } }, "responses": { "204": { "description": "No Content" } } } } }, "components": { "schemas": { "AcceptAgreementsVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "slaAccepted": { "type": "boolean" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "AcceptAgreementsVM": "#/components/schemas/AcceptAgreementsVM" } } }, "AdminAdministrate": { "enum": [ 0, 1, 2, 4, 8, 16, -1 ], "type": "integer", "format": "int32", "x-enumNames": [ "None", "File", "Subscription", "Group", "DataSource", "Task", "All" ], "x-enumFlags": true, "x-typeName": "FastReport.Cloud.Enums.AdminPermissionsEnums.AdminAdministrate" }, "AdminCreate": { "enum": [ 0, 1, 2, 4, 8, 16, 32, 64, 128, -1 ], "type": "integer", "format": "int32", "x-enumNames": [ "None", "SubscriptionPlan", "Subscription", "Group", "User", "DataSource", "File", "ApiKey", "Invite", "All" ], "x-enumFlags": true, "x-typeName": "FastReport.Cloud.Enums.AdminPermissionsEnums.AdminCreate" }, "AdminCreateAdminGetAdminUpdateAdminDeleteAdminExecuteAdminAdministratePermission": { "type": "object", "properties": { "create": { "$ref": "#/components/schemas/AdminCreate" }, "delete": { "$ref": "#/components/schemas/AdminDelete" }, "execute": { "$ref": "#/components/schemas/AdminExecute" }, "get": { "$ref": "#/components/schemas/AdminGet" }, "update": { "$ref": "#/components/schemas/AdminUpdate" }, "administrate": { "$ref": "#/components/schemas/AdminAdministrate" } }, "additionalProperties": false }, "AdminDelete": { "enum": [ 0, 1, 2, 4, 8, 16, 32, 64, 128, 256, -1 ], "type": "integer", "format": "int32", "x-enumNames": [ "None", "SubscriptionPlan", "Subscription", "Group", "User", "DataSource", "File", "ApiKey", "Invite", "Task", "All" ], "x-enumFlags": true, "x-typeName": "FastReport.Cloud.Enums.AdminPermissionsEnums.AdminDelete" }, "AdminExecute": { "enum": [ 0, 1, 2, 4, 8, 16, -1 ], "type": "integer", "format": "int32", "x-enumNames": [ "None", "Renew", "Analytics", "ProblemSolving", "DataSourceFetch", "ReCount", "All" ], "x-enumFlags": true, "x-typeName": "FastReport.Cloud.Enums.AdminPermissionsEnums.AdminExecute" }, "AdminExportFolderCreateVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/AdminFolderCreateVM" } ], "properties": { "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "AdminExportFolderCreateVM": "#/components/schemas/AdminExportFolderCreateVM" } } }, "AdminFolderCreateVM": { "required": [ "$t", "ownerId", "parentId" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/FolderCreateVM" } ], "properties": { "parentId": { "minLength": 1, "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" }, "ownerId": { "minLength": 1, "pattern": "(^[0-9a-f]{24}$|^([0-9a-f]{8}([-][0-9a-f]{4}){3}[-][0-9a-f]{12})$)", "type": "string" }, "force": { "type": "boolean" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "AdminFolderCreateVM": "#/components/schemas/AdminFolderCreateVM", "AdminExportFolderCreateVM": "#/components/schemas/AdminExportFolderCreateVM", "AdminReportFolderCreateVM": "#/components/schemas/AdminReportFolderCreateVM", "AdminTemplateFolderCreateVM": "#/components/schemas/AdminTemplateFolderCreateVM" } } }, "AdminGet": { "enum": [ 0, 1, 2, 4, 8, 16, 32, 64, 128, 256, 512, -1 ], "type": "integer", "format": "int32", "x-enumNames": [ "None", "SubscriptionPlan", "Subscription", "Group", "User", "DataSource", "File", "ApiKey", "Invite", "Task", "Audit", "All" ], "x-enumFlags": true, "x-typeName": "FastReport.Cloud.Enums.AdminPermissionsEnums.AdminGet" }, "AdminPermission": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/AdminCreateAdminGetAdminUpdateAdminDeleteAdminExecuteAdminAdministratePermission" } ], "additionalProperties": false }, "AdminReportFolderCreateVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/AdminFolderCreateVM" } ], "properties": { "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "AdminReportFolderCreateVM": "#/components/schemas/AdminReportFolderCreateVM" } } }, "AdminSubscriptionVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/SubscriptionVM" } ], "properties": { "defaultPermissions": { "$ref": "#/components/schemas/DefaultPermissionsVM" }, "ownerId": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string", "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "AdminSubscriptionVM": "#/components/schemas/AdminSubscriptionVM" } } }, "AdminSubscriptionsVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "subscriptions": { "type": "array", "items": { "$ref": "#/components/schemas/AdminSubscriptionVM" }, "nullable": true }, "count": { "type": "integer", "format": "int64" }, "skip": { "type": "integer", "format": "int32" }, "take": { "type": "integer", "format": "int32" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "AdminSubscriptionsVM": "#/components/schemas/AdminSubscriptionsVM" } } }, "AdminTemplateFolderCreateVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/AdminFolderCreateVM" } ], "properties": { "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "AdminTemplateFolderCreateVM": "#/components/schemas/AdminTemplateFolderCreateVM" } } }, "AdminUpdate": { "enum": [ 0, 1, 2, 4, 8, 16, 32, -1 ], "type": "integer", "format": "int32", "x-enumNames": [ "None", "SubscriptionPlan", "Subscription", "Group", "User", "DataSource", "File", "All" ], "x-enumFlags": true, "x-typeName": "FastReport.Cloud.Enums.AdminPermissionsEnums.AdminUpdate" }, "AdminUpdateCurrentSubscriptionPlanVM": { "required": [ "$t", "plan" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "plan": { "$ref": "#/components/schemas/UpdateSubscriptionPlanVM" }, "start": { "type": "string", "format": "date-time", "nullable": true }, "end": { "type": "string", "format": "date-time", "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "AdminUpdateCurrentSubscriptionPlanVM": "#/components/schemas/AdminUpdateCurrentSubscriptionPlanVM" } } }, "AnalysisResultVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "level": { "$ref": "#/components/schemas/ProblemLevel" }, "detail": { "type": "string", "nullable": true }, "id": { "type": "string", "nullable": true }, "subscriptionId": { "type": "string", "nullable": true }, "fileId": { "type": "string", "nullable": true }, "collectionName": { "type": "string", "nullable": true }, "type": { "$ref": "#/components/schemas/ProblemType" }, "signature": { "type": "string", "nullable": true }, "newSize": { "type": "integer", "format": "int64" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "AnalysisResultVM": "#/components/schemas/AnalysisResultVM" } } }, "AnalysisResultsVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/AnalysisResultVM" }, "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "AnalysisResultsVM": "#/components/schemas/AnalysisResultsVM" } } }, "ApiKeyVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "value": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "expired": { "type": "string", "format": "date-time" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "ApiKeyVM": "#/components/schemas/ApiKeyVM" } } }, "ApiKeysVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "apiKeys": { "type": "array", "items": { "$ref": "#/components/schemas/ApiKeyVM" }, "nullable": true }, "count": { "type": "integer", "format": "int64" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "ApiKeysVM": "#/components/schemas/ApiKeysVM" } } }, "AppMixinsVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "head": { "type": "string", "nullable": true }, "body": { "type": "string", "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "AppMixinsVM": "#/components/schemas/AppMixinsVM" } } }, "AuditActionVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "userId": { "type": "string", "nullable": true }, "entityId": { "type": "string", "nullable": true }, "subscriptionId": { "type": "string", "nullable": true }, "type": { "$ref": "#/components/schemas/AuditType" }, "id": { "type": "string", "nullable": true }, "createdTime": { "type": "string", "format": "date-time" }, "creatorUserId": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "adminAction": { "type": "boolean" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "AuditActionVM": "#/components/schemas/AuditActionVM", "AuditFilePropertyChangedVM": "#/components/schemas/AuditFilePropertyChangedVM", "AuditSubscriptionActionVM": "#/components/schemas/AuditSubscriptionActionVM", "AuditTaskActionVM": "#/components/schemas/AuditTaskActionVM" } } }, "AuditActionsVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AuditActionVM" }, "nullable": true }, "hasMore": { "type": "boolean" }, "skip": { "type": "integer", "format": "int32" }, "take": { "type": "integer", "format": "int32" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "AuditActionsVM": "#/components/schemas/AuditActionsVM" } } }, "AuditActiveStatsVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "items": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32", "nullable": true }, "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "AuditActiveStatsVM": "#/components/schemas/AuditActiveStatsVM" } } }, "AuditFilePropertyChangedVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/AuditActionVM" } ], "properties": { "propertyName": { "type": "string", "nullable": true }, "oldValue": { "nullable": true }, "newValue": { "nullable": true }, "entityType": { "$ref": "#/components/schemas/EntityType" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "AuditFilePropertyChangedVM": "#/components/schemas/AuditFilePropertyChangedVM" } } }, "AuditStatVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "count": { "type": "integer", "format": "int32" }, "type": { "$ref": "#/components/schemas/AuditType" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "AuditStatVM": "#/components/schemas/AuditStatVM" } } }, "AuditStatsVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "items": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/AuditStatVM" }, "nullable": true }, "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "AuditStatsVM": "#/components/schemas/AuditStatsVM" } } }, "AuditSubscriptionActionVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/AuditActionVM" } ], "properties": { "periodStart": { "type": "string", "format": "date-time" }, "periodEnd": { "type": "string", "format": "date-time" }, "planId": { "type": "string", "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "AuditSubscriptionActionVM": "#/components/schemas/AuditSubscriptionActionVM" } } }, "AuditTaskActionVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/AuditActionVM" } ], "properties": { "messageId": { "type": "string", "nullable": true }, "fileName": { "type": "string", "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "AuditTaskActionVM": "#/components/schemas/AuditTaskActionVM" } } }, "AuditType": { "enum": [ "Task_Created_ExportTemplate", "Task_Created_ExportReport", "Task_Created_PrepareTemplate", "Task_Created_Fetch", "Task_Created_Email", "Task_Created_Webhook", "Task_Deleted_ExportTemplate", "Task_Deleted_ExportReport", "Task_Deleted_PrepareTemplate", "Task_Deleted_Fetch", "Task_Deleted_Email", "Task_Deleted_Webhook", "Task_Updated_ExportTemplate", "Task_Updated_ExportReport", "Task_Updated_PrepareTemplate", "Task_Updated_Fetch", "Task_Updated_Email", "Task_Updated_Webhook", "Task_InQueue_ExportTemplate", "Task_InQueue_ExportReport", "Task_InQueue_PrepareTemplate", "Task_InQueue_Fetch", "Task_InQueue_Email", "Task_InQueue_Webhook", "Task_InProcess_ExportTemplate", "Task_InProcess_ExportReport", "Task_InProcess_PrepareTemplate", "Task_InProcess_Fetch", "Task_InProcess_Email", "Task_InProcess_Webhook", "Task_Success_ExportTemplate", "Task_Success_ExportReport", "Task_Success_PrepareTemplate", "Task_Success_Fetch", "Task_Success_Email", "Task_Success_Webhook", "Task_Failed_ExportTemplate", "Task_Failed_ExportReport", "Task_Failed_PrepareTemplate", "Task_Failed_Fetch", "Task_Failed_Email", "Task_Failed_Webhook", "Task_Created_ThumbnailReport", "Task_Deleted_ThumbnailReport", "Task_Updated_ThumbnailReport", "Task_InQueue_ThumbnailReport", "Task_InProcess_ThumbnailReport", "Task_Success_ThumbnailReport", "Task_Fail_ThumbnailReport", "Task_Created_ThumbnailTemplate", "Task_Deleted_ThumbnailTemplate", "Task_Updated_ThumbnailTemplate", "Task_InQueue_ThumbnailTemplate", "Task_InProcess_ThumbnailTemplate", "Task_Success_ThumbnailTemplate", "Task_Fail_ThumbnailTemplate", "Subscription_Renewed", "Subscription_Created", "File_Renamed", "File_Content_Updated", "File_Deleted", "File_Moved", "File_Copied", "File_Tags_Updated", "File_Permissions_Updated", "File_Restored", "File_MovedToBin", "File_Updated", "Task_Created_FTPUpload", "Task_Deleted_FTPUpload", "Task_Updated_FTPUpload", "Task_InQueue_FTPUpload", "Task_InProcess_FTPUpload", "Task_Success_FTPUpload", "Task_Fail_FTPUpload", "File_Created" ], "type": "string", "x-typeName": "FastReport.Cloud.Enums.AuditType" }, "AuthConfigVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "useLocal": { "type": "boolean" }, "useOpenId": { "type": "boolean" }, "authority": { "type": "string", "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "AuthConfigVM": "#/components/schemas/AuthConfigVM" } } }, "BreadcrumbsModel": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BreadcrumbsVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "breadcrumbs": { "type": "array", "items": { "$ref": "#/components/schemas/BreadcrumbsModel" }, "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "BreadcrumbsVM": "#/components/schemas/BreadcrumbsVM" } } }, "CheckUserByPasswordInternalVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "email": { "maxLength": 250, "minLength": 0, "type": "string", "format": "email", "nullable": true }, "password": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "CheckUserByPasswordInternalVM": "#/components/schemas/CheckUserByPasswordInternalVM" } } }, "ClearNotificationsVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "update": { "type": "boolean" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "ClearNotificationsVM": "#/components/schemas/ClearNotificationsVM" } } }, "CloudBaseVM": { "required": [ "$t" ], "type": "object", "properties": { "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "TaskBaseVM": "#/components/schemas/TaskBaseVM", "TaskSettingsVM": "#/components/schemas/TaskSettingsVM", "FileContentVM": "#/components/schemas/FileContentVM", "UpdateContentInternalVM": "#/components/schemas/UpdateContentInternalVM", "AnalysisResultsVM": "#/components/schemas/AnalysisResultsVM", "AnalysisResultVM": "#/components/schemas/AnalysisResultVM", "CloudBaseVM": "#/components/schemas/CloudBaseVM", "ExportCreateVM": "#/components/schemas/ExportCreateVM", "ExportVM": "#/components/schemas/ExportVM", "FileCreateFormVM": "#/components/schemas/FileCreateFormVM", "FileCreateVM": "#/components/schemas/FileCreateVM", "FileVM": "#/components/schemas/FileVM", "ReportCreateVM": "#/components/schemas/ReportCreateVM", "ReportVM": "#/components/schemas/ReportVM", "TemplateCreateFormVM": "#/components/schemas/TemplateCreateFormVM", "TemplateCreateVM": "#/components/schemas/TemplateCreateVM", "TemplateVM": "#/components/schemas/TemplateVM", "AdminFolderCreateVM": "#/components/schemas/AdminFolderCreateVM", "ExportFolderCreateVM": "#/components/schemas/ExportFolderCreateVM", "FolderCreateVM": "#/components/schemas/FolderCreateVM", "FolderIconVM": "#/components/schemas/FolderIconVM", "FolderRenameVM": "#/components/schemas/FolderRenameVM", "FolderSizeVM": "#/components/schemas/FolderSizeVM", "FolderTagsUpdateVM": "#/components/schemas/FolderTagsUpdateVM", "ReportFolderCreateVM": "#/components/schemas/ReportFolderCreateVM", "TemplateFolderCreateVM": "#/components/schemas/TemplateFolderCreateVM", "ServerConfigurationVM": "#/components/schemas/ServerConfigurationVM", "FrontendAppVM": "#/components/schemas/FrontendAppVM", "AppMixinsVM": "#/components/schemas/AppMixinsVM", "AuthConfigVM": "#/components/schemas/AuthConfigVM", "SolvationReportVM": "#/components/schemas/SolvationReportVM", "CreateSubscriptionPlanVM": "#/components/schemas/CreateSubscriptionPlanVM", "SubscriptionPlansVM": "#/components/schemas/SubscriptionPlansVM", "SubscriptionPlanVM": "#/components/schemas/SubscriptionPlanVM", "SubscriptionUserVM": "#/components/schemas/SubscriptionUserVM", "SubscriptionVM": "#/components/schemas/SubscriptionVM", "UpdateSubscriptionPlanVM": "#/components/schemas/UpdateSubscriptionPlanVM", "AcceptAgreementsVM": "#/components/schemas/AcceptAgreementsVM", "ApiKeysVM": "#/components/schemas/ApiKeysVM", "ApiKeyVM": "#/components/schemas/ApiKeyVM", "CheckUserByPasswordInternalVM": "#/components/schemas/CheckUserByPasswordInternalVM", "CreateApiKeyVM": "#/components/schemas/CreateApiKeyVM", "CreateIfNotExistInternalVM": "#/components/schemas/CreateIfNotExistInternalVM", "DeleteApiKeyVM": "#/components/schemas/DeleteApiKeyVM", "RegisterUserVM": "#/components/schemas/RegisterUserVM", "UpdateUserProfileVM": "#/components/schemas/UpdateUserProfileVM", "UpdateUserSettingsVM": "#/components/schemas/UpdateUserSettingsVM", "UpdateUserVM": "#/components/schemas/UpdateUserVM", "UserIsAdminVM": "#/components/schemas/UserIsAdminVM", "UserProfileVM": "#/components/schemas/UserProfileVM", "UserResultVM": "#/components/schemas/UserResultVM", "UserSettingsVM": "#/components/schemas/UserSettingsVM", "UsersVM": "#/components/schemas/UsersVM", "UserVM": "#/components/schemas/UserVM", "CreateTaskBaseVM": "#/components/schemas/CreateTaskBaseVM", "InputFileVM": "#/components/schemas/InputFileVM", "OutputFileVM": "#/components/schemas/OutputFileVM", "TasksVM": "#/components/schemas/TasksVM", "TransformTaskBaseVM": "#/components/schemas/TransformTaskBaseVM", "TransportTaskBaseVM": "#/components/schemas/TransportTaskBaseVM", "RunInputFileVM": "#/components/schemas/RunInputFileVM", "TaskIdsVM": "#/components/schemas/TaskIdsVM", "TaskMessageIdVM": "#/components/schemas/TaskMessageIdVM", "TaskPermissionsVM": "#/components/schemas/TaskPermissionsVM", "TaskPermissionsCRUDVM": "#/components/schemas/TaskPermissionsCRUDVM", "TaskPermissionCRUDVM": "#/components/schemas/TaskPermissionCRUDVM", "UpdateTaskBaseVM": "#/components/schemas/UpdateTaskBaseVM", "UpdateTaskPermissionsVM": "#/components/schemas/UpdateTaskPermissionsVM", "UpdateFetchTaskVM": "#/components/schemas/UpdateFetchTaskVM", "UpdateThumbnailReportTaskVM": "#/components/schemas/UpdateThumbnailReportTaskVM", "UpdateThumbnailTemplateTaskVM": "#/components/schemas/UpdateThumbnailTemplateTaskVM", "FetchTaskVM": "#/components/schemas/FetchTaskVM", "ThumbnailReportTaskVM": "#/components/schemas/ThumbnailReportTaskVM", "ThumbnailTemplateTaskVM": "#/components/schemas/ThumbnailTemplateTaskVM", "RunTaskBaseVM": "#/components/schemas/RunTaskBaseVM", "RunTransformTaskBaseVM": "#/components/schemas/RunTransformTaskBaseVM", "RunFetchTaskVM": "#/components/schemas/RunFetchTaskVM", "RunThumbnailReportTaskVM": "#/components/schemas/RunThumbnailReportTaskVM", "RunThumbnailTemplateTaskVM": "#/components/schemas/RunThumbnailTemplateTaskVM", "CreateTransportTaskBaseVM": "#/components/schemas/CreateTransportTaskBaseVM", "RunTransportTaskBaseVM": "#/components/schemas/RunTransportTaskBaseVM", "UpdateTransportTaskBaseVM": "#/components/schemas/UpdateTransportTaskBaseVM", "CreateEmailTaskVM": "#/components/schemas/CreateEmailTaskVM", "CreateWebhookTaskVM": "#/components/schemas/CreateWebhookTaskVM", "EmailTaskVM": "#/components/schemas/EmailTaskVM", "WebhookTaskVM": "#/components/schemas/WebhookTaskVM", "RunEmailTaskVM": "#/components/schemas/RunEmailTaskVM", "RunWebhookTaskVM": "#/components/schemas/RunWebhookTaskVM", "UpdateEmailTaskVM": "#/components/schemas/UpdateEmailTaskVM", "UpdateWebhookTaskVM": "#/components/schemas/UpdateWebhookTaskVM", "CreateExportReportTaskVM": "#/components/schemas/CreateExportReportTaskVM", "CreateExportTemplateTaskVM": "#/components/schemas/CreateExportTemplateTaskVM", "CreatePrepareTemplateTaskVM": "#/components/schemas/CreatePrepareTemplateTaskVM", "CreateTransformTaskBaseVM": "#/components/schemas/CreateTransformTaskBaseVM", "ExportReportTaskVM": "#/components/schemas/ExportReportTaskVM", "ExportTemplateTaskVM": "#/components/schemas/ExportTemplateTaskVM", "PrepareTemplateTaskVM": "#/components/schemas/PrepareTemplateTaskVM", "RunExportReportTaskVM": "#/components/schemas/RunExportReportTaskVM", "RunExportTemplateTaskVM": "#/components/schemas/RunExportTemplateTaskVM", "RunPrepareTemplateTaskVM": "#/components/schemas/RunPrepareTemplateTaskVM", "UpdateExportReportTaskVM": "#/components/schemas/UpdateExportReportTaskVM", "UpdateExportTemplateTaskVM": "#/components/schemas/UpdateExportTemplateTaskVM", "UpdatePrepareTemplateTaskVM": "#/components/schemas/UpdatePrepareTemplateTaskVM", "UpdateTransformTaskBaseVM": "#/components/schemas/UpdateTransformTaskBaseVM", "CreateFetchTaskVM": "#/components/schemas/CreateFetchTaskVM", "CreateThumbnailReportTaskVM": "#/components/schemas/CreateThumbnailReportTaskVM", "CreateThumbnailTemplateTaskVM": "#/components/schemas/CreateThumbnailTemplateTaskVM", "AdminSubscriptionsVM": "#/components/schemas/AdminSubscriptionsVM", "AdminSubscriptionVM": "#/components/schemas/AdminSubscriptionVM", "AdminUpdateCurrentSubscriptionPlanVM": "#/components/schemas/AdminUpdateCurrentSubscriptionPlanVM", "CreateSubscriptionInviteVM": "#/components/schemas/CreateSubscriptionInviteVM", "CreateSubscriptionPeriodVM": "#/components/schemas/CreateSubscriptionPeriodVM", "CreateSubscriptionVM": "#/components/schemas/CreateSubscriptionVM", "DefaultPermissionsVM": "#/components/schemas/DefaultPermissionsVM", "MyPermissionsVM": "#/components/schemas/MyPermissionsVM", "RenameSubscriptionVM": "#/components/schemas/RenameSubscriptionVM", "RestOfSpaceVM": "#/components/schemas/RestOfSpaceVM", "SubscriptionInvitesVM": "#/components/schemas/SubscriptionInvitesVM", "SubscriptionInviteVM": "#/components/schemas/SubscriptionInviteVM", "SubscriptionPeriodVM": "#/components/schemas/SubscriptionPeriodVM", "SubscriptionPermissionsVM": "#/components/schemas/SubscriptionPermissionsVM", "SubscriptionPermissionsCRUDVM": "#/components/schemas/SubscriptionPermissionsCRUDVM", "SubscriptionPermissionCRUDVM": "#/components/schemas/SubscriptionPermissionCRUDVM", "SubscriptionsVM": "#/components/schemas/SubscriptionsVM", "SubscriptionUsersVM": "#/components/schemas/SubscriptionUsersVM", "UpdateDefaultPermissionsVM": "#/components/schemas/UpdateDefaultPermissionsVM", "UpdateSubscriptionLocaleVM": "#/components/schemas/UpdateSubscriptionLocaleVM", "UpdateSubscriptionPermissionsVM": "#/components/schemas/UpdateSubscriptionPermissionsVM", "UpdateSubscriptionVM": "#/components/schemas/UpdateSubscriptionVM", "CreateGroupAdminVM": "#/components/schemas/CreateGroupAdminVM", "CreateGroupVM": "#/components/schemas/CreateGroupVM", "GroupPermissionsVM": "#/components/schemas/GroupPermissionsVM", "GroupPermissionsCRUDVM": "#/components/schemas/GroupPermissionsCRUDVM", "GroupPermissionCRUDVM": "#/components/schemas/GroupPermissionCRUDVM", "GroupsVM": "#/components/schemas/GroupsVM", "GroupUsersVM": "#/components/schemas/GroupUsersVM", "GroupUserVM": "#/components/schemas/GroupUserVM", "GroupVM": "#/components/schemas/GroupVM", "RenameGroupVM": "#/components/schemas/RenameGroupVM", "UpdateGroupPermissionsVM": "#/components/schemas/UpdateGroupPermissionsVM", "UpdateGroupVM": "#/components/schemas/UpdateGroupVM", "AdminExportFolderCreateVM": "#/components/schemas/AdminExportFolderCreateVM", "AdminReportFolderCreateVM": "#/components/schemas/AdminReportFolderCreateVM", "AdminTemplateFolderCreateVM": "#/components/schemas/AdminTemplateFolderCreateVM", "BreadcrumbsVM": "#/components/schemas/BreadcrumbsVM", "CountVM": "#/components/schemas/CountVM", "ExportReportVM": "#/components/schemas/ExportReportVM", "ExportTemplateVM": "#/components/schemas/ExportTemplateVM", "FileIconVM": "#/components/schemas/FileIconVM", "FilePermissionsVM": "#/components/schemas/FilePermissionsVM", "FilePermissionsCRUDVM": "#/components/schemas/FilePermissionsCRUDVM", "FilePermissionCRUDVM": "#/components/schemas/FilePermissionCRUDVM", "FileRenameVM": "#/components/schemas/FileRenameVM", "FileStatusUpdateInternalVM": "#/components/schemas/FileStatusUpdateInternalVM", "FileStatusVM": "#/components/schemas/FileStatusVM", "FilesVM": "#/components/schemas/FilesVM", "FilesVMBase": "#/components/schemas/FilesVMBase", "FileTagsUpdateVM": "#/components/schemas/FileTagsUpdateVM", "FileThumbnailUpdateInternalVM": "#/components/schemas/FileThumbnailUpdateInternalVM", "FileUpdateVM": "#/components/schemas/FileUpdateVM", "PrepareTemplateVM": "#/components/schemas/PrepareTemplateVM", "PreviewReportVM": "#/components/schemas/PreviewReportVM", "PreviewTemplateVM": "#/components/schemas/PreviewTemplateVM", "ReportsVM": "#/components/schemas/ReportsVM", "TemplatesVM": "#/components/schemas/TemplatesVM", "UpdateFilePermissionsVM": "#/components/schemas/UpdateFilePermissionsVM", "ReportParametersVM": "#/components/schemas/ReportParametersVM", "TemplateContentVM": "#/components/schemas/TemplateContentVM", "TemplateCreateAdminVM": "#/components/schemas/TemplateCreateAdminVM", "UpdateFileContentInternalVM": "#/components/schemas/UpdateFileContentInternalVM", "UpdateFileContentVM": "#/components/schemas/UpdateFileContentVM", "UpdateFileContentFormVM": "#/components/schemas/UpdateFileContentFormVM", "ReportCreateAdminVM": "#/components/schemas/ReportCreateAdminVM", "ReportCreateFormVM": "#/components/schemas/ReportCreateFormVM", "ExportCreateAdminVM": "#/components/schemas/ExportCreateAdminVM", "ExportsVM": "#/components/schemas/ExportsVM", "CreateDataSourceAdminVM": "#/components/schemas/CreateDataSourceAdminVM", "CreateDataSourceVM": "#/components/schemas/CreateDataSourceVM", "DataSourceParameterTypesVM": "#/components/schemas/DataSourceParameterTypesVM", "DataSourcePermissionsVM": "#/components/schemas/DataSourcePermissionsVM", "DataSourcePermissionsCRUDVM": "#/components/schemas/DataSourcePermissionsCRUDVM", "DataSourcePermissionCRUDVM": "#/components/schemas/DataSourcePermissionCRUDVM", "DataSourceSelectCommandParameterVM": "#/components/schemas/DataSourceSelectCommandParameterVM", "DataSourceSelectCommandVM": "#/components/schemas/DataSourceSelectCommandVM", "DataSourcesVM": "#/components/schemas/DataSourcesVM", "DataSourceVM": "#/components/schemas/DataSourceVM", "RenameDataSourceVM": "#/components/schemas/RenameDataSourceVM", "UpdateDataSourceConnectionStringVM": "#/components/schemas/UpdateDataSourceConnectionStringVM", "UpdateDataSourcePermissionsVM": "#/components/schemas/UpdateDataSourcePermissionsVM", "UpdateDataSourceSelectCommandsVM": "#/components/schemas/UpdateDataSourceSelectCommandsVM", "UpdateDataSourceSubscriptionVM": "#/components/schemas/UpdateDataSourceSubscriptionVM", "UpdateDataSourceVM": "#/components/schemas/UpdateDataSourceVM", "UpdateDataVM": "#/components/schemas/UpdateDataVM", "AuditActionsVM": "#/components/schemas/AuditActionsVM", "AuditActionVM": "#/components/schemas/AuditActionVM", "AuditActiveStatsVM": "#/components/schemas/AuditActiveStatsVM", "AuditFilePropertyChangedVM": "#/components/schemas/AuditFilePropertyChangedVM", "AuditStatsVM": "#/components/schemas/AuditStatsVM", "AuditStatVM": "#/components/schemas/AuditStatVM", "AuditSubscriptionActionVM": "#/components/schemas/AuditSubscriptionActionVM", "AuditTaskActionVM": "#/components/schemas/AuditTaskActionVM", "CreateAuditActionVM": "#/components/schemas/CreateAuditActionVM", "ClearNotificationsVM": "#/components/schemas/ClearNotificationsVM", "UpdateFTPUploadTaskVM": "#/components/schemas/UpdateFTPUploadTaskVM", "RunFTPUploadTaskVM": "#/components/schemas/RunFTPUploadTaskVM", "FTPUploadTaskVM": "#/components/schemas/FTPUploadTaskVM", "CreateFTPUploadTaskVM": "#/components/schemas/CreateFTPUploadTaskVM", "SelectedFilesVM": "#/components/schemas/SelectedFilesVM" } } }, "ContactGroupVM": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "subscriptionId": { "type": "string", "nullable": true }, "createdTime": { "type": "string", "format": "date-time" }, "creatorUserId": { "type": "string", "nullable": true }, "editedTime": { "type": "string", "format": "date-time" }, "editorUserId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ContactGroupsVM": { "type": "object", "properties": { "groups": { "type": "array", "items": { "$ref": "#/components/schemas/ContactGroupVM" }, "nullable": true }, "skip": { "type": "integer", "format": "int32" }, "take": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "ContactVM": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "groups": { "type": "array", "items": { "type": "string" }, "nullable": true }, "subscriptionId": { "type": "string", "nullable": true }, "createdTime": { "type": "string", "format": "date-time" }, "creatorUserId": { "type": "string", "nullable": true }, "editedTime": { "type": "string", "format": "date-time" }, "editorUserId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ContactsVM": { "type": "object", "properties": { "contacts": { "type": "array", "items": { "$ref": "#/components/schemas/ContactVM" }, "nullable": true }, "skip": { "type": "integer", "format": "int32" }, "take": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "CountVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "count": { "type": "integer", "format": "int64" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "CountVM": "#/components/schemas/CountVM" } } }, "CreateApiKeyVM": { "required": [ "$t", "expired" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "description": { "maxLength": 300, "minLength": 0, "type": "string", "nullable": true }, "expired": { "type": "string", "format": "date-time" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "CreateApiKeyVM": "#/components/schemas/CreateApiKeyVM" } } }, "CreateAuditActionVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "userId": { "type": "string", "nullable": true }, "entityId": { "type": "string", "nullable": true }, "subscriptionId": { "type": "string", "nullable": true }, "type": { "$ref": "#/components/schemas/AuditType" }, "messageId": { "type": "string", "nullable": true }, "fileName": { "type": "string", "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "CreateAuditActionVM": "#/components/schemas/CreateAuditActionVM" } } }, "CreateContactGroupVM": { "required": [ "name" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string" }, "subscriptionId": { "pattern": "(^$)|(^[A-Fa-f0-9]{24}$)", "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateContactVM": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "groups": { "maxItems": 10, "type": "array", "items": { "type": "string" }, "nullable": true }, "subscriptionId": { "pattern": "(^$)|(^[A-Fa-f0-9]{24}$)", "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateDataSourceAdminVM": { "required": [ "$t", "ownerId" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CreateDataSourceVM" } ], "properties": { "ownerId": { "minLength": 1, "pattern": "(^[0-9a-f]{24}$|^([0-9a-f]{8}([-][0-9a-f]{4}){3}[-][0-9a-f]{12})$)", "type": "string" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "CreateDataSourceAdminVM": "#/components/schemas/CreateDataSourceAdminVM" } } }, "CreateDataSourceVM": { "required": [ "$t", "connectionString", "subscriptionId" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "name": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "connectionString": { "maxLength": 5000, "minLength": 0, "type": "string" }, "subscriptionId": { "minLength": 1, "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" }, "connectionType": { "$ref": "#/components/schemas/DataSourceConnectionType" }, "selectCommands": { "maxItems": 10, "type": "array", "items": { "$ref": "#/components/schemas/DataSourceSelectCommandVM" }, "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "CreateDataSourceAdminVM": "#/components/schemas/CreateDataSourceAdminVM", "CreateDataSourceVM": "#/components/schemas/CreateDataSourceVM" } } }, "CreateEmailTaskVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CreateTransportTaskBaseVM" } ], "properties": { "body": { "maxLength": 384000, "minLength": 1, "type": "string", "nullable": true }, "enableSsl": { "type": "boolean" }, "from": { "type": "string", "format": "email", "nullable": true }, "isBodyHtml": { "type": "boolean" }, "password": { "maxLength": 300, "minLength": 5, "type": "string", "nullable": true }, "port": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" }, "server": { "maxLength": 5000, "minLength": 1, "type": "string", "nullable": true }, "subject": { "maxLength": 1000, "minLength": 1, "type": "string", "nullable": true }, "to": { "maxItems": 200, "type": "array", "items": { "type": "string" }, "nullable": true }, "username": { "maxLength": 100, "minLength": 1, "type": "string", "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "CreateEmailTaskVM": "#/components/schemas/CreateEmailTaskVM" } } }, "CreateExportReportTaskVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CreateTransformTaskBaseVM" } ], "properties": { "exportParameters": { "maxLength": 200, "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "format": { "$ref": "#/components/schemas/ExportFormat" }, "pagesCount": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "CreateExportReportTaskVM": "#/components/schemas/CreateExportReportTaskVM", "CreateExportTemplateTaskVM": "#/components/schemas/CreateExportTemplateTaskVM" } } }, "CreateExportTemplateTaskVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CreateExportReportTaskVM" } ], "properties": { "reportParameters": { "maxLength": 200, "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "CreateExportTemplateTaskVM": "#/components/schemas/CreateExportTemplateTaskVM" } } }, "CreateFTPUploadTaskVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CreateTransportTaskBaseVM" } ], "properties": { "archive": { "type": "boolean" }, "archiveName": { "type": "string", "nullable": true }, "destinationFolder": { "type": "string", "nullable": true }, "ftpHost": { "maxLength": 400, "minLength": 1, "type": "string", "nullable": true }, "ftpPassword": { "maxLength": 300, "minLength": 4, "type": "string", "nullable": true }, "ftpPort": { "type": "integer", "format": "int32" }, "ftpUsername": { "maxLength": 300, "minLength": 1, "type": "string", "nullable": true }, "useSFTP": { "type": "boolean" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "CreateFTPUploadTaskVM": "#/components/schemas/CreateFTPUploadTaskVM" } } }, "CreateFetchTaskVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CreateTaskBaseVM" } ], "properties": { "dataSourceId": { "pattern": "(^$)|(^[A-Fa-f0-9]{24}$)", "type": "string", "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "CreateFetchTaskVM": "#/components/schemas/CreateFetchTaskVM" } } }, "CreateFileShareVM": { "type": "object", "properties": { "expires": { "type": "string", "format": "date-time", "nullable": true }, "name": { "type": "string", "nullable": true }, "permission": { "$ref": "#/components/schemas/FilePermissionCRUDVM" } }, "additionalProperties": false }, "CreateGroupAdminVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CreateGroupVM" } ], "properties": { "ownerId": { "type": "string", "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "CreateGroupAdminVM": "#/components/schemas/CreateGroupAdminVM" } } }, "CreateGroupVM": { "required": [ "$t", "name" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "name": { "maxLength": 50, "minLength": 1, "type": "string" }, "subscriptionId": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string", "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "CreateGroupAdminVM": "#/components/schemas/CreateGroupAdminVM", "CreateGroupVM": "#/components/schemas/CreateGroupVM" } } }, "CreateIfNotExistInternalVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "id": { "pattern": "(^[0-9a-f]{24}$|^([0-9a-f]{8}([-][0-9a-f]{4}){3}[-][0-9a-f]{12})$)", "type": "string", "nullable": true }, "isAdmin": { "type": "boolean" }, "provider": { "type": "string", "nullable": true }, "refereshToken": { "type": "string", "nullable": true }, "accessToken": { "type": "string", "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "CreateIfNotExistInternalVM": "#/components/schemas/CreateIfNotExistInternalVM" } } }, "CreatePrepareTemplateTaskVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CreateTransformTaskBaseVM" } ], "properties": { "exports": { "maxItems": 10, "type": "array", "items": { "$ref": "#/components/schemas/CreateExportReportTaskVM" }, "nullable": true }, "pagesCount": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" }, "reportParameters": { "maxLength": 200, "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "CreatePrepareTemplateTaskVM": "#/components/schemas/CreatePrepareTemplateTaskVM" } } }, "CreateSubscriptionInviteVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "usages": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int64" }, "durable": { "type": "boolean" }, "expiredDate": { "type": "string", "format": "date-time" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "CreateSubscriptionInviteVM": "#/components/schemas/CreateSubscriptionInviteVM" } } }, "CreateSubscriptionPeriodVM": { "required": [ "$t", "planId" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "planId": { "minLength": 1, "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" }, "start": { "type": "string", "format": "date-time", "nullable": true }, "end": { "type": "string", "format": "date-time", "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "CreateSubscriptionPeriodVM": "#/components/schemas/CreateSubscriptionPeriodVM" } } }, "CreateSubscriptionPlanVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "isActive": { "type": "boolean", "nullable": true }, "displayName": { "maxLength": 50, "minLength": 1, "type": "string", "nullable": true }, "timePeriodType": { "required": [ "false" ], "allOf": [ { "$ref": "#/components/schemas/TimePeriodType" } ], "nullable": true }, "timePeriod": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32", "nullable": true }, "templatesSpaceLimit": { "minimum": 1048576, "type": "integer", "format": "int64", "nullable": true }, "reportsSpaceLimit": { "minimum": 1048576, "type": "integer", "format": "int64", "nullable": true }, "exportsSpaceLimit": { "minimum": 1048576, "type": "integer", "format": "int64", "nullable": true }, "fileUploadSizeLimit": { "maximum": 1073741824, "minimum": 0, "type": "integer", "format": "int64", "nullable": true }, "dataSourceLimit": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32", "nullable": true }, "maxUsersCount": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32", "nullable": true }, "groupLimit": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32", "nullable": true }, "onlineDesigner": { "type": "boolean", "nullable": true }, "isDemo": { "type": "boolean", "nullable": true }, "urlToBuy": { "maxLength": 1000, "minLength": 0, "type": "string", "format": "uri", "nullable": true }, "unlimitedPage": { "type": "boolean", "nullable": true }, "pageLimit": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32", "nullable": true }, "readonlyTimeLimitType": { "required": [ "false" ], "allOf": [ { "$ref": "#/components/schemas/TimePeriodType" } ], "nullable": true }, "readonlyTimeLimit": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32", "nullable": true }, "tasks": { "$ref": "#/components/schemas/TaskSettingsVM" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "CreateSubscriptionPlanVM": "#/components/schemas/CreateSubscriptionPlanVM" } } }, "CreateSubscriptionVM": { "required": [ "$t", "name", "planId", "userId" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "planId": { "minLength": 1, "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" }, "start": { "type": "string", "format": "date-time", "nullable": true }, "end": { "type": "string", "format": "date-time", "nullable": true }, "name": { "maxLength": 50, "minLength": 1, "type": "string" }, "userId": { "minLength": 1, "pattern": "(^[0-9a-f]{24}$|^([0-9a-f]{8}([-][0-9a-f]{4}){3}[-][0-9a-f]{12})$)", "type": "string" }, "tags": { "maxLength": 50, "minLength": 1, "maxItems": 5, "type": "array", "items": { "type": "string" }, "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "CreateSubscriptionVM": "#/components/schemas/CreateSubscriptionVM" } } }, "CreateTaskBaseVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "cronExpression": { "type": "string", "nullable": true }, "startsOn": { "type": "string", "format": "date-time", "nullable": true }, "ends": { "$ref": "#/components/schemas/CreateTaskEndVM" }, "name": { "maxLength": 50, "minLength": 1, "type": "string", "nullable": true }, "subscriptionId": { "pattern": "(^$)|(^[A-Fa-f0-9]{24}$)", "type": "string", "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "CreateTaskBaseVM": "#/components/schemas/CreateTaskBaseVM", "CreateTransportTaskBaseVM": "#/components/schemas/CreateTransportTaskBaseVM", "CreateEmailTaskVM": "#/components/schemas/CreateEmailTaskVM", "CreateWebhookTaskVM": "#/components/schemas/CreateWebhookTaskVM", "CreateExportReportTaskVM": "#/components/schemas/CreateExportReportTaskVM", "CreateExportTemplateTaskVM": "#/components/schemas/CreateExportTemplateTaskVM", "CreatePrepareTemplateTaskVM": "#/components/schemas/CreatePrepareTemplateTaskVM", "CreateTransformTaskBaseVM": "#/components/schemas/CreateTransformTaskBaseVM", "CreateFetchTaskVM": "#/components/schemas/CreateFetchTaskVM", "CreateThumbnailReportTaskVM": "#/components/schemas/CreateThumbnailReportTaskVM", "CreateThumbnailTemplateTaskVM": "#/components/schemas/CreateThumbnailTemplateTaskVM", "CreateFTPUploadTaskVM": "#/components/schemas/CreateFTPUploadTaskVM" } } }, "CreateTaskEndVM": { "type": "object", "properties": { "after": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32", "nullable": true }, "on": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "CreateThumbnailReportTaskVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CreateTaskBaseVM" } ], "properties": { "reportId": { "pattern": "(^$)|(^[A-Fa-f0-9]{24}$)", "type": "string", "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "CreateThumbnailReportTaskVM": "#/components/schemas/CreateThumbnailReportTaskVM" } } }, "CreateThumbnailTemplateTaskVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CreateTaskBaseVM" } ], "properties": { "templateId": { "pattern": "(^$)|(^[A-Fa-f0-9]{24}$)", "type": "string", "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "CreateThumbnailTemplateTaskVM": "#/components/schemas/CreateThumbnailTemplateTaskVM" } } }, "CreateTransformTaskBaseVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CreateTaskBaseVM" } ], "properties": { "inputFile": { "$ref": "#/components/schemas/InputFileVM" }, "locale": { "pattern": "^[a-zA-Z]{2,4}(-[a-zA-Z]{2,4}){0,2}$", "type": "string", "nullable": true }, "outputFile": { "$ref": "#/components/schemas/OutputFileVM" }, "transports": { "maxItems": 10, "type": "array", "items": { "$ref": "#/components/schemas/CreateTransportTaskBaseVM" }, "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "CreateExportReportTaskVM": "#/components/schemas/CreateExportReportTaskVM", "CreateExportTemplateTaskVM": "#/components/schemas/CreateExportTemplateTaskVM", "CreatePrepareTemplateTaskVM": "#/components/schemas/CreatePrepareTemplateTaskVM", "CreateTransformTaskBaseVM": "#/components/schemas/CreateTransformTaskBaseVM" } } }, "CreateTransportTaskBaseVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CreateTaskBaseVM" } ], "properties": { "inputFile": { "$ref": "#/components/schemas/InputFileVM" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "CreateTransportTaskBaseVM": "#/components/schemas/CreateTransportTaskBaseVM", "CreateEmailTaskVM": "#/components/schemas/CreateEmailTaskVM", "CreateWebhookTaskVM": "#/components/schemas/CreateWebhookTaskVM", "CreateFTPUploadTaskVM": "#/components/schemas/CreateFTPUploadTaskVM" } } }, "CreateWebhookTaskVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CreateTransportTaskBaseVM" } ], "properties": { "headers": { "maxLength": 100, "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "url": { "maxLength": 5000, "minLength": 1, "type": "string", "format": "uri", "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "CreateWebhookTaskVM": "#/components/schemas/CreateWebhookTaskVM" } } }, "DataSourceAdministrate": { "enum": [ 0, 1, 2, 4, 8, -1 ], "type": "integer", "format": "int32", "x-enumNames": [ "None", "Owner", "Group", "Other", "Anon", "All" ], "x-enumFlags": true, "x-typeName": "FastReport.Cloud.Enums.DataSourcesPermissionsEnums.DataSourceAdministrate" }, "DataSourceConnectionType": { "enum": [ "JSON", "MSSQL", "CSV", "XML", "MySQL", "Postgres", "OracleDB", "FirebirdDB", "MongoDB", "ClickHouse" ], "type": "string", "x-typeName": "FastReport.Cloud.Enums.DataSourceConnectionType" }, "DataSourceCreate": { "enum": [ 0, -1 ], "type": "integer", "format": "int32", "x-enumNames": [ "None", "All" ], "x-enumFlags": true, "x-typeName": "FastReport.Cloud.Enums.DataSourcesPermissionsEnums.DataSourceCreate" }, "DataSourceDelete": { "enum": [ 0, 1, -1 ], "type": "integer", "format": "int32", "x-enumNames": [ "None", "Entity", "All" ], "x-enumFlags": true, "x-typeName": "FastReport.Cloud.Enums.DataSourcesPermissionsEnums.DataSourceDelete" }, "DataSourceExecute": { "enum": [ 0, 1, -1 ], "type": "integer", "format": "int32", "x-enumNames": [ "None", "Fetch", "All" ], "x-enumFlags": true, "x-typeName": "FastReport.Cloud.Enums.DataSourcesPermissionsEnums.DataSourceExecute" }, "DataSourceGet": { "enum": [ 0, 1, 2, 4, 8, 16, -1 ], "type": "integer", "format": "int32", "x-enumNames": [ "None", "Entity", "Permission", "DataStructure", "ConnectionString", "SelectCommands", "All" ], "x-enumFlags": true, "x-typeName": "FastReport.Cloud.Enums.DataSourcesPermissionsEnums.DataSourceGet" }, "DataSourceParameterTypeVM": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "value": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "DataSourceParameterTypesVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "dataTypes": { "type": "array", "items": { "$ref": "#/components/schemas/DataSourceParameterTypeVM" }, "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "DataSourceParameterTypesVM": "#/components/schemas/DataSourceParameterTypesVM" } } }, "DataSourcePermissionCRUDVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "create": { "$ref": "#/components/schemas/DataSourceCreate" }, "delete": { "$ref": "#/components/schemas/DataSourceDelete" }, "execute": { "$ref": "#/components/schemas/DataSourceExecute" }, "get": { "$ref": "#/components/schemas/DataSourceGet" }, "update": { "$ref": "#/components/schemas/DataSourceUpdate" }, "administrate": { "$ref": "#/components/schemas/DataSourceAdministrate" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "DataSourcePermissionCRUDVM": "#/components/schemas/DataSourcePermissionCRUDVM" } } }, "DataSourcePermissionsCRUDVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "ownerId": { "pattern": "(^[0-9a-f]{24}$|^([0-9a-f]{8}([-][0-9a-f]{4}){3}[-][0-9a-f]{12})$)", "type": "string", "nullable": true }, "owner": { "$ref": "#/components/schemas/DataSourcePermissionCRUDVM" }, "groups": { "maxLength": 20, "type": "object", "additionalProperties": { "$ref": "#/components/schemas/DataSourcePermissionCRUDVM" }, "nullable": true }, "other": { "$ref": "#/components/schemas/DataSourcePermissionCRUDVM" }, "anon": { "$ref": "#/components/schemas/DataSourcePermissionCRUDVM" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "DataSourcePermissionsCRUDVM": "#/components/schemas/DataSourcePermissionsCRUDVM" } } }, "DataSourcePermissionsVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "permissions": { "$ref": "#/components/schemas/DataSourcePermissionsCRUDVM" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "DataSourcePermissionsVM": "#/components/schemas/DataSourcePermissionsVM" } } }, "DataSourceSelectCommandParameterVM": { "required": [ "$t", "dataType", "name" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "name": { "maxLength": 50, "minLength": 1, "type": "string" }, "dataType": { "maxLength": 50, "minLength": 1, "type": "string" }, "defaultValue": { "maxLength": 500, "type": "string", "nullable": true }, "size": { "type": "integer", "format": "int32" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "DataSourceSelectCommandParameterVM": "#/components/schemas/DataSourceSelectCommandParameterVM" } } }, "DataSourceSelectCommandVM": { "required": [ "$t", "command", "name" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "name": { "maxLength": 50, "minLength": 1, "type": "string" }, "command": { "maxLength": 1000, "minLength": 1, "type": "string" }, "parameters": { "maxItems": 20, "type": "array", "items": { "$ref": "#/components/schemas/DataSourceSelectCommandParameterVM" }, "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "DataSourceSelectCommandVM": "#/components/schemas/DataSourceSelectCommandVM" } } }, "DataSourceSorting": { "enum": [ "CreatedTime", "EditedTime", "Name" ], "type": "string", "x-typeName": "FastReport.Cloud.Enums.Sorting.DataSourceSorting" }, "DataSourceStatus": { "enum": [ "Connected", "Error", "Updating" ], "type": "string", "x-typeName": "FastReport.Cloud.Enums.DataSourceStatus" }, "DataSourceUpdate": { "enum": [ 0, 1, 2, 4, 8, 16, -1 ], "type": "integer", "format": "int32", "x-enumNames": [ "None", "Name", "SubscriptionId", "DataStructure", "ConnectionString", "SelectCommands", "All" ], "x-enumFlags": true, "x-typeName": "FastReport.Cloud.Enums.DataSourcesPermissionsEnums.DataSourceUpdate" }, "DataSourceVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "connectionType": { "$ref": "#/components/schemas/DataSourceConnectionType" }, "connectionString": { "type": "string", "nullable": true }, "dataStructure": { "type": "string", "nullable": true }, "subscriptionId": { "type": "string", "nullable": true }, "editedTime": { "type": "string", "format": "date-time" }, "editorUserId": { "type": "string", "nullable": true }, "createdTime": { "type": "string", "format": "date-time" }, "creatorUserId": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/DataSourceStatus" }, "errorMessage": { "type": "string", "nullable": true }, "selectCommands": { "type": "array", "items": { "$ref": "#/components/schemas/DataSourceSelectCommandVM" }, "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "DataSourceVM": "#/components/schemas/DataSourceVM" } } }, "DataSourcesVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "dataSources": { "type": "array", "items": { "$ref": "#/components/schemas/DataSourceVM" }, "nullable": true }, "count": { "type": "integer", "format": "int64" }, "skip": { "type": "integer", "format": "int32" }, "take": { "type": "integer", "format": "int32" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "DataSourcesVM": "#/components/schemas/DataSourcesVM" } } }, "DefaultPermissionsVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "filePermissions": { "$ref": "#/components/schemas/FilePermissionsCRUDVM" }, "dataSourcePermissions": { "$ref": "#/components/schemas/DataSourcePermissionsCRUDVM" }, "groupPermissions": { "$ref": "#/components/schemas/GroupPermissionsCRUDVM" }, "taskPermissions": { "$ref": "#/components/schemas/TaskPermissionsCRUDVM" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "DefaultPermissionsVM": "#/components/schemas/DefaultPermissionsVM" } } }, "DeleteApiKeyVM": { "required": [ "$t", "apiKey" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "apiKey": { "minLength": 1, "type": "string" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "DeleteApiKeyVM": "#/components/schemas/DeleteApiKeyVM" } } }, "EmailTaskVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/TransportTaskBaseVM" } ], "properties": { "body": { "maxLength": 384000, "minLength": 1, "type": "string", "nullable": true }, "enableSsl": { "type": "boolean" }, "from": { "type": "string", "format": "email", "nullable": true }, "isBodyHtml": { "type": "boolean" }, "port": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" }, "server": { "maxLength": 5000, "minLength": 1, "type": "string", "nullable": true }, "subject": { "maxLength": 1000, "minLength": 1, "type": "string", "nullable": true }, "to": { "maxItems": 200, "type": "array", "items": { "type": "string" }, "format": "email", "nullable": true }, "username": { "maxLength": 100, "minLength": 1, "type": "string", "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "EmailTaskVM": "#/components/schemas/EmailTaskVM" } } }, "EntityType": { "enum": [ "None", "Template", "TemplateFolder", "Report", "ReportFolder", "Export", "ExportFolder" ], "type": "string", "x-typeName": "FastReport.Cloud.Base.Enums.EntityType" }, "ExportCreateAdminVM": { "required": [ "$t", "ownerId", "parentId" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/ExportCreateVM" } ], "properties": { "ownerId": { "minLength": 1, "pattern": "(^[0-9a-f]{24}$|^([0-9a-f]{8}([-][0-9a-f]{4}){3}[-][0-9a-f]{12})$)", "type": "string" }, "parentId": { "minLength": 1, "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "ExportCreateAdminVM": "#/components/schemas/ExportCreateAdminVM" } } }, "ExportCreateVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/FileCreateVM" } ], "properties": { "templateId": { "pattern": "(^$)|(^[A-Fa-f0-9]{24}$)", "type": "string", "nullable": true }, "reportId": { "pattern": "(^$)|(^[A-Fa-f0-9]{24}$)", "type": "string", "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "ExportCreateVM": "#/components/schemas/ExportCreateVM", "ExportCreateAdminVM": "#/components/schemas/ExportCreateAdminVM" } } }, "ExportFolderCreateVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/FolderCreateVM" } ], "properties": { "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "ExportFolderCreateVM": "#/components/schemas/ExportFolderCreateVM" } } }, "ExportFormat": { "enum": [ "Pdf", "Html", "Mht", "Image", "Biff8", "Csv", "Dbf", "Json", "LaTeX", "Odt", "Ods", "Docx", "Pptx", "Xlsx", "Xps", "Ppml", "PS", "Richtext", "Svg", "Text", "Xaml", "Xml", "Zpl" ], "type": "string", "x-typeName": "FastReport.Cloud.Enums.ExportFormat" }, "ExportReportTaskVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/TransformTaskBaseVM" } ], "properties": { "exportParameters": { "maxLength": 200, "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "format": { "$ref": "#/components/schemas/ExportFormat" }, "pagesCount": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "ExportReportTaskVM": "#/components/schemas/ExportReportTaskVM", "ExportTemplateTaskVM": "#/components/schemas/ExportTemplateTaskVM" } } }, "ExportReportVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "fileName": { "maxLength": 250, "minLength": 0, "type": "string", "nullable": true }, "folderId": { "pattern": "(^$)|(^[A-Fa-f0-9]{24}$)", "type": "string", "nullable": true }, "locale": { "pattern": "^[a-zA-Z]{2,4}(-[a-zA-Z]{2,4}){0,2}$", "type": "string", "nullable": true }, "pagesCount": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32", "nullable": true }, "format": { "$ref": "#/components/schemas/ExportFormat" }, "exportParameters": { "maxLength": 200, "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "ExportReportVM": "#/components/schemas/ExportReportVM" } } }, "ExportTemplateTaskVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/ExportReportTaskVM" } ], "properties": { "reportParameters": { "maxLength": 200, "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "ExportTemplateTaskVM": "#/components/schemas/ExportTemplateTaskVM" } } }, "ExportTemplateVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "fileName": { "maxLength": 250, "minLength": 0, "type": "string", "nullable": true }, "folderId": { "pattern": "(^$)|(^[A-Fa-f0-9]{24}$)", "type": "string", "nullable": true }, "locale": { "pattern": "^[a-zA-Z]{2,4}(-[a-zA-Z]{2,4}){0,2}$", "type": "string", "nullable": true }, "pagesCount": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32", "nullable": true }, "format": { "$ref": "#/components/schemas/ExportFormat" }, "exportParameters": { "maxLength": 200, "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "reportParameters": { "maxLength": 200, "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "ExportTemplateVM": "#/components/schemas/ExportTemplateVM" } } }, "ExportVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/FileVM" } ], "properties": { "format": { "$ref": "#/components/schemas/ExportFormat" }, "reportId": { "type": "string", "nullable": true }, "templateId": { "type": "string", "nullable": true }, "taskId": { "type": "string", "nullable": true }, "taskMessageId": { "type": "string", "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "ExportVM": "#/components/schemas/ExportVM" } } }, "ExportsVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/FilesVMBase" } ], "properties": { "files": { "type": "array", "items": { "$ref": "#/components/schemas/ExportVM" }, "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "ExportsVM": "#/components/schemas/ExportsVM" } } }, "FTPUploadTaskVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/TransportTaskBaseVM" } ], "properties": { "archive": { "type": "boolean" }, "archiveName": { "type": "string", "nullable": true }, "destinationFolder": { "type": "string", "nullable": true }, "ftpHost": { "maxLength": 300, "minLength": 1, "type": "string", "nullable": true }, "ftpPort": { "type": "integer", "format": "int32" }, "ftpUsername": { "maxLength": 300, "minLength": 1, "type": "string", "nullable": true }, "useSFTP": { "type": "boolean" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "FTPUploadTaskVM": "#/components/schemas/FTPUploadTaskVM" } } }, "FetchTaskVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/TaskBaseVM" } ], "properties": { "dataSourceId": { "type": "string", "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "FetchTaskVM": "#/components/schemas/FetchTaskVM" } } }, "FileAdministrate": { "enum": [ 0, 1, 2, 4, 8, -1 ], "type": "integer", "format": "int32", "x-enumNames": [ "None", "Owner", "Group", "Other", "Anon", "All" ], "x-enumFlags": true, "x-typeName": "FastReport.Cloud.Enums.FilePermissionsEnums.FileAdministrate" }, "FileContentVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "content": { "type": "string", "format": "byte", "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "FileContentVM": "#/components/schemas/FileContentVM" } } }, "FileCreate": { "enum": [ 0, 1, -1 ], "type": "integer", "format": "int32", "x-enumNames": [ "None", "Entity", "All" ], "x-enumFlags": true, "x-typeName": "FastReport.Cloud.Enums.FilePermissionsEnums.FileCreate" }, "FileCreateFormVM": { "required": [ "$t", "fileContent" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "tags": { "maxLength": 50, "minLength": 1, "maxItems": 3, "type": "array", "items": { "type": "string" }, "nullable": true }, "icon": { "type": "string", "format": "binary", "nullable": true }, "fileContent": { "type": "string", "format": "binary" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "FileCreateFormVM": "#/components/schemas/FileCreateFormVM", "TemplateCreateFormVM": "#/components/schemas/TemplateCreateFormVM", "ReportCreateFormVM": "#/components/schemas/ReportCreateFormVM" } } }, "FileCreateVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "name": { "maxLength": 250, "minLength": 0, "type": "string", "nullable": true }, "tags": { "maxLength": 50, "minLength": 1, "maxItems": 3, "type": "array", "items": { "type": "string" }, "nullable": true }, "icon": { "maxLength": 65536, "type": "string", "format": "byte", "nullable": true }, "content": { "maxLength": 100000000, "type": "string", "format": "byte", "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "ExportCreateVM": "#/components/schemas/ExportCreateVM", "FileCreateVM": "#/components/schemas/FileCreateVM", "ReportCreateVM": "#/components/schemas/ReportCreateVM", "TemplateCreateVM": "#/components/schemas/TemplateCreateVM", "TemplateCreateAdminVM": "#/components/schemas/TemplateCreateAdminVM", "ReportCreateAdminVM": "#/components/schemas/ReportCreateAdminVM", "ExportCreateAdminVM": "#/components/schemas/ExportCreateAdminVM" } } }, "FileDelete": { "enum": [ 0, 1, -1 ], "type": "integer", "format": "int32", "x-enumNames": [ "None", "Entity", "All" ], "x-enumFlags": true, "x-typeName": "FastReport.Cloud.Enums.FilePermissionsEnums.FileDelete" }, "FileExecute": { "enum": [ 0, 1, 2, 4, 8, 16, -1 ], "type": "integer", "format": "int32", "x-enumNames": [ "None", "Export", "Prepare", "Design", "Thumbnail", "Preview", "All" ], "x-enumFlags": true, "x-typeName": "FastReport.Cloud.Enums.FilePermissionsEnums.FileExecute" }, "FileGet": { "enum": [ 0, 1, 2, 4, 8, 16, 32, -1 ], "type": "integer", "format": "int32", "x-enumNames": [ "None", "Entity", "Count", "Download", "Permission", "Thumbnail", "History", "All" ], "x-enumFlags": true, "x-typeName": "FastReport.Cloud.Enums.FilePermissionsEnums.FileGet" }, "FileIconVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "icon": { "type": "string", "format": "byte", "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "FileIconVM": "#/components/schemas/FileIconVM" } } }, "FileKind": { "enum": [ "Template", "Report", "Export" ], "type": "string", "x-typeName": "FastReport.Cloud.Models.Messages.FileKind" }, "FilePermissionCRUDVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "create": { "$ref": "#/components/schemas/FileCreate" }, "delete": { "$ref": "#/components/schemas/FileDelete" }, "execute": { "$ref": "#/components/schemas/FileExecute" }, "get": { "$ref": "#/components/schemas/FileGet" }, "update": { "$ref": "#/components/schemas/FileUpdate" }, "administrate": { "$ref": "#/components/schemas/FileAdministrate" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "FilePermissionCRUDVM": "#/components/schemas/FilePermissionCRUDVM" } } }, "FilePermissionsCRUDVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "ownerId": { "pattern": "(^[0-9a-f]{24}$|^([0-9a-f]{8}([-][0-9a-f]{4}){3}[-][0-9a-f]{12})$)", "type": "string", "nullable": true }, "owner": { "$ref": "#/components/schemas/FilePermissionCRUDVM" }, "groups": { "maxLength": 20, "type": "object", "additionalProperties": { "$ref": "#/components/schemas/FilePermissionCRUDVM" }, "nullable": true }, "other": { "$ref": "#/components/schemas/FilePermissionCRUDVM" }, "anon": { "$ref": "#/components/schemas/FilePermissionCRUDVM" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "FilePermissionsCRUDVM": "#/components/schemas/FilePermissionsCRUDVM" } } }, "FilePermissionsVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "permissions": { "$ref": "#/components/schemas/FilePermissionsCRUDVM" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "FilePermissionsVM": "#/components/schemas/FilePermissionsVM" } } }, "FileRenameVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "name": { "maxLength": 50, "minLength": 1, "type": "string", "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "FileRenameVM": "#/components/schemas/FileRenameVM" } } }, "FileShareVM": { "type": "object", "properties": { "expires": { "type": "string", "format": "date-time", "nullable": true }, "name": { "type": "string", "nullable": true }, "permission": { "$ref": "#/components/schemas/FilePermissionCRUDVM" }, "key": { "type": "string", "nullable": true } }, "additionalProperties": false }, "FileSharingKeysVM": { "type": "object", "properties": { "keys": { "type": "array", "items": { "$ref": "#/components/schemas/FileShareVM" }, "nullable": true } }, "additionalProperties": false }, "FileSorting": { "enum": [ "CreatedTime", "EditedTime", "Size", "Name" ], "type": "string", "x-typeName": "FastReport.Cloud.Enums.Sorting.FileSorting" }, "FileStatus": { "enum": [ "None", "InQueue", "InProcess", "Success", "Failed" ], "type": "string", "x-typeName": "FastReport.Cloud.Enums.FileStatus" }, "FileStatusReason": { "enum": [ "None", "AllRight", "Hang", "Error", "NotFound", "NotEnoughSpace", "ExportStarted", "PreparationStarted", "CrashLoop" ], "type": "string", "x-typeName": "FastReport.Cloud.Enums.FileStatusReason" }, "FileStatusUpdateInternalVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "status": { "$ref": "#/components/schemas/FileStatus" }, "reason": { "$ref": "#/components/schemas/FileStatusReason" }, "editorId": { "type": "string", "nullable": true }, "errorMessage": { "type": "string", "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "FileStatusUpdateInternalVM": "#/components/schemas/FileStatusUpdateInternalVM" } } }, "FileStatusVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "fileStatus": { "$ref": "#/components/schemas/FileStatus" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "FileStatusVM": "#/components/schemas/FileStatusVM" } } }, "FileTagsUpdateVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "tags": { "maxLength": 50, "minLength": 1, "maxItems": 3, "type": "array", "items": { "type": "string" }, "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "FileTagsUpdateVM": "#/components/schemas/FileTagsUpdateVM" } } }, "FileThumbnailUpdateInternalVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "thumbnail": { "type": "string", "format": "binary", "nullable": true }, "editorId": { "type": "string", "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "FileThumbnailUpdateInternalVM": "#/components/schemas/FileThumbnailUpdateInternalVM" } } }, "FileType": { "enum": [ "File", "Folder" ], "type": "string", "x-typeName": "FastReport.Cloud.ViewModels.Files.FileType" }, "FileUpdate": { "enum": [ 0, 1, 2, 4, 8, -1 ], "type": "integer", "format": "int32", "x-enumNames": [ "None", "Place", "Name", "Icon", "Tags", "All" ], "x-enumFlags": true, "x-typeName": "FastReport.Cloud.Enums.FilePermissionsEnums.FileUpdate" }, "FileUpdateVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "name": { "maxLength": 250, "minLength": 0, "type": "string", "nullable": true }, "parentId": { "pattern": "(^$)|(^[A-Fa-f0-9]{24}$)", "type": "string", "nullable": true }, "tags": { "maxLength": 50, "minLength": 1, "maxItems": 3, "type": "array", "items": { "type": "string" }, "nullable": true }, "icon": { "maxLength": 65536, "type": "string", "format": "byte", "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "FileUpdateVM": "#/components/schemas/FileUpdateVM" } } }, "FileVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "id": { "type": "string", "nullable": true }, "createdTime": { "type": "string", "format": "date-time" }, "creatorUserId": { "type": "string", "nullable": true }, "editedTime": { "type": "string", "format": "date-time" }, "editorUserId": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "parentId": { "type": "string", "nullable": true }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true }, "icon": { "type": "string", "format": "byte", "nullable": true }, "type": { "$ref": "#/components/schemas/FileType" }, "size": { "type": "integer", "format": "int64" }, "subscriptionId": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/FileStatus" }, "statusReason": { "$ref": "#/components/schemas/FileStatusReason" }, "errorMessage": { "type": "string", "nullable": true }, "isDeleted": { "type": "boolean" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "ExportVM": "#/components/schemas/ExportVM", "FileVM": "#/components/schemas/FileVM", "ReportVM": "#/components/schemas/ReportVM", "TemplateVM": "#/components/schemas/TemplateVM" } } }, "FilesVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/FilesVMBase" } ], "properties": { "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "FilesVM": "#/components/schemas/FilesVM" } } }, "FilesVMBase": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "files": { "type": "array", "items": { "$ref": "#/components/schemas/FileVM" }, "nullable": true }, "count": { "type": "integer", "format": "int64" }, "skip": { "type": "integer", "format": "int32" }, "take": { "type": "integer", "format": "int32" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "FilesVM": "#/components/schemas/FilesVM", "FilesVMBase": "#/components/schemas/FilesVMBase", "ReportsVM": "#/components/schemas/ReportsVM", "TemplatesVM": "#/components/schemas/TemplatesVM", "ExportsVM": "#/components/schemas/ExportsVM" } } }, "FolderCreateVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "name": { "maxLength": 250, "minLength": 1, "type": "string", "nullable": true }, "tags": { "maxLength": 50, "minLength": 1, "maxItems": 3, "type": "array", "items": { "type": "string" }, "nullable": true }, "icon": { "maxLength": 65536, "type": "string", "format": "byte", "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "AdminFolderCreateVM": "#/components/schemas/AdminFolderCreateVM", "ExportFolderCreateVM": "#/components/schemas/ExportFolderCreateVM", "FolderCreateVM": "#/components/schemas/FolderCreateVM", "ReportFolderCreateVM": "#/components/schemas/ReportFolderCreateVM", "TemplateFolderCreateVM": "#/components/schemas/TemplateFolderCreateVM", "AdminExportFolderCreateVM": "#/components/schemas/AdminExportFolderCreateVM", "AdminReportFolderCreateVM": "#/components/schemas/AdminReportFolderCreateVM", "AdminTemplateFolderCreateVM": "#/components/schemas/AdminTemplateFolderCreateVM" } } }, "FolderIconVM": { "required": [ "$t", "icon" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "icon": { "maxLength": 65536, "type": "string", "format": "byte" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "FolderIconVM": "#/components/schemas/FolderIconVM" } } }, "FolderRenameVM": { "required": [ "$t", "name" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "name": { "maxLength": 250, "minLength": 1, "type": "string" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "FolderRenameVM": "#/components/schemas/FolderRenameVM" } } }, "FolderSizeVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "size": { "type": "integer", "format": "int64" }, "realSize": { "type": "integer", "format": "int64" }, "documentsCount": { "type": "integer", "format": "int64" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "FolderSizeVM": "#/components/schemas/FolderSizeVM" } } }, "FolderTagsUpdateVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "tags": { "maxLength": 50, "minLength": 1, "maxItems": 3, "type": "array", "items": { "type": "string" }, "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "FolderTagsUpdateVM": "#/components/schemas/FolderTagsUpdateVM" } } }, "FrontendAppVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "mixins": { "$ref": "#/components/schemas/AppMixinsVM" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "FrontendAppVM": "#/components/schemas/FrontendAppVM" } } }, "GroupAdministrate": { "enum": [ 0, 1, 2, 4, 8, -1 ], "type": "integer", "format": "int32", "x-enumNames": [ "None", "Owner", "Group", "Other", "Anon", "All" ], "x-enumFlags": true, "x-typeName": "FastReport.Cloud.Enums.GroupPermissionsEnums.GroupAdministrate" }, "GroupCreate": { "enum": [ 0, 1, -1 ], "type": "integer", "format": "int32", "x-enumNames": [ "None", "User", "All" ], "x-enumFlags": true, "x-typeName": "FastReport.Cloud.Enums.GroupPermissionsEnums.GroupCreate" }, "GroupDelete": { "enum": [ 0, 1, 2, -1 ], "type": "integer", "format": "int32", "x-enumNames": [ "None", "Entity", "User", "All" ], "x-enumFlags": true, "x-typeName": "FastReport.Cloud.Enums.GroupPermissionsEnums.GroupDelete" }, "GroupExecute": { "enum": [ 0, -1 ], "type": "integer", "format": "int32", "x-enumNames": [ "None", "All" ], "x-enumFlags": true, "x-typeName": "FastReport.Cloud.Enums.GroupPermissionsEnums.GroupExecute" }, "GroupGet": { "enum": [ 0, 1, 2, 4, -1 ], "type": "integer", "format": "int32", "x-enumNames": [ "None", "Entity", "User", "Permission", "All" ], "x-enumFlags": true, "x-typeName": "FastReport.Cloud.Enums.GroupPermissionsEnums.GroupGet" }, "GroupPermissionCRUDVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "create": { "$ref": "#/components/schemas/GroupCreate" }, "delete": { "$ref": "#/components/schemas/GroupDelete" }, "execute": { "$ref": "#/components/schemas/GroupExecute" }, "get": { "$ref": "#/components/schemas/GroupGet" }, "update": { "$ref": "#/components/schemas/GroupUpdate" }, "administrate": { "$ref": "#/components/schemas/GroupAdministrate" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "GroupPermissionCRUDVM": "#/components/schemas/GroupPermissionCRUDVM" } } }, "GroupPermissionsCRUDVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "ownerId": { "pattern": "(^[0-9a-f]{24}$|^([0-9a-f]{8}([-][0-9a-f]{4}){3}[-][0-9a-f]{12})$)", "type": "string", "nullable": true }, "owner": { "$ref": "#/components/schemas/GroupPermissionCRUDVM" }, "groups": { "maxLength": 20, "type": "object", "additionalProperties": { "$ref": "#/components/schemas/GroupPermissionCRUDVM" }, "nullable": true }, "other": { "$ref": "#/components/schemas/GroupPermissionCRUDVM" }, "anon": { "$ref": "#/components/schemas/GroupPermissionCRUDVM" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "GroupPermissionsCRUDVM": "#/components/schemas/GroupPermissionsCRUDVM" } } }, "GroupPermissionsVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "permissions": { "$ref": "#/components/schemas/GroupPermissionsCRUDVM" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "GroupPermissionsVM": "#/components/schemas/GroupPermissionsVM" } } }, "GroupUpdate": { "enum": [ 0, 1, -1 ], "type": "integer", "format": "int32", "x-enumNames": [ "None", "Name", "All" ], "x-enumFlags": true, "x-typeName": "FastReport.Cloud.Enums.GroupPermissionsEnums.GroupUpdate" }, "GroupUserVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "userId": { "type": "string", "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "GroupUserVM": "#/components/schemas/GroupUserVM" } } }, "GroupUsersVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "users": { "type": "array", "items": { "$ref": "#/components/schemas/GroupUserVM" }, "nullable": true }, "count": { "type": "integer", "format": "int64" }, "take": { "type": "integer", "format": "int32" }, "skip": { "type": "integer", "format": "int32" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "GroupUsersVM": "#/components/schemas/GroupUsersVM" } } }, "GroupVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "subscriptionId": { "type": "string", "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "GroupVM": "#/components/schemas/GroupVM" } } }, "GroupsVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "groups": { "type": "array", "items": { "$ref": "#/components/schemas/GroupVM" }, "nullable": true }, "count": { "type": "integer", "format": "int64" }, "skip": { "type": "integer", "format": "int32" }, "take": { "type": "integer", "format": "int32" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "GroupsVM": "#/components/schemas/GroupsVM" } } }, "HttpValidationProblemDetails": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ProblemDetails" } ], "properties": { "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } }, "additionalProperties": { } }, "InputFileVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "entityId": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string", "nullable": true }, "type": { "$ref": "#/components/schemas/FileKind" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "InputFileVM": "#/components/schemas/InputFileVM", "RunInputFileVM": "#/components/schemas/RunInputFileVM" } } }, "InvitedUser": { "type": "object", "properties": { "userId": { "type": "string", "nullable": true }, "invitedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "MyPermissionsVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "subscription": { "$ref": "#/components/schemas/SubscriptionPermissionCRUDVM" }, "files": { "$ref": "#/components/schemas/FilePermissionCRUDVM" }, "datasources": { "$ref": "#/components/schemas/DataSourcePermissionCRUDVM" }, "groups": { "$ref": "#/components/schemas/GroupPermissionCRUDVM" }, "tasks": { "$ref": "#/components/schemas/TaskPermissionCRUDVM" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "MyPermissionsVM": "#/components/schemas/MyPermissionsVM" } } }, "OutputFileVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "fileName": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "folderId": { "pattern": "(^$)|(^[A-Fa-f0-9]{24}$)", "type": "string", "nullable": true }, "type": { "$ref": "#/components/schemas/FileKind" }, "isTemporary": { "type": "boolean" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "OutputFileVM": "#/components/schemas/OutputFileVM" } } }, "PrepareTemplateTaskVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/TransformTaskBaseVM" } ], "properties": { "exportIds": { "type": "array", "items": { "type": "string" }, "nullable": true }, "pagesCount": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" }, "reportParameters": { "maxLength": 200, "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "PrepareTemplateTaskVM": "#/components/schemas/PrepareTemplateTaskVM" } } }, "PrepareTemplateVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "name": { "maxLength": 250, "minLength": 1, "type": "string", "nullable": true }, "locale": { "pattern": "^[a-zA-Z]{2,4}(-[a-zA-Z]{2,4}){0,2}$", "type": "string", "nullable": true }, "folderId": { "pattern": "(^$)|(^[A-Fa-f0-9]{24}$)", "type": "string", "nullable": true }, "pagesCount": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32", "nullable": true }, "reportParameters": { "maxLength": 200, "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "PrepareTemplateVM": "#/components/schemas/PrepareTemplateVM" } } }, "PreviewReportVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "locale": { "pattern": "^[a-zA-Z]{2,4}(-[a-zA-Z]{2,4}){0,2}$", "type": "string", "nullable": true }, "cacheTolerance": { "type": "number", "format": "double", "default": 300 }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "PreviewReportVM": "#/components/schemas/PreviewReportVM" } } }, "PreviewTemplateVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "locale": { "pattern": "^[a-zA-Z]{2,4}(-[a-zA-Z]{2,4}){0,2}$", "type": "string", "nullable": true }, "reportParameters": { "maxLength": 200, "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "cacheTolerance": { "type": "number", "format": "double", "default": 300 }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "PreviewTemplateVM": "#/components/schemas/PreviewTemplateVM" } } }, "ProblemDetails": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true } }, "additionalProperties": { } }, "ProblemLevel": { "enum": [ "None", "Information", "Warning", "Critical" ], "type": "string", "x-typeName": "FastReport.Cloud.Base.Enums.ProblemLevel" }, "ProblemType": { "enum": [ "AnonPermissions", "UnrelatedFiles", "OtherWithoutGet", "DeadSubInUser", "EmptySub", "LostFileChunks", "WrongSubscripitonSizes", "FilesWithoutChunks", "FilesWithDeletedParents" ], "type": "string", "x-typeName": "FastReport.Cloud.Base.Enums.ProblemType" }, "ProfileVisibility": { "enum": [ 0, 1, 2, 4 ], "type": "integer", "format": "int32", "x-enumNames": [ "None", "Email", "Username", "Name" ], "x-enumFlags": true, "x-typeName": "FastReport.Cloud.Enums.ProfileVisibility" }, "RegisterUserVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "id": { "pattern": "(^[0-9a-f]{24}$|^([0-9a-f]{8}([-][0-9a-f]{4}){3}[-][0-9a-f]{12})$)", "type": "string", "nullable": true }, "subscriptions": { "maxItems": 100, "type": "array", "items": { "type": "string" }, "nullable": true }, "groups": { "maxItems": 100, "type": "array", "items": { "type": "string" }, "nullable": true }, "adminPermission": { "$ref": "#/components/schemas/AdminPermission" }, "name": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "username": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "email": { "maxLength": 250, "minLength": 0, "type": "string", "format": "email", "nullable": true }, "password": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "isAdmin": { "type": "boolean" }, "provider": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "RegisterUserVM": "#/components/schemas/RegisterUserVM" } } }, "RenameDataSourceVM": { "required": [ "$t", "name" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "name": { "maxLength": 50, "minLength": 1, "type": "string" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "RenameDataSourceVM": "#/components/schemas/RenameDataSourceVM" } } }, "RenameGroupVM": { "required": [ "$t", "name" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "name": { "maxLength": 50, "minLength": 1, "type": "string" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "RenameGroupVM": "#/components/schemas/RenameGroupVM" } } }, "RenameSubscriptionVM": { "required": [ "$t", "name" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "name": { "maxLength": 50, "minLength": 1, "type": "string" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "RenameSubscriptionVM": "#/components/schemas/RenameSubscriptionVM" } } }, "ReportCreateAdminVM": { "required": [ "$t", "ownerId", "parentId" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/ReportCreateVM" } ], "properties": { "ownerId": { "minLength": 1, "pattern": "(^[0-9a-f]{24}$|^([0-9a-f]{8}([-][0-9a-f]{4}){3}[-][0-9a-f]{12})$)", "type": "string" }, "parentId": { "minLength": 1, "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "ReportCreateAdminVM": "#/components/schemas/ReportCreateAdminVM" } } }, "ReportCreateFormVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/FileCreateFormVM" } ], "properties": { "templateId": { "pattern": "(^$)|(^[A-Fa-f0-9]{24}$)", "type": "string", "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "ReportCreateFormVM": "#/components/schemas/ReportCreateFormVM" } } }, "ReportCreateVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/FileCreateVM" } ], "properties": { "templateId": { "pattern": "(^$)|(^[A-Fa-f0-9]{24}$)", "type": "string", "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "ReportCreateVM": "#/components/schemas/ReportCreateVM", "ReportCreateAdminVM": "#/components/schemas/ReportCreateAdminVM" } } }, "ReportFolderCreateVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/FolderCreateVM" } ], "properties": { "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "ReportFolderCreateVM": "#/components/schemas/ReportFolderCreateVM" } } }, "ReportInfo": { "type": "object", "properties": { "author": { "type": "string", "nullable": true }, "created": { "type": "string", "format": "date-time" }, "creatorVersion": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "modified": { "type": "string", "format": "date-time" }, "name": { "type": "string", "nullable": true }, "picture": { "type": "string", "format": "byte", "nullable": true }, "previewPictureRatio": { "type": "number", "format": "float" }, "saveMode": { "$ref": "#/components/schemas/SaveMode" }, "savePreviewPicture": { "type": "boolean" }, "tag": { "type": "string", "nullable": true }, "version": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ReportParameter": { "required": [ "name" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string" }, "dataType": { "type": "string", "nullable": true }, "expression": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/ReportParameter" }, "nullable": true } }, "additionalProperties": false }, "ReportParametersVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/ReportParameter" }, "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "ReportParametersVM": "#/components/schemas/ReportParametersVM" } } }, "ReportVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/FileVM" } ], "properties": { "templateId": { "type": "string", "nullable": true }, "reportInfo": { "$ref": "#/components/schemas/ReportInfo" }, "taskId": { "type": "string", "nullable": true }, "taskMessageId": { "type": "string", "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "ReportVM": "#/components/schemas/ReportVM" } } }, "ReportsVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/FilesVMBase" } ], "properties": { "files": { "type": "array", "items": { "$ref": "#/components/schemas/ReportVM" }, "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "ReportsVM": "#/components/schemas/ReportsVM" } } }, "RestOfSpaceVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "restOfSpace": { "type": "integer", "format": "int64" }, "subscriptionPlan": { "$ref": "#/components/schemas/SubscriptionPlanVM" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "RestOfSpaceVM": "#/components/schemas/RestOfSpaceVM" } } }, "RunEmailTaskVM": { "required": [ "$t", "to" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/RunTransportTaskBaseVM" } ], "properties": { "body": { "maxLength": 384000, "minLength": 1, "type": "string", "nullable": true }, "enableSsl": { "type": "boolean" }, "from": { "type": "string", "format": "email", "nullable": true }, "isBodyHtml": { "type": "boolean" }, "password": { "maxLength": 300, "minLength": 5, "type": "string", "nullable": true }, "port": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" }, "server": { "maxLength": 5000, "minLength": 1, "type": "string", "nullable": true }, "subject": { "maxLength": 1000, "minLength": 1, "type": "string", "nullable": true }, "to": { "maxItems": 200, "minItems": 1, "type": "array", "items": { "type": "string" } }, "username": { "maxLength": 100, "minLength": 1, "type": "string", "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "RunEmailTaskVM": "#/components/schemas/RunEmailTaskVM" } } }, "RunExportReportTaskVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/RunTransformTaskBaseVM" } ], "properties": { "exportParameters": { "maxLength": 200, "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "format": { "$ref": "#/components/schemas/ExportFormat" }, "pagesCount": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "RunExportReportTaskVM": "#/components/schemas/RunExportReportTaskVM", "RunExportTemplateTaskVM": "#/components/schemas/RunExportTemplateTaskVM" } } }, "RunExportTemplateTaskVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/RunExportReportTaskVM" } ], "properties": { "reportParameters": { "maxLength": 200, "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "RunExportTemplateTaskVM": "#/components/schemas/RunExportTemplateTaskVM" } } }, "RunFTPUploadTaskVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/RunTransportTaskBaseVM" } ], "properties": { "archive": { "type": "boolean" }, "archiveName": { "type": "string", "nullable": true }, "destinationFolder": { "type": "string", "nullable": true }, "ftpHost": { "maxLength": 400, "minLength": 1, "type": "string", "nullable": true }, "ftpPassword": { "maxLength": 300, "minLength": 4, "type": "string", "nullable": true }, "ftpPort": { "type": "integer", "format": "int32" }, "ftpUsername": { "maxLength": 300, "minLength": 1, "type": "string", "nullable": true }, "useSFTP": { "type": "boolean" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "RunFTPUploadTaskVM": "#/components/schemas/RunFTPUploadTaskVM" } } }, "RunFetchTaskVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/RunTaskBaseVM" } ], "properties": { "dataSourceId": { "pattern": "(^$)|(^[A-Fa-f0-9]{24}$)", "type": "string", "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "RunFetchTaskVM": "#/components/schemas/RunFetchTaskVM" } } }, "RunInputFileVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/InputFileVM" } ], "properties": { "content": { "maxLength": 10000000, "type": "string", "format": "byte", "nullable": true }, "fileName": { "maxLength": 250, "minLength": 1, "type": "string", "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "RunInputFileVM": "#/components/schemas/RunInputFileVM" } } }, "RunPrepareTemplateTaskVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/RunTransformTaskBaseVM" } ], "properties": { "exports": { "maxItems": 10, "type": "array", "items": { "$ref": "#/components/schemas/RunExportReportTaskVM" }, "nullable": true }, "pagesCount": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" }, "reportParameters": { "maxLength": 200, "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "RunPrepareTemplateTaskVM": "#/components/schemas/RunPrepareTemplateTaskVM" } } }, "RunTaskBaseVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "subscriptionId": { "pattern": "(^$)|(^[A-Fa-f0-9]{24}$)", "type": "string", "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "RunTaskBaseVM": "#/components/schemas/RunTaskBaseVM", "RunTransformTaskBaseVM": "#/components/schemas/RunTransformTaskBaseVM", "RunFetchTaskVM": "#/components/schemas/RunFetchTaskVM", "RunThumbnailReportTaskVM": "#/components/schemas/RunThumbnailReportTaskVM", "RunThumbnailTemplateTaskVM": "#/components/schemas/RunThumbnailTemplateTaskVM", "RunTransportTaskBaseVM": "#/components/schemas/RunTransportTaskBaseVM", "RunEmailTaskVM": "#/components/schemas/RunEmailTaskVM", "RunWebhookTaskVM": "#/components/schemas/RunWebhookTaskVM", "RunExportReportTaskVM": "#/components/schemas/RunExportReportTaskVM", "RunExportTemplateTaskVM": "#/components/schemas/RunExportTemplateTaskVM", "RunPrepareTemplateTaskVM": "#/components/schemas/RunPrepareTemplateTaskVM", "RunFTPUploadTaskVM": "#/components/schemas/RunFTPUploadTaskVM" } } }, "RunThumbnailReportTaskVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/RunTaskBaseVM" } ], "properties": { "reportId": { "pattern": "(^$)|(^[A-Fa-f0-9]{24}$)", "type": "string", "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "RunThumbnailReportTaskVM": "#/components/schemas/RunThumbnailReportTaskVM" } } }, "RunThumbnailTemplateTaskVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/RunTaskBaseVM" } ], "properties": { "templateId": { "pattern": "(^$)|(^[A-Fa-f0-9]{24}$)", "type": "string", "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "RunThumbnailTemplateTaskVM": "#/components/schemas/RunThumbnailTemplateTaskVM" } } }, "RunTransformTaskBaseVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/RunTaskBaseVM" } ], "properties": { "inputFile": { "$ref": "#/components/schemas/RunInputFileVM" }, "locale": { "pattern": "^[a-zA-Z]{2,4}(-[a-zA-Z]{2,4}){0,2}$", "type": "string", "nullable": true }, "outputFile": { "$ref": "#/components/schemas/OutputFileVM" }, "transports": { "maxItems": 10, "type": "array", "items": { "$ref": "#/components/schemas/RunTransportTaskBaseVM" }, "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "RunTransformTaskBaseVM": "#/components/schemas/RunTransformTaskBaseVM", "RunExportReportTaskVM": "#/components/schemas/RunExportReportTaskVM", "RunExportTemplateTaskVM": "#/components/schemas/RunExportTemplateTaskVM", "RunPrepareTemplateTaskVM": "#/components/schemas/RunPrepareTemplateTaskVM" } } }, "RunTransportTaskBaseVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/RunTaskBaseVM" } ], "properties": { "inputFile": { "$ref": "#/components/schemas/RunInputFileVM" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "RunTransportTaskBaseVM": "#/components/schemas/RunTransportTaskBaseVM", "RunEmailTaskVM": "#/components/schemas/RunEmailTaskVM", "RunWebhookTaskVM": "#/components/schemas/RunWebhookTaskVM", "RunFTPUploadTaskVM": "#/components/schemas/RunFTPUploadTaskVM" } } }, "RunWebhookTaskVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/RunTransportTaskBaseVM" } ], "properties": { "headers": { "maxLength": 100, "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "url": { "maxLength": 5000, "minLength": 1, "type": "string", "format": "uri", "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "RunWebhookTaskVM": "#/components/schemas/RunWebhookTaskVM" } } }, "SaveMode": { "enum": [ "All", "Original", "User", "Role", "Security", "Deny", "Custom" ], "type": "string", "x-typeName": "FastReport.Cloud.Enums.SaveMode" }, "SelectedFilesVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "isAllSelected": { "type": "boolean" }, "folderId": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string", "nullable": true }, "searchPattern": { "type": "string", "nullable": true }, "useRegex": { "type": "boolean" }, "files": { "type": "array", "items": { "type": "string" }, "nullable": true }, "folders": { "type": "array", "items": { "type": "string" }, "nullable": true }, "path": { "type": "string", "nullable": true }, "isBin": { "type": "boolean" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "SelectedFilesVM": "#/components/schemas/SelectedFilesVM" } } }, "ServerConfigurationVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "title": { "type": "string", "nullable": true }, "companyName": { "type": "string", "nullable": true }, "logoLink": { "type": "string", "nullable": true }, "copyright": { "type": "string", "nullable": true }, "corporateServerMode": { "type": "boolean" }, "lastSLAVersion": { "type": "string", "format": "date-time", "nullable": true }, "isDisabled": { "type": "boolean" }, "frontend": { "$ref": "#/components/schemas/FrontendAppVM" }, "invariantLocale": { "type": "string", "nullable": true }, "auth": { "$ref": "#/components/schemas/AuthConfigVM" }, "designerForAnons": { "type": "boolean" }, "slaLink": { "type": "string", "nullable": true }, "firstStepsVideoLink": { "type": "string", "nullable": true }, "aboutLink": { "type": "string", "nullable": true }, "homePageLink": { "type": "string", "nullable": true }, "authServerName": { "type": "string", "nullable": true }, "updateWorkspaceLink": { "type": "string", "nullable": true }, "sharingEnabled": { "type": "boolean" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "ServerConfigurationVM": "#/components/schemas/ServerConfigurationVM" } } }, "SolvationReportVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "solvedProblems": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32", "nullable": true }, "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "SolvationReportVM": "#/components/schemas/SolvationReportVM" } } }, "SubscriptionAdministrate": { "enum": [ 0, 1, 2, 4, 8, -1 ], "type": "integer", "format": "int32", "x-enumNames": [ "None", "Owner", "Group", "Other", "Anon", "All" ], "x-enumFlags": true, "x-typeName": "FastReport.Cloud.Enums.SubscriptionPermissionsEnums.SubscriptionAdministrate" }, "SubscriptionCreate": { "enum": [ 0, 1, 2, 4, 8, 16, 32, 64, -1 ], "type": "integer", "format": "int32", "x-enumNames": [ "None", "Users", "Groups", "DataSources", "Invites", "Tasks", "RecycleBin", "Contacts", "All" ], "x-enumFlags": true, "x-typeName": "FastReport.Cloud.Enums.SubscriptionPermissionsEnums.SubscriptionCreate" }, "SubscriptionDelete": { "enum": [ 0, 1, 2, 4, 8, -1 ], "type": "integer", "format": "int32", "x-enumNames": [ "None", "Users", "Invites", "RecycleBin", "Contacts", "All" ], "x-enumFlags": true, "x-typeName": "FastReport.Cloud.Enums.SubscriptionPermissionsEnums.SubscriptionDelete" }, "SubscriptionExecute": { "enum": [ 0, 4, -1 ], "type": "integer", "format": "int32", "x-enumNames": [ "None", "Tasks", "All" ], "x-enumFlags": true, "x-typeName": "FastReport.Cloud.Enums.SubscriptionPermissionsEnums.SubscriptionExecute" }, "SubscriptionFolder": { "type": "object", "properties": { "folderId": { "type": "string", "nullable": true }, "bytesUsed": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "SubscriptionGet": { "enum": [ 0, 1, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024, -1 ], "type": "integer", "format": "int32", "x-enumNames": [ "None", "Entity", "Users", "Permission", "RootDirectory", "DataSources", "Groups", "DefaultPermissions", "Invites", "Tasks", "DeletedFiles", "Contacts", "All" ], "x-enumFlags": true, "x-typeName": "FastReport.Cloud.Enums.SubscriptionPermissionsEnums.SubscriptionGet" }, "SubscriptionInviteVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "usages": { "type": "integer", "format": "int64" }, "durable": { "type": "boolean" }, "accessToken": { "type": "string", "nullable": true }, "expiredDate": { "type": "string", "format": "date-time" }, "addedUsers": { "type": "array", "items": { "$ref": "#/components/schemas/InvitedUser" }, "nullable": true }, "creatorUserId": { "type": "string", "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "SubscriptionInviteVM": "#/components/schemas/SubscriptionInviteVM" } } }, "SubscriptionInvitesVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "invites": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInviteVM" }, "nullable": true }, "count": { "type": "integer", "format": "int64" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "SubscriptionInvitesVM": "#/components/schemas/SubscriptionInvitesVM" } } }, "SubscriptionPeriodVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "startTime": { "type": "string", "format": "date-time" }, "endTime": { "type": "string", "format": "date-time" }, "plan": { "$ref": "#/components/schemas/SubscriptionPlanVM" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "SubscriptionPeriodVM": "#/components/schemas/SubscriptionPeriodVM" } } }, "SubscriptionPermissionCRUDVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "create": { "$ref": "#/components/schemas/SubscriptionCreate" }, "delete": { "$ref": "#/components/schemas/SubscriptionDelete" }, "execute": { "$ref": "#/components/schemas/SubscriptionExecute" }, "get": { "$ref": "#/components/schemas/SubscriptionGet" }, "update": { "$ref": "#/components/schemas/SubscriptionUpdate" }, "administrate": { "$ref": "#/components/schemas/SubscriptionAdministrate" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "SubscriptionPermissionCRUDVM": "#/components/schemas/SubscriptionPermissionCRUDVM" } } }, "SubscriptionPermissionsCRUDVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "ownerId": { "pattern": "(^[0-9a-f]{24}$|^([0-9a-f]{8}([-][0-9a-f]{4}){3}[-][0-9a-f]{12})$)", "type": "string", "nullable": true }, "owner": { "$ref": "#/components/schemas/SubscriptionPermissionCRUDVM" }, "groups": { "maxLength": 20, "type": "object", "additionalProperties": { "$ref": "#/components/schemas/SubscriptionPermissionCRUDVM" }, "nullable": true }, "other": { "$ref": "#/components/schemas/SubscriptionPermissionCRUDVM" }, "anon": { "$ref": "#/components/schemas/SubscriptionPermissionCRUDVM" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "SubscriptionPermissionsCRUDVM": "#/components/schemas/SubscriptionPermissionsCRUDVM" } } }, "SubscriptionPermissionsVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "permissions": { "$ref": "#/components/schemas/SubscriptionPermissionsCRUDVM" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "SubscriptionPermissionsVM": "#/components/schemas/SubscriptionPermissionsVM" } } }, "SubscriptionPlanVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "id": { "type": "string", "nullable": true }, "isActive": { "type": "boolean", "nullable": true }, "displayName": { "type": "string", "nullable": true }, "timePeriodType": { "required": [ "false" ], "allOf": [ { "$ref": "#/components/schemas/TimePeriodType" } ], "nullable": true }, "timePeriod": { "type": "integer", "format": "int32", "nullable": true }, "readonlyTimeLimitType": { "$ref": "#/components/schemas/TimePeriodType" }, "readonlyTimeLimit": { "type": "integer", "format": "int32" }, "templatesSpaceLimit": { "type": "integer", "format": "int64", "nullable": true }, "reportsSpaceLimit": { "type": "integer", "format": "int64", "nullable": true }, "exportsSpaceLimit": { "type": "integer", "format": "int64", "nullable": true }, "fileUploadSizeLimit": { "type": "integer", "format": "int64", "nullable": true }, "dataSourceLimit": { "type": "integer", "format": "int32", "nullable": true }, "maxUsersCount": { "type": "integer", "format": "int32", "nullable": true }, "groupLimit": { "type": "integer", "format": "int32", "nullable": true }, "onlineDesigner": { "type": "boolean", "nullable": true }, "isDemo": { "type": "boolean", "nullable": true }, "urlToBuy": { "type": "string", "nullable": true }, "unlimitedPage": { "type": "boolean" }, "pageLimit": { "type": "integer", "format": "int32" }, "tasks": { "$ref": "#/components/schemas/TaskSettingsVM" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "SubscriptionPlanVM": "#/components/schemas/SubscriptionPlanVM" } } }, "SubscriptionPlansVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "subscriptionPlans": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionPlanVM" }, "nullable": true }, "count": { "type": "integer", "format": "int64" }, "skip": { "type": "integer", "format": "int32" }, "take": { "type": "integer", "format": "int32" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "SubscriptionPlansVM": "#/components/schemas/SubscriptionPlansVM" } } }, "SubscriptionUpdate": { "enum": [ 0, 1, 4, 8, 16, -1 ], "type": "integer", "format": "int32", "x-enumNames": [ "None", "Name", "DefaultPermissions", "Locale", "Contacts", "All" ], "x-enumFlags": true, "x-typeName": "FastReport.Cloud.Enums.SubscriptionPermissionsEnums.SubscriptionUpdate" }, "SubscriptionUserVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "userId": { "type": "string", "nullable": true }, "groups": { "type": "array", "items": { "$ref": "#/components/schemas/GroupVM" }, "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "SubscriptionUserVM": "#/components/schemas/SubscriptionUserVM" } } }, "SubscriptionUsersVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "users": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionUserVM" }, "nullable": true }, "count": { "type": "integer", "format": "int64" }, "take": { "type": "integer", "format": "int32" }, "skip": { "type": "integer", "format": "int32" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "SubscriptionUsersVM": "#/components/schemas/SubscriptionUsersVM" } } }, "SubscriptionVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "locale": { "type": "string", "nullable": true }, "current": { "$ref": "#/components/schemas/SubscriptionPeriodVM" }, "old": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionPeriodVM" }, "nullable": true }, "templatesFolder": { "$ref": "#/components/schemas/SubscriptionFolder" }, "reportsFolder": { "$ref": "#/components/schemas/SubscriptionFolder" }, "exportsFolder": { "$ref": "#/components/schemas/SubscriptionFolder" }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "SubscriptionVM": "#/components/schemas/SubscriptionVM", "AdminSubscriptionVM": "#/components/schemas/AdminSubscriptionVM" } } }, "SubscriptionsVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "subscriptions": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionVM" }, "nullable": true }, "count": { "type": "integer", "format": "int64" }, "skip": { "type": "integer", "format": "int32" }, "take": { "type": "integer", "format": "int32" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "SubscriptionsVM": "#/components/schemas/SubscriptionsVM" } } }, "TaskAdministrate": { "enum": [ 0, 1, 2, 4, 8, -1 ], "type": "integer", "format": "int32", "x-enumNames": [ "None", "Owner", "Group", "Other", "Anon", "All" ], "x-enumFlags": true, "x-typeName": "FastReport.Cloud.Enums.TaskPermissionsEnums.TaskAdministrate" }, "TaskBaseVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "cronExpression": { "type": "string", "nullable": true }, "startsOn": { "type": "string", "format": "date-time", "nullable": true }, "ends": { "$ref": "#/components/schemas/TaskEnd" }, "id": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string", "nullable": true }, "name": { "maxLength": 50, "minLength": 1, "type": "string", "nullable": true }, "recurrentRunTime": { "type": "string", "format": "date-time", "nullable": true }, "recurrentWasRunTime": { "type": "string", "format": "date-time", "nullable": true }, "subscriptionId": { "pattern": "(^$)|(^[A-Fa-f0-9]{24}$)", "type": "string", "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "TaskBaseVM": "#/components/schemas/TaskBaseVM", "TransformTaskBaseVM": "#/components/schemas/TransformTaskBaseVM", "TransportTaskBaseVM": "#/components/schemas/TransportTaskBaseVM", "FetchTaskVM": "#/components/schemas/FetchTaskVM", "ThumbnailReportTaskVM": "#/components/schemas/ThumbnailReportTaskVM", "ThumbnailTemplateTaskVM": "#/components/schemas/ThumbnailTemplateTaskVM", "EmailTaskVM": "#/components/schemas/EmailTaskVM", "WebhookTaskVM": "#/components/schemas/WebhookTaskVM", "ExportReportTaskVM": "#/components/schemas/ExportReportTaskVM", "ExportTemplateTaskVM": "#/components/schemas/ExportTemplateTaskVM", "PrepareTemplateTaskVM": "#/components/schemas/PrepareTemplateTaskVM", "FTPUploadTaskVM": "#/components/schemas/FTPUploadTaskVM" } } }, "TaskCreate": { "enum": [ 0, -1 ], "type": "integer", "format": "int32", "x-enumNames": [ "None", "All" ], "x-enumFlags": true, "x-typeName": "FastReport.Cloud.Enums.TaskPermissionsEnums.TaskCreate" }, "TaskDelete": { "enum": [ 0, 1, -1 ], "type": "integer", "format": "int32", "x-enumNames": [ "None", "Entity", "All" ], "x-enumFlags": true, "x-typeName": "FastReport.Cloud.Enums.TaskPermissionsEnums.TaskDelete" }, "TaskEnd": { "type": "object", "properties": { "after": { "type": "integer", "format": "int32", "nullable": true }, "on": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "TaskExecute": { "enum": [ 0, 1, -1 ], "type": "integer", "format": "int32", "x-enumNames": [ "None", "Entity", "All" ], "x-enumFlags": true, "x-typeName": "FastReport.Cloud.Enums.TaskPermissionsEnums.TaskExecute" }, "TaskGet": { "enum": [ 0, 1, 2, 4, -1 ], "type": "integer", "format": "int32", "x-enumNames": [ "None", "Entity", "Count", "Permission", "All" ], "x-enumFlags": true, "x-typeName": "FastReport.Cloud.Enums.TaskPermissionsEnums.TaskGet" }, "TaskIdsVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "count": { "type": "integer", "format": "int64" }, "ids": { "type": "array", "items": { "type": "string" }, "nullable": true }, "skip": { "type": "integer", "format": "int32" }, "take": { "type": "integer", "format": "int32" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "TaskIdsVM": "#/components/schemas/TaskIdsVM" } } }, "TaskMessageIdVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "messageId": { "type": "string", "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "TaskMessageIdVM": "#/components/schemas/TaskMessageIdVM" } } }, "TaskPermissionCRUDVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "create": { "$ref": "#/components/schemas/TaskCreate" }, "delete": { "$ref": "#/components/schemas/TaskDelete" }, "execute": { "$ref": "#/components/schemas/TaskExecute" }, "get": { "$ref": "#/components/schemas/TaskGet" }, "update": { "$ref": "#/components/schemas/TaskUpdate" }, "administrate": { "$ref": "#/components/schemas/TaskAdministrate" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "TaskPermissionCRUDVM": "#/components/schemas/TaskPermissionCRUDVM" } } }, "TaskPermissionsCRUDVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "ownerId": { "pattern": "(^[0-9a-f]{24}$|^([0-9a-f]{8}([-][0-9a-f]{4}){3}[-][0-9a-f]{12})$)", "type": "string", "nullable": true }, "owner": { "$ref": "#/components/schemas/TaskPermissionCRUDVM" }, "groups": { "maxLength": 20, "type": "object", "additionalProperties": { "$ref": "#/components/schemas/TaskPermissionCRUDVM" }, "nullable": true }, "other": { "$ref": "#/components/schemas/TaskPermissionCRUDVM" }, "anon": { "$ref": "#/components/schemas/TaskPermissionCRUDVM" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "TaskPermissionsCRUDVM": "#/components/schemas/TaskPermissionsCRUDVM" } } }, "TaskPermissionsVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "permissions": { "$ref": "#/components/schemas/TaskPermissionsCRUDVM" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "TaskPermissionsVM": "#/components/schemas/TaskPermissionsVM" } } }, "TaskSettingsVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "prepare": { "type": "boolean", "nullable": true }, "exportTemplate": { "type": "boolean", "nullable": true }, "exportReport": { "type": "boolean", "nullable": true }, "sendViaEmail": { "type": "boolean", "nullable": true }, "uploadToFTP": { "type": "boolean", "nullable": true }, "sendViaWebhook": { "type": "boolean", "nullable": true }, "fetchData": { "type": "boolean", "nullable": true }, "thumbnailReport": { "type": "boolean", "nullable": true }, "thumbnailTemplate": { "type": "boolean", "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "TaskSettingsVM": "#/components/schemas/TaskSettingsVM" } } }, "TaskUpdate": { "enum": [ 0, 1, 2, -1 ], "type": "integer", "format": "int32", "x-enumNames": [ "None", "Name", "Entity", "All" ], "x-enumFlags": true, "x-typeName": "FastReport.Cloud.Enums.TaskPermissionsEnums.TaskUpdate" }, "TasksVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "count": { "type": "integer", "format": "int64" }, "skip": { "type": "integer", "format": "int32" }, "take": { "type": "integer", "format": "int32" }, "tasks": { "type": "array", "items": { "$ref": "#/components/schemas/TaskBaseVM" }, "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "TasksVM": "#/components/schemas/TasksVM" } } }, "TemplateContentVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "content": { "type": "string", "format": "byte", "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "TemplateContentVM": "#/components/schemas/TemplateContentVM" } } }, "TemplateCreateAdminVM": { "required": [ "$t", "ownerId", "parentId" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/TemplateCreateVM" } ], "properties": { "ownerId": { "minLength": 1, "pattern": "(^[0-9a-f]{24}$|^([0-9a-f]{8}([-][0-9a-f]{4}){3}[-][0-9a-f]{12})$)", "type": "string" }, "parentId": { "minLength": 1, "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "TemplateCreateAdminVM": "#/components/schemas/TemplateCreateAdminVM" } } }, "TemplateCreateFormVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/FileCreateFormVM" } ], "properties": { "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "TemplateCreateFormVM": "#/components/schemas/TemplateCreateFormVM" } } }, "TemplateCreateVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/FileCreateVM" } ], "properties": { "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "TemplateCreateVM": "#/components/schemas/TemplateCreateVM", "TemplateCreateAdminVM": "#/components/schemas/TemplateCreateAdminVM" } } }, "TemplateFolderCreateVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/FolderCreateVM" } ], "properties": { "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "TemplateFolderCreateVM": "#/components/schemas/TemplateFolderCreateVM" } } }, "TemplateVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/FileVM" } ], "properties": { "reportInfo": { "$ref": "#/components/schemas/ReportInfo" }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/ReportParameter" }, "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "TemplateVM": "#/components/schemas/TemplateVM" } } }, "TemplatesVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/FilesVMBase" } ], "properties": { "files": { "type": "array", "items": { "$ref": "#/components/schemas/TemplateVM" }, "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "TemplatesVM": "#/components/schemas/TemplatesVM" } } }, "ThumbnailReportTaskVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/TaskBaseVM" } ], "properties": { "reportId": { "type": "string", "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "ThumbnailReportTaskVM": "#/components/schemas/ThumbnailReportTaskVM" } } }, "ThumbnailTemplateTaskVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/TaskBaseVM" } ], "properties": { "templateId": { "type": "string", "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "ThumbnailTemplateTaskVM": "#/components/schemas/ThumbnailTemplateTaskVM" } } }, "TimePeriodType": { "enum": [ "Second", "Minute", "Hour", "Day", "Week", "Month", "Year" ], "type": "string", "x-typeName": "FastReport.Cloud.Enums.TimePeriodType" }, "TransformTaskBaseVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/TaskBaseVM" } ], "properties": { "inputFile": { "$ref": "#/components/schemas/InputFileVM" }, "locale": { "pattern": "^[a-zA-Z]{2,4}(-[a-zA-Z]{2,4}){0,2}$", "type": "string", "nullable": true }, "outputFile": { "$ref": "#/components/schemas/OutputFileVM" }, "transportIds": { "type": "array", "items": { "type": "string" }, "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "TransformTaskBaseVM": "#/components/schemas/TransformTaskBaseVM", "ExportReportTaskVM": "#/components/schemas/ExportReportTaskVM", "ExportTemplateTaskVM": "#/components/schemas/ExportTemplateTaskVM", "PrepareTemplateTaskVM": "#/components/schemas/PrepareTemplateTaskVM" } } }, "TransportTaskBaseVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/TaskBaseVM" } ], "properties": { "inputFile": { "$ref": "#/components/schemas/InputFileVM" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "TransportTaskBaseVM": "#/components/schemas/TransportTaskBaseVM", "EmailTaskVM": "#/components/schemas/EmailTaskVM", "WebhookTaskVM": "#/components/schemas/WebhookTaskVM", "FTPUploadTaskVM": "#/components/schemas/FTPUploadTaskVM" } } }, "UpdateContactGroupVM": { "required": [ "name" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string" }, "subscriptionId": { "pattern": "(^$)|(^[A-Fa-f0-9]{24}$)", "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdateContactVM": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "groups": { "maxItems": 10, "type": "array", "items": { "type": "string" }, "nullable": true }, "subscriptionId": { "pattern": "(^$)|(^[A-Fa-f0-9]{24}$)", "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdateContentInternalVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "editorId": { "type": "string", "nullable": true }, "fileContent": { "type": "string", "format": "binary", "nullable": true }, "thumbnail": { "type": "string", "format": "binary", "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "UpdateContentInternalVM": "#/components/schemas/UpdateContentInternalVM" } } }, "UpdateDataSourceConnectionStringVM": { "required": [ "$t", "connectionString" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "connectionString": { "maxLength": 5000, "minLength": 0, "type": "string" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "UpdateDataSourceConnectionStringVM": "#/components/schemas/UpdateDataSourceConnectionStringVM" } } }, "UpdateDataSourcePermissionsVM": { "required": [ "$t", "administrate", "newPermissions" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "newPermissions": { "$ref": "#/components/schemas/DataSourcePermissionsCRUDVM" }, "administrate": { "$ref": "#/components/schemas/DataSourceAdministrate" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "UpdateDataSourcePermissionsVM": "#/components/schemas/UpdateDataSourcePermissionsVM" } } }, "UpdateDataSourceSelectCommandsVM": { "required": [ "$t", "selectCommands" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "selectCommands": { "maxItems": 10, "type": "array", "items": { "$ref": "#/components/schemas/DataSourceSelectCommandVM" } }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "UpdateDataSourceSelectCommandsVM": "#/components/schemas/UpdateDataSourceSelectCommandsVM" } } }, "UpdateDataSourceSubscriptionVM": { "required": [ "$t", "subscriptionId" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "subscriptionId": { "minLength": 1, "pattern": "^[A-Fa-f0-9]{24}$", "type": "string" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "UpdateDataSourceSubscriptionVM": "#/components/schemas/UpdateDataSourceSubscriptionVM" } } }, "UpdateDataSourceVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "name": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "subscriptionId": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string", "nullable": true }, "connectionString": { "maxLength": 5000, "minLength": 0, "type": "string", "nullable": true }, "selectCommands": { "maxItems": 10, "type": "array", "items": { "$ref": "#/components/schemas/DataSourceSelectCommandVM" }, "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "UpdateDataSourceVM": "#/components/schemas/UpdateDataSourceVM" } } }, "UpdateDataVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "newData": { "type": "string", "nullable": true }, "editorId": { "type": "string", "nullable": true }, "errorMessage": { "type": "string", "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "UpdateDataVM": "#/components/schemas/UpdateDataVM" } } }, "UpdateDefaultPermissionsVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "filePermissions": { "$ref": "#/components/schemas/UpdateFilePermissionsVM" }, "groupPermissions": { "$ref": "#/components/schemas/UpdateGroupPermissionsVM" }, "dataSourcePermissions": { "$ref": "#/components/schemas/UpdateDataSourcePermissionsVM" }, "taskPermissions": { "$ref": "#/components/schemas/UpdateTaskPermissionsVM" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "UpdateDefaultPermissionsVM": "#/components/schemas/UpdateDefaultPermissionsVM" } } }, "UpdateEmailTaskVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/UpdateTransportTaskBaseVM" } ], "properties": { "body": { "maxLength": 384000, "minLength": 0, "type": "string", "nullable": true }, "enableSsl": { "type": "boolean", "nullable": true }, "from": { "type": "string", "format": "email", "nullable": true }, "isBodyHtml": { "type": "boolean", "nullable": true }, "password": { "maxLength": 300, "minLength": 5, "type": "string", "nullable": true }, "port": { "type": "integer", "format": "int32", "nullable": true }, "server": { "maxLength": 5000, "minLength": 1, "type": "string", "nullable": true }, "subject": { "maxLength": 1000, "minLength": 0, "type": "string", "nullable": true }, "to": { "maxItems": 200, "type": "array", "items": { "type": "string" }, "nullable": true }, "username": { "maxLength": 100, "minLength": 1, "type": "string", "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "UpdateEmailTaskVM": "#/components/schemas/UpdateEmailTaskVM" } } }, "UpdateExportReportTaskVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/UpdateTransformTaskBaseVM" } ], "properties": { "exportParameters": { "maxLength": 200, "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "format": { "required": [ "false" ], "allOf": [ { "$ref": "#/components/schemas/ExportFormat" } ], "nullable": true }, "pagesCount": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32", "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "UpdateExportReportTaskVM": "#/components/schemas/UpdateExportReportTaskVM", "UpdateExportTemplateTaskVM": "#/components/schemas/UpdateExportTemplateTaskVM" } } }, "UpdateExportTemplateTaskVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/UpdateExportReportTaskVM" } ], "properties": { "reportParameters": { "maxLength": 200, "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "UpdateExportTemplateTaskVM": "#/components/schemas/UpdateExportTemplateTaskVM" } } }, "UpdateFTPUploadTaskVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/UpdateTransportTaskBaseVM" } ], "properties": { "archive": { "type": "boolean", "nullable": true }, "archiveName": { "type": "string", "nullable": true }, "destinationFolder": { "type": "string", "nullable": true }, "ftpHost": { "maxLength": 400, "minLength": 1, "type": "string", "nullable": true }, "ftpPassword": { "maxLength": 300, "minLength": 4, "type": "string", "nullable": true }, "ftpPort": { "type": "integer", "format": "int32", "nullable": true }, "ftpUsername": { "maxLength": 300, "minLength": 1, "type": "string", "nullable": true }, "useSFTP": { "type": "boolean", "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "UpdateFTPUploadTaskVM": "#/components/schemas/UpdateFTPUploadTaskVM" } } }, "UpdateFetchTaskVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/UpdateTaskBaseVM" } ], "properties": { "dataSourceId": { "pattern": "(^$)|(^[A-Fa-f0-9]{24}$)", "type": "string", "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "UpdateFetchTaskVM": "#/components/schemas/UpdateFetchTaskVM" } } }, "UpdateFileContentFormVM": { "required": [ "$t", "fileContent" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "fileContent": { "type": "string", "format": "binary" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "UpdateFileContentFormVM": "#/components/schemas/UpdateFileContentFormVM" } } }, "UpdateFileContentInternalVM": { "required": [ "$t", "fileContent" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "fileContent": { "type": "string", "format": "binary" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "UpdateFileContentInternalVM": "#/components/schemas/UpdateFileContentInternalVM" } } }, "UpdateFileContentVM": { "required": [ "$t", "content" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "content": { "maxLength": 10000000, "type": "string", "format": "byte" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "UpdateFileContentVM": "#/components/schemas/UpdateFileContentVM" } } }, "UpdateFilePermissionsVM": { "required": [ "$t", "administrate", "newPermissions" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "newPermissions": { "$ref": "#/components/schemas/FilePermissionsCRUDVM" }, "administrate": { "$ref": "#/components/schemas/FileAdministrate" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "UpdateFilePermissionsVM": "#/components/schemas/UpdateFilePermissionsVM" } } }, "UpdateGroupPermissionsVM": { "required": [ "$t", "administrate", "newPermissions" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "newPermissions": { "$ref": "#/components/schemas/GroupPermissionsCRUDVM" }, "administrate": { "$ref": "#/components/schemas/GroupAdministrate" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "UpdateGroupPermissionsVM": "#/components/schemas/UpdateGroupPermissionsVM" } } }, "UpdateGroupVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "name": { "maxLength": 50, "minLength": 1, "type": "string", "nullable": true }, "subscriptionId": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string", "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "UpdateGroupVM": "#/components/schemas/UpdateGroupVM" } } }, "UpdatePrepareTemplateTaskVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/UpdateTransformTaskBaseVM" } ], "properties": { "exportIds": { "maxItems": 10, "type": "array", "items": { "type": "string" }, "nullable": true }, "pagesCount": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32", "nullable": true }, "reportParameters": { "maxLength": 200, "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "UpdatePrepareTemplateTaskVM": "#/components/schemas/UpdatePrepareTemplateTaskVM" } } }, "UpdateSubscriptionLocaleVM": { "required": [ "$t", "locale" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "locale": { "minLength": 1, "pattern": "^[a-zA-Z]{2,4}(-[a-zA-Z]{2,4}){0,2}$", "type": "string" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "UpdateSubscriptionLocaleVM": "#/components/schemas/UpdateSubscriptionLocaleVM" } } }, "UpdateSubscriptionPermissionsVM": { "required": [ "$t", "administrate", "newPermissions" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "newPermissions": { "$ref": "#/components/schemas/SubscriptionPermissionsCRUDVM" }, "administrate": { "$ref": "#/components/schemas/SubscriptionAdministrate" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "UpdateSubscriptionPermissionsVM": "#/components/schemas/UpdateSubscriptionPermissionsVM" } } }, "UpdateSubscriptionPlanVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "isActive": { "type": "boolean", "nullable": true }, "displayName": { "maxLength": 50, "minLength": 1, "type": "string", "nullable": true }, "timePeriodType": { "required": [ "false" ], "allOf": [ { "$ref": "#/components/schemas/TimePeriodType" } ], "nullable": true }, "timePeriod": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32", "nullable": true }, "templatesSpaceLimit": { "minimum": 1048576, "type": "integer", "format": "int64", "nullable": true }, "reportsSpaceLimit": { "minimum": 1048576, "type": "integer", "format": "int64", "nullable": true }, "exportsSpaceLimit": { "minimum": 1048576, "type": "integer", "format": "int64", "nullable": true }, "fileUploadSizeLimit": { "maximum": 1073741824, "minimum": 0, "type": "integer", "format": "int64", "nullable": true }, "dataSourceLimit": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32", "nullable": true }, "maxUsersCount": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32", "nullable": true }, "groupLimit": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32", "nullable": true }, "onlineDesigner": { "type": "boolean", "nullable": true }, "isDemo": { "type": "boolean", "nullable": true }, "urlToBuy": { "maxLength": 1000, "minLength": 0, "type": "string", "format": "uri", "nullable": true }, "unlimitedPage": { "type": "boolean", "nullable": true }, "pageLimit": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32", "nullable": true }, "readonlyTimeLimitType": { "required": [ "false" ], "allOf": [ { "$ref": "#/components/schemas/TimePeriodType" } ], "nullable": true }, "readonlyTimeLimit": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32", "nullable": true }, "tasks": { "$ref": "#/components/schemas/TaskSettingsVM" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "UpdateSubscriptionPlanVM": "#/components/schemas/UpdateSubscriptionPlanVM" } } }, "UpdateSubscriptionVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "name": { "maxLength": 50, "minLength": 1, "type": "string", "nullable": true }, "locale": { "pattern": "^[a-zA-Z]{2,4}(-[a-zA-Z]{2,4}){0,2}$", "type": "string", "nullable": true }, "tags": { "maxLength": 50, "minLength": 1, "maxItems": 5, "type": "array", "items": { "type": "string" }, "nullable": true }, "defaultPermissions": { "$ref": "#/components/schemas/DefaultPermissionsVM" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "UpdateSubscriptionVM": "#/components/schemas/UpdateSubscriptionVM" } } }, "UpdateTaskBaseVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "cronExpression": { "type": "string", "nullable": true }, "startsOn": { "type": "string", "format": "date-time", "nullable": true }, "ends": { "$ref": "#/components/schemas/CreateTaskEndVM" }, "name": { "maxLength": 50, "minLength": 1, "type": "string", "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "UpdateTaskBaseVM": "#/components/schemas/UpdateTaskBaseVM", "UpdateFetchTaskVM": "#/components/schemas/UpdateFetchTaskVM", "UpdateThumbnailReportTaskVM": "#/components/schemas/UpdateThumbnailReportTaskVM", "UpdateThumbnailTemplateTaskVM": "#/components/schemas/UpdateThumbnailTemplateTaskVM", "UpdateTransportTaskBaseVM": "#/components/schemas/UpdateTransportTaskBaseVM", "UpdateEmailTaskVM": "#/components/schemas/UpdateEmailTaskVM", "UpdateWebhookTaskVM": "#/components/schemas/UpdateWebhookTaskVM", "UpdateExportReportTaskVM": "#/components/schemas/UpdateExportReportTaskVM", "UpdateExportTemplateTaskVM": "#/components/schemas/UpdateExportTemplateTaskVM", "UpdatePrepareTemplateTaskVM": "#/components/schemas/UpdatePrepareTemplateTaskVM", "UpdateTransformTaskBaseVM": "#/components/schemas/UpdateTransformTaskBaseVM", "UpdateFTPUploadTaskVM": "#/components/schemas/UpdateFTPUploadTaskVM" } } }, "UpdateTaskPermissionsVM": { "required": [ "$t", "administrate", "newPermissions" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "administrate": { "$ref": "#/components/schemas/TaskAdministrate" }, "newPermissions": { "$ref": "#/components/schemas/TaskPermissionsCRUDVM" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "UpdateTaskPermissionsVM": "#/components/schemas/UpdateTaskPermissionsVM" } } }, "UpdateThumbnailReportTaskVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/UpdateTaskBaseVM" } ], "properties": { "reportId": { "pattern": "(^$)|(^[A-Fa-f0-9]{24}$)", "type": "string", "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "UpdateThumbnailReportTaskVM": "#/components/schemas/UpdateThumbnailReportTaskVM" } } }, "UpdateThumbnailTemplateTaskVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/UpdateTaskBaseVM" } ], "properties": { "templateId": { "pattern": "(^$)|(^[A-Fa-f0-9]{24}$)", "type": "string", "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "UpdateThumbnailTemplateTaskVM": "#/components/schemas/UpdateThumbnailTemplateTaskVM" } } }, "UpdateTransformTaskBaseVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/UpdateTaskBaseVM" } ], "properties": { "inputFile": { "$ref": "#/components/schemas/InputFileVM" }, "locale": { "pattern": "^[a-zA-Z]{2,4}(-[a-zA-Z]{2,4}){0,2}$", "type": "string", "nullable": true }, "outputFile": { "$ref": "#/components/schemas/OutputFileVM" }, "transportIds": { "maxItems": 10, "type": "array", "items": { "type": "string" }, "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "UpdateExportReportTaskVM": "#/components/schemas/UpdateExportReportTaskVM", "UpdateExportTemplateTaskVM": "#/components/schemas/UpdateExportTemplateTaskVM", "UpdatePrepareTemplateTaskVM": "#/components/schemas/UpdatePrepareTemplateTaskVM", "UpdateTransformTaskBaseVM": "#/components/schemas/UpdateTransformTaskBaseVM" } } }, "UpdateTransportTaskBaseVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/UpdateTaskBaseVM" } ], "properties": { "inputFile": { "$ref": "#/components/schemas/InputFileVM" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "UpdateTransportTaskBaseVM": "#/components/schemas/UpdateTransportTaskBaseVM", "UpdateEmailTaskVM": "#/components/schemas/UpdateEmailTaskVM", "UpdateWebhookTaskVM": "#/components/schemas/UpdateWebhookTaskVM", "UpdateFTPUploadTaskVM": "#/components/schemas/UpdateFTPUploadTaskVM" } } }, "UpdateUserProfileVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "name": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "username": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "email": { "maxLength": 250, "minLength": 0, "type": "string", "format": "email", "nullable": true }, "passwordNew": { "maxLength": 255, "minLength": 5, "type": "string", "nullable": true }, "passwordNew2": { "maxLength": 255, "minLength": 5, "type": "string", "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "UpdateUserProfileVM": "#/components/schemas/UpdateUserProfileVM" } } }, "UpdateUserSettingsVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "profileVisibility": { "required": [ "false" ], "allOf": [ { "$ref": "#/components/schemas/ProfileVisibility" } ], "nullable": true }, "defaultSubscription": { "pattern": "(^$)|(^[A-Fa-f0-9]{24}$)", "type": "string", "nullable": true }, "showHiddenFilesAndFolders": { "type": "boolean", "nullable": true }, "subscribedNotifications": { "type": "array", "items": { "$ref": "#/components/schemas/AuditType" }, "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "UpdateUserSettingsVM": "#/components/schemas/UpdateUserSettingsVM" } } }, "UpdateUserVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "adminPermission": { "$ref": "#/components/schemas/AdminPermission" }, "email": { "maxLength": 250, "minLength": 0, "type": "string", "format": "email", "nullable": true }, "groups": { "maxItems": 100, "type": "array", "items": { "type": "string" }, "nullable": true }, "isAdmin": { "type": "boolean", "nullable": true }, "name": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "password": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "provider": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "subscriptions": { "maxItems": 100, "type": "array", "items": { "type": "string" }, "nullable": true }, "username": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "UpdateUserVM": "#/components/schemas/UpdateUserVM" } } }, "UpdateWebhookTaskVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/UpdateTransportTaskBaseVM" } ], "properties": { "headers": { "maxLength": 100, "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "url": { "maxLength": 5000, "minLength": 1, "type": "string", "format": "uri", "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "UpdateWebhookTaskVM": "#/components/schemas/UpdateWebhookTaskVM" } } }, "UserIsAdminVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "value": { "type": "boolean" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "UserIsAdminVM": "#/components/schemas/UserIsAdminVM" } } }, "UserProfileVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "username": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "isReadOnly": { "type": "boolean" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "UserProfileVM": "#/components/schemas/UserProfileVM" } } }, "UserResultVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "isAuthenticated": { "type": "boolean" }, "id": { "type": "string", "nullable": true }, "isAdmin": { "type": "boolean" }, "adminPermission": { "$ref": "#/components/schemas/AdminPermission" }, "subscriptions": { "type": "array", "items": { "type": "string" }, "nullable": true }, "groups": { "type": "array", "items": { "type": "string" }, "nullable": true }, "provider": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "username": { "type": "string", "nullable": true }, "settings": { "$ref": "#/components/schemas/UserSettingsVM" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "UserResultVM": "#/components/schemas/UserResultVM" } } }, "UserSettingsVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "profileVisibility": { "$ref": "#/components/schemas/ProfileVisibility" }, "defaultSubscription": { "pattern": "^[A-Fa-f0-9]{24}$", "type": "string", "nullable": true }, "showHiddenFilesAndFolders": { "type": "boolean" }, "slaAcceptedDateTime": { "type": "string", "format": "date-time", "nullable": true }, "subscribedNotifications": { "type": "array", "items": { "$ref": "#/components/schemas/AuditType" }, "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "UserSettingsVM": "#/components/schemas/UserSettingsVM" } } }, "UserVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "id": { "type": "string", "nullable": true }, "subscriptions": { "type": "array", "items": { "type": "string" }, "nullable": true }, "groups": { "type": "array", "items": { "type": "string" }, "nullable": true }, "adminPermission": { "$ref": "#/components/schemas/AdminPermission" }, "isAdmin": { "type": "boolean" }, "name": { "type": "string", "nullable": true }, "username": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "createdTime": { "type": "string", "format": "date-time" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "UserVM": "#/components/schemas/UserVM" } } }, "UsersVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CloudBaseVM" } ], "properties": { "users": { "type": "array", "items": { "$ref": "#/components/schemas/UserVM" }, "nullable": true }, "count": { "type": "integer", "format": "int64" }, "skip": { "type": "integer", "format": "int32" }, "take": { "type": "integer", "format": "int32" }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "UsersVM": "#/components/schemas/UsersVM" } } }, "WebhookTaskVM": { "required": [ "$t" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/TransportTaskBaseVM" } ], "properties": { "headers": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "url": { "maxLength": 5000, "minLength": 1, "type": "string", "format": "uri", "nullable": true }, "$t": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$t", "mapping": { "WebhookTaskVM": "#/components/schemas/WebhookTaskVM" } } } }, "securitySchemes": { "JWT": { "type": "http", "description": "JWT Authorization header using the Bearer scheme. Example: \"Authorization: Bearer {token}\"", "scheme": "bearer", "bearerFormat": "JWT" }, "ApiKey": { "type": "http", "description": "Put `apikey` in user name and apikey value in the password", "scheme": "basic" } } }, "security": [ { "JWT": [ ], "ApiKey": [ ] } ] }