Back to Website
Show / Hide Table of Contents

Asset Storage API

This API is used to manipulate assets in a storage - list them, update, delete, organize in folders, etc.

You may think of it as an abstraction of a file system. The assets (such as designs, fonts, images, etc) are similar to files, they can be organized in folders, you can perform the CRUD operations on them.

Note, on practice you won't want to create files using this API. The reason is that you are usually need not just to put a file to the system, but also get its metadata and a preview image. So to upload anything to the storage, we recommend using the import operation of the Asset Processor API service.

Api Clients

.Net Client

You can install it from Nuget as follows:

Install-Package Aurigma.AssetStorage.ApiClient

See on Nuget

Angular Client

This client is compatible with Angular applications only. It won't work with NodeJS or other frontend JS frameworks. You can install the package to your Angular application as follows:

npm install @aurigma/ng-asset-storage-client

See on npm

NodeJS Client (Axious)

This client can be used in a wide range of JavaScript applications. To make API calls, it uses Axios - a popular HTTP library. Although it is possible to use it in both frontend and backend projects, the primary target platform for this library is NodeJS.

Install the package as follows:

npm install @aurigma/axios-asset-storage-api-client

See on npm

PHP Client

PHP client can be installed through composer as follows:

composer require aurigma/php-asset-storage-client

See on Packagist

Artifacts

These endpoints are used to manage tenant artifacts.

GetAll

Returns all entities relevant to specified query parameters.

Request
GET /api/storage/v1/artifacts[?group&alias&type&skip&take&sorting&search&customFields&tenantId]
Parameters
Name In Type Default Notes
group query

Artifact group filter

alias query

Artifact alias(special name within group) filter

type query

Artifact type filter

skip query

Defines page start offset from beginning of sorted result list

take query

Defines page length (how much consequent items of sorted result list should be taken)

sorting query

Defines sorting order of result list e.g.: "Title ASC, LastModified DESC"

search query

Search string for partial match

customFields query

Custom attributes dictionary filter. For example: {"public":"true","name":"my item"}

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 PagedOfArtifactDto

Success

401

Unauthorized

403

Forbidden

Create

Creates a new entity.

Request
POST /api/storage/v1/artifacts[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

file formData

Entity file content.

description formData

Artifact description.

group formData

Artifact group.

alias formData

Artifact alias (special name within group).

type formData

Artifact type.

format formData

Artifact file format.

anonymousAccess formData

Artifact 'anonymous access' tag. It indicates whether artifact can be accessed anonymously.

*name formData

Entity name

customFields formData

Entity custom attributes

Responses
Status Code Type Description Samples
201 ArtifactDto

Success

409 NameConflictDto

Conflict

401

Unauthorized

403

Forbidden

Get

Returns an entity by ID.

Request
GET /api/storage/v1/artifacts/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Entity identifier.

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 ArtifactDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

Update

Updates the specified entity.

Request
PUT /api/storage/v1/artifacts/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Entity identifier.

tenantId query

Tenant identifier

file formData

Entity file content.

description formData

Artifact description.

alias formData

Artifact alias (special name within group).

type formData

Artifact type.

format formData

Artifact file format.

anonymousAccess formData

Artifact 'anonymous access' tag. It indicates whether artifact can be accessed anonymously.

name formData

Entity name

customFields formData

Entity custom attributes

Responses
Status Code Type Description Samples
200 ArtifactDto

Success

404 ProblemDetails

Not Found

409 NameConflictDto

Conflict

401

Unauthorized

403

Forbidden

Delete

Deletes the specified entity.

Request
DELETE /api/storage/v1/artifacts/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Entity identifier.

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 ArtifactDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

GetFile

Returns an entity file from file storage.

Request
GET /api/storage/v1/artifacts/{id}/file[?attachment&tenantId]
Parameters
Name In Type Default Notes
*id path

Entity identifier.

attachment query

Indicates if file should be provided as an attachment with proper filename supplied (default value is 'false').

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 string

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

GetFileStorageInfo

Returns information about storage usage by artifact files.

Request
GET /api/storage/v1/artifacts/file-storage-info[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 FileStorageInfoDto

Success

401

Unauthorized

403

Forbidden

DeleteGroup

Deletes all entities with specified group.

Request
DELETE /api/storage/v1/artifacts/group/{group}[?tenantId]
Parameters
Name In Type Default Notes
*group path

Group name.

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

ColorProfiles

These endpoints are used to manage tenant public color profiles. They cover obvious set of CRUD operations with file, including folder and collection manipulations.

Create

Creates a new entity.

Request
POST /api/storage/v1/colorProfiles[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

metadata.description formData

Color profile description

metadata.model formData

Color profile model

metadata.copyright formData

Color profile copyright

metadata.manufacturer formData

Color profile manufacturer

metadata.colorSpace formData

Color profile colorspace

metadata.deviceClass formData

Color profile device class

file formData

Entity file content

*path formData

Parent folder full path

*name formData

Entity name

customFields formData

Entity custom attributes

Responses
Status Code Type Description Samples
201 ColorProfileDto

Success

409 NameConflictDto

Conflict

401

Unauthorized

403

Forbidden

GetAll

Return all entities relevant to specified query parameters.

Request
GET /api/storage/v1/colorProfiles[?descriptions&path&includeSubfolders&skip&take&sorting&search&customFields&tenantId]
Parameters
Name In Type Default Notes
descriptions query

Color profile descriptions filter

path query

Folder path filter parameter

includeSubfolders query

If set to 'true', query result will contain list of all entities in desired folder and subfolders

skip query

Defines page start offset from beginning of sorted result list

take query

Defines page length (how much consequent items of sorted result list should be taken)

sorting query

Defines sorting order of result list e.g.: "Title ASC, LastModified DESC"

search query

Search string for partial match

customFields query

Custom attributes dictionary filter. For example: {"public":"true","name":"my item"}

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 PagedOfColorProfileDto

Success

401

Unauthorized

403

Forbidden

Copy

Copies the specified entity.

Request
POST /api/storage/v1/colorProfiles/{id}[?path&name&strategy&tenantId]
Parameters
Name In Type Default Notes
*id path

Source entity identifier.

path query

Desired path.

name query

Desired name.

strategy query

Conflict resolving strategy.

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
201 ColorProfileDto

Success

409 NameConflictDto

Conflict

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

Update

Updates the specified entity.

Request
PUT /api/storage/v1/colorProfiles/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Entity identifier.

tenantId query

Tenant identifier

metadata.description formData

Color profile description

metadata.model formData

Color profile model

metadata.copyright formData

Color profile copyright

metadata.manufacturer formData

Color profile manufacturer

metadata.colorSpace formData

Color profile colorspace

metadata.deviceClass formData

Color profile device class

file formData

Entity file content

path formData

Parent folder full path

name formData

Entity name

customFields formData

Entity custom attributes

Responses
Status Code Type Description Samples
200 ColorProfileDto

Success

404 ProblemDetails

Not Found

409 NameConflictDto

Conflict

401

Unauthorized

403

Forbidden

Get

Returns an entity by ID.

Request
GET /api/storage/v1/colorProfiles/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Entity identifier.

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 ColorProfileDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

Delete

Deletes the specified entity.

Request
DELETE /api/storage/v1/colorProfiles/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Entity identifier.

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 ColorProfileDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

GetFile

Returns an entity file from file storage.

Request
GET /api/storage/v1/colorProfiles/{id}/file[?attachment&tenantId]
Parameters
Name In Type Default Notes
*id path

Entity identifier.

attachment query

Indicates if file should be provided as an attachment with proper filename supplied (default value is 'false').

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 string

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

BatchCopy

Copies the selected entities and folders to another folder specified by path.

Request
POST /api/storage/v1/colorProfiles/batchCopy[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

body body BatchCopyInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

409 BatchConflictDto

Conflict

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

BatchDelete

Deletes the selected entities and folders.

Request
POST /api/storage/v1/colorProfiles/batchDelete[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

body body BatchDeleteInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

BatchUpdateCustomFields

Updates the custom fields values for selected entities.

Request
POST /api/storage/v1/colorProfiles/batchUpdateCustomFields[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

body body BatchUpdateCustomFieldsInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

BatchUpdateParentFolder

Updates the parent folder for selected entities and folders.

Request
POST /api/storage/v1/colorProfiles/batchUpdateParentFolder[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

body body BatchUpdateParentFolderInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

409 BatchConflictDto

Conflict

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

GetAllCollections

Returns all collections.

Request
GET /api/storage/v1/colorProfiles/collections[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 CollectionDto []

Success

401

Unauthorized

403

Forbidden

CreateCollection

Creates a new collection.

Request
POST /api/storage/v1/colorProfiles/collections[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

body body CreateCollectionDto

Operation parameters.

Responses
Status Code Type Description Samples
201 CollectionDto

Success

409 NameConflictDto

Conflict

401

Unauthorized

403

Forbidden

GetCollection

Returns the collection content by collection ID.

Request
GET /api/storage/v1/colorProfiles/collections/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Collection identifier.

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 CollectionContentOfColorProfileDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

UpdateCollection

Updates the specified collection.

Request
PUT /api/storage/v1/colorProfiles/collections/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Collection identifier.

tenantId query

Tenant identifier

body body UpdateCollectionDto

Update operation parameters.

Responses
Status Code Type Description Samples
200 CollectionDto

Success

404 ProblemDetails

Not Found

409 NameConflictDto

Conflict

401

Unauthorized

403

Forbidden

DeleteCollection

Deletes the specified collection.

Request
DELETE /api/storage/v1/colorProfiles/collections/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Collection identifier.

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 CollectionDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

GetFileStorageInfo

Returns information about the use of file storage.

Request
GET /api/storage/v1/colorProfiles/file-storage-info[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 FileStorageInfoDto

Success

401

Unauthorized

403

Forbidden

GetFolder

Returns the folder content by folder path.

Request
GET /api/storage/v1/colorProfiles/folders[?fullPath&tenantId]
Parameters
Name In Type Default Notes
fullPath query

Full folder path, if not set then root folder path is used

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 FolderContentOfColorProfileDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

CreateFolder

Creates a new folder.

Request
POST /api/storage/v1/colorProfiles/folders[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

body body CreateFolderDto

Create operation parameters.

Responses
Status Code Type Description Samples
201 FolderDto

Success

409 NameConflictDto

Conflict

401

Unauthorized

403

Forbidden

DeleteFolder

Deletes the specified folder.

Request
DELETE /api/storage/v1/colorProfiles/folders[?fullPath&tenantId]
Parameters
Name In Type Default Notes
fullPath query

Folder full path.

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 FolderDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

GetFolderInfo

Returns a folder by ID.

Request
GET /api/storage/v1/colorProfiles/folders/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Folder identifier

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 FolderDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

UpdateFolder

Updates the specified folder.

Request
PUT /api/storage/v1/colorProfiles/folders/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Folder identifier.

tenantId query

Tenant identifier

body body UpdateFolderDto

Operation parameters.

Responses
Status Code Type Description Samples
200 FolderDto

Success

404 ProblemDetails

Not Found

409 NameConflictDto

Conflict

401

Unauthorized

403

Forbidden

GetAllFolders

Returns all folders.

Request
GET /api/storage/v1/colorProfiles/folders/all[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 FolderDto []

Success

401

Unauthorized

403

Forbidden

DataSchemas

These endpoints are used to manage tenant data schemas. They cover obvious set of CRUD operations with file, including folder and collection manipulations.

Create

Creates a new entity.

Request
POST /api/storage/v1/dataSchemas[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

metadata.fields formData

DataSchema fields

file formData

Entity file content

*path formData

Parent folder full path

*name formData

Entity name

customFields formData

Entity custom attributes

Responses
Status Code Type Description Samples
201 DataSchemaDto

Success

409 NameConflictDto

Conflict

401

Unauthorized

403

Forbidden

GetAll

Return all entities relevant to specified query parameters.

Request
GET /api/storage/v1/dataSchemas[?path&includeSubfolders&skip&take&sorting&search&customFields&tenantId]
Parameters
Name In Type Default Notes
path query

Folder path filter parameter

includeSubfolders query

If set to 'true', query result will contain list of all entities in desired folder and subfolders

skip query

Defines page start offset from beginning of sorted result list

take query

Defines page length (how much consequent items of sorted result list should be taken)

sorting query

Defines sorting order of result list e.g.: "Title ASC, LastModified DESC"

search query

Search string for partial match

customFields query

Custom attributes dictionary filter. For example: {"public":"true","name":"my item"}

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 PagedOfDataSchemaDto

Success

401

Unauthorized

403

Forbidden

Copy

Copies the specified entity.

Request
POST /api/storage/v1/dataSchemas/{id}[?path&name&strategy&tenantId]
Parameters
Name In Type Default Notes
*id path

Source entity identifier.

path query

Desired path.

name query

Desired name.

strategy query

Conflict resolving strategy.

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
201 DataSchemaDto

Success

409 NameConflictDto

Conflict

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

Update

Updates the specified entity.

Request
PUT /api/storage/v1/dataSchemas/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Entity identifier.

tenantId query

Tenant identifier

metadata.fields formData

DataSchema fields

file formData

Entity file content

path formData

Parent folder full path

name formData

Entity name

customFields formData

Entity custom attributes

Responses
Status Code Type Description Samples
200 DataSchemaDto

Success

404 ProblemDetails

Not Found

409 NameConflictDto

Conflict

401

Unauthorized

403

Forbidden

Get

Returns an entity by ID.

Request
GET /api/storage/v1/dataSchemas/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Entity identifier.

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 DataSchemaDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

Delete

Deletes the specified entity.

Request
DELETE /api/storage/v1/dataSchemas/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Entity identifier.

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 DataSchemaDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

GetFile

Returns an entity file from file storage.

Request
GET /api/storage/v1/dataSchemas/{id}/file[?attachment&tenantId]
Parameters
Name In Type Default Notes
*id path

Entity identifier.

attachment query

Indicates if file should be provided as an attachment with proper filename supplied (default value is 'false').

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 string

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

BatchCopy

Copies the selected entities and folders to another folder specified by path.

Request
POST /api/storage/v1/dataSchemas/batchCopy[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

body body BatchCopyInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

409 BatchConflictDto

Conflict

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

BatchDelete

Deletes selected entities and folders.

Request
POST /api/storage/v1/dataSchemas/batchDelete[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

body body BatchDeleteInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

BatchUpdateCustomFields

Updates the custom fields values for selected entities.

Request
POST /api/storage/v1/dataSchemas/batchUpdateCustomFields[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

body body BatchUpdateCustomFieldsInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

BatchUpdateParentFolder

Updates the parent folder for selected entities and folders.

Request
POST /api/storage/v1/dataSchemas/batchUpdateParentFolder[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

body body BatchUpdateParentFolderInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

409 BatchConflictDto

Conflict

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

GetAllCollections

Returns all collections.

Request
GET /api/storage/v1/dataSchemas/collections[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 CollectionDto []

Success

401

Unauthorized

403

Forbidden

CreateCollection

Creates a new collection.

Request
POST /api/storage/v1/dataSchemas/collections[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

body body CreateCollectionDto

Operation parameters.

Responses
Status Code Type Description Samples
201 CollectionDto

Success

409 NameConflictDto

Conflict

401

Unauthorized

403

Forbidden

GetCollection

Returns the collection content by collection ID.

Request
GET /api/storage/v1/dataSchemas/collections/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Collection identifier.

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 CollectionContentOfDataSchemaDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

UpdateCollection

Updates the specified collection.

Request
PUT /api/storage/v1/dataSchemas/collections/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Collection identifier.

tenantId query

Tenant identifier

body body UpdateCollectionDto

Update operation parameters.

Responses
Status Code Type Description Samples
200 CollectionDto

Success

404 ProblemDetails

Not Found

409 NameConflictDto

Conflict

401

Unauthorized

403

Forbidden

DeleteCollection

Deletes the specified collection.

Request
DELETE /api/storage/v1/dataSchemas/collections/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Collection identifier.

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 CollectionDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

GetFileStorageInfo

Returns information about the use of file storage.

Request
GET /api/storage/v1/dataSchemas/file-storage-info[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 FileStorageInfoDto

Success

401

Unauthorized

403

Forbidden

GetFolder

Returns the folder content by folder path.

Request
GET /api/storage/v1/dataSchemas/folders[?fullPath&tenantId]
Parameters
Name In Type Default Notes
fullPath query

Full folder path, if not set then root folder path is used

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 FolderContentOfDataSchemaDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

CreateFolder

Creates a new folder.

Request
POST /api/storage/v1/dataSchemas/folders[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

body body CreateFolderDto

Create operation parameters.

Responses
Status Code Type Description Samples
201 FolderDto

Success

409 NameConflictDto

Conflict

401

Unauthorized

403

Forbidden

DeleteFolder

Deletes the specified folder.

Request
DELETE /api/storage/v1/dataSchemas/folders[?fullPath&tenantId]
Parameters
Name In Type Default Notes
fullPath query

Folder full path.

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 FolderDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

GetFolderInfo

Returns a folder by ID.

Request
GET /api/storage/v1/dataSchemas/folders/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Folder identifier

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 FolderDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

UpdateFolder

Updates the specified folder.

Request
PUT /api/storage/v1/dataSchemas/folders/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Folder identifier.

tenantId query

Tenant identifier

body body UpdateFolderDto

Operation parameters.

Responses
Status Code Type Description Samples
200 FolderDto

Success

404 ProblemDetails

Not Found

409 NameConflictDto

Conflict

401

Unauthorized

403

Forbidden

GetAllFolders

Returns all folders.

Request
GET /api/storage/v1/dataSchemas/folders/all[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 FolderDto []

Success

401

Unauthorized

403

Forbidden

DataSets

These endpoints are used to manage tenant data sets. They cover obvious set of CRUD operations with file, including folder and collection manipulations.

Create

Creates a new entity.

Request
POST /api/storage/v1/dataSets[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

metadata.dataSchemaId formData

DataSet data schema id. Empty string for embedded schema

metadata.dataSchemaName formData

DataSet data schema name

metadata.rowCount formData

Row count

hasProblems formData

Indicates whether data set has any schema validation problems.

file formData

Entity file content

*path formData

Parent folder full path

*name formData

Entity name

customFields formData

Entity custom attributes

Responses
Status Code Type Description Samples
201 DataSetDto

Success

409 NameConflictDto

Conflict

401

Unauthorized

403

Forbidden

GetAll

Return all entities relevant to specified query parameters.

Request
GET /api/storage/v1/dataSets[?dataSchemaId&path&includeSubfolders&skip&take&sorting&search&customFields&tenantId]
Parameters
Name In Type Default Notes
dataSchemaId query

Associated data schema identifier filter

path query

Folder path filter parameter

includeSubfolders query

If set to 'true', query result will contain list of all entities in desired folder and subfolders

skip query

Defines page start offset from beginning of sorted result list

take query

Defines page length (how much consequent items of sorted result list should be taken)

sorting query

Defines sorting order of result list e.g.: "Title ASC, LastModified DESC"

search query

Search string for partial match

customFields query

Custom attributes dictionary filter. For example: {"public":"true","name":"my item"}

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 PagedOfDataSetDto

Success

401

Unauthorized

403

Forbidden

Copy

Copies the specified entity.

Request
POST /api/storage/v1/dataSets/{id}[?path&name&strategy&tenantId]
Parameters
Name In Type Default Notes
*id path

Source entity identifier.

path query

Desired path.

name query

Desired name.

strategy query

Conflict resolving strategy.

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
201 DataSetDto

Success

409 NameConflictDto

Conflict

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

Update

Updates the specified entity.

Request
PUT /api/storage/v1/dataSets/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Entity identifier.

tenantId query

Tenant identifier

metadata.dataSchemaId formData

DataSet data schema id. Empty string for embedded schema

metadata.dataSchemaName formData

DataSet data schema name

metadata.rowCount formData

Row count

hasProblems formData

Indicates whether data set has any schema validation problems

file formData

Entity file content

path formData

Parent folder full path

name formData

Entity name

customFields formData

Entity custom attributes

Responses
Status Code Type Description Samples
200 DataSetDto

Success

404 ProblemDetails

Not Found

409 NameConflictDto

Conflict

401

Unauthorized

403

Forbidden

Get

Returns an entity by ID.

Request
GET /api/storage/v1/dataSets/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Entity identifier.

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 DataSetDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

Delete

Deletes the specified entity.

Request
DELETE /api/storage/v1/dataSets/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Entity identifier.

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 DataSetDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

GetFile

Returns an entity file from file storage.

Request
GET /api/storage/v1/dataSets/{id}/file[?attachment&tenantId]
Parameters
Name In Type Default Notes
*id path

Entity identifier.

attachment query

Indicates if file should be provided as an attachment with proper filename supplied (default value is 'false').

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 string

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

BatchCopy

Copies the selected entities and folders to another folder specified by path.

Request
POST /api/storage/v1/dataSets/batchCopy[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

body body BatchCopyInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

409 BatchConflictDto

Conflict

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

BatchDelete

Deletes the selected entities and folders.

Request
POST /api/storage/v1/dataSets/batchDelete[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

body body BatchDeleteInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

BatchUpdateCustomFields

Updates the custom fields values for selected entities.

Request
POST /api/storage/v1/dataSets/batchUpdateCustomFields[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

body body BatchUpdateCustomFieldsInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

BatchUpdateParentFolder

Updates the parent folder for selected entities and folders.

Request
POST /api/storage/v1/dataSets/batchUpdateParentFolder[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

body body BatchUpdateParentFolderInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

409 BatchConflictDto

Conflict

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

GetAllCollections

Returns all collections.

Request
GET /api/storage/v1/dataSets/collections[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 CollectionDto []

Success

401

Unauthorized

403

Forbidden

CreateCollection

Creates a new collection.

Request
POST /api/storage/v1/dataSets/collections[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

body body CreateCollectionDto

Operation parameters.

Responses
Status Code Type Description Samples
201 CollectionDto

Success

409 NameConflictDto

Conflict

401

Unauthorized

403

Forbidden

GetCollection

Returns the collection content by collection ID.

Request
GET /api/storage/v1/dataSets/collections/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Collection identifier.

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 CollectionContentOfDataSetDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

UpdateCollection

Updates the specified collection.

Request
PUT /api/storage/v1/dataSets/collections/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Collection identifier.

tenantId query

Tenant identifier

body body UpdateCollectionDto

Update operation parameters.

Responses
Status Code Type Description Samples
200 CollectionDto

Success

404 ProblemDetails

Not Found

409 NameConflictDto

Conflict

401

Unauthorized

403

Forbidden

DeleteCollection

Deletes the specified collection.

Request
DELETE /api/storage/v1/dataSets/collections/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Collection identifier.

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 CollectionDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

GetFileStorageInfo

Returns information about the use of file storage.

Request
GET /api/storage/v1/dataSets/file-storage-info[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 FileStorageInfoDto

Success

401

Unauthorized

403

Forbidden

GetFolder

Returns the folder content by folder path.

Request
GET /api/storage/v1/dataSets/folders[?fullPath&tenantId]
Parameters
Name In Type Default Notes
fullPath query

Full folder path, if not set then root folder path is used

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 FolderContentOfDataSetDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

CreateFolder

Creates a new folder.

Request
POST /api/storage/v1/dataSets/folders[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

body body CreateFolderDto

Create operation parameters.

Responses
Status Code Type Description Samples
201 FolderDto

Success

409 NameConflictDto

Conflict

401

Unauthorized

403

Forbidden

DeleteFolder

Deletes the specified folder.

Request
DELETE /api/storage/v1/dataSets/folders[?fullPath&tenantId]
Parameters
Name In Type Default Notes
fullPath query

Folder full path.

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 FolderDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

GetFolderInfo

Returns a folder by ID.

Request
GET /api/storage/v1/dataSets/folders/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Folder identifier

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 FolderDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

UpdateFolder

Updates the specified folder.

Request
PUT /api/storage/v1/dataSets/folders/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Folder identifier.

tenantId query

Tenant identifier

body body UpdateFolderDto

Operation parameters.

Responses
Status Code Type Description Samples
200 FolderDto

Success

404 ProblemDetails

Not Found

409 NameConflictDto

Conflict

401

Unauthorized

403

Forbidden

GetAllFolders

Returns all folders.

Request
GET /api/storage/v1/dataSets/folders/all[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 FolderDto []

Success

401

Unauthorized

403

Forbidden

Designs

These endpoints are used to manage tenant public designs. They cover obvious set of CRUD operations with file, including folder and collection manipulations.

Create

Creates a new entity.

Request
POST /api/storage/v1/designs[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

id formData

Desired unique design identifier for new design

metadata.fonts formData

Design font metadata list.

metadata.surfaces formData

Design surface metadata list.

metadata.printAreas formData

Design print area metadata list.

metadata.hasDataSchema formData

Indicates whether design has data schema.

metadata.dataSchemaId formData

Design data schema identifier. Empty string for embedded schema.

metadata.dataSchemaName formData

Design data schema name.

hasProblems formData

Indicates whether design has any problems preventing normal processing, e.g. missing font etc.

file formData

Entity file content

*path formData

Parent folder full path

*name formData

Entity name

customFields formData

Entity custom attributes

Responses
Status Code Type Description Samples
201 DesignDto

Success

409 NameConflictDto

Conflict

401

Unauthorized

403

Forbidden

GetAll

Return all entities relevant to specified query parameters.

Request
GET /api/storage/v1/designs[?dataSchemaId&fontPostScriptName&path&includeSubfolders&skip&take&sorting&search&customFields&tenantId]
Parameters
Name In Type Default Notes
dataSchemaId query

Associated data schema identifier filter

fontPostScriptName query

Design font postscript name filter

path query

Folder path filter parameter

includeSubfolders query

If set to 'true', query result will contain list of all entities in desired folder and subfolders

skip query

Defines page start offset from beginning of sorted result list

take query

Defines page length (how much consequent items of sorted result list should be taken)

sorting query

Defines sorting order of result list e.g.: "Title ASC, LastModified DESC"

search query

Search string for partial match

customFields query

Custom attributes dictionary filter. For example: {"public":"true","name":"my item"}

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 PagedOfDesignDto

Success

401

Unauthorized

403

Forbidden

Copy

Copies the specified entity.

Request
POST /api/storage/v1/designs/{id}[?path&name&strategy&tenantId]
Parameters
Name In Type Default Notes
*id path

Source entity identifier.

path query

Desired path.

name query

Desired name.

strategy query

Conflict resolving strategy.

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
201 DesignDto

Success

409 NameConflictDto

Conflict

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

Update

Updates the specified entity.

Request
PUT /api/storage/v1/designs/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Entity identifier.

tenantId query

Tenant identifier

metadata.fonts formData

Design font metadata list.

metadata.surfaces formData

Design surface metadata list.

metadata.printAreas formData

Design print area metadata list.

metadata.hasDataSchema formData

Indicates whether design has data schema.

metadata.dataSchemaId formData

Design data schema identifier. Empty string for embedded schema.

metadata.dataSchemaName formData

Design data schema name.

hasProblems formData

Indicates whether design has any problems preventing normal processing, e.g. missing font etc.

file formData

Entity file content

path formData

Parent folder full path

name formData

Entity name

customFields formData

Entity custom attributes

Responses
Status Code Type Description Samples
200 DesignDto

Success

404 ProblemDetails

Not Found

409 NameConflictDto

Conflict

401

Unauthorized

403

Forbidden

Get

Returns an entity by ID.

Request
GET /api/storage/v1/designs/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Entity identifier.

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 DesignDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

Delete

Deletes the specified entity.

Request
DELETE /api/storage/v1/designs/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Entity identifier.

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 DesignDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

GetFile

Returns an entity file from file storage.

Request
GET /api/storage/v1/designs/{id}/file[?attachment&tenantId]
Parameters
Name In Type Default Notes
*id path

Entity identifier.

attachment query

Indicates if file should be provided as an attachment with proper filename supplied (default value is 'false').

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 string

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

AddPreview

Creates a preview entity for specified source entity.

If a preview entity with specified namespace and name already exists it will be overwritten.

Request
PUT /api/storage/v1/designs/{id}/preview[?tenantId]
Parameters
Name In Type Default Notes
*id path

Source entity identifier.

tenantId query

Tenant identifier

*name formData

Preview name

*namespace formData

Preview namespace

*width formData

Preview image width

*height formData

Preview image height

format formData

Preview image format, e.g. Jpeg, Png, Bmp ...

file formData

Preview file content

Responses
Status Code Type Description Samples
200 DesignDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

BatchCopy

Copies the selected entities and folders to another folder specified by path.

Request
POST /api/storage/v1/designs/batchCopy[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

body body BatchCopyInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

409 BatchConflictDto

Conflict

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

BatchDelete

Deletes the selected entities and folders.

Request
POST /api/storage/v1/designs/batchDelete[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

body body BatchDeleteInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

BatchUpdateCustomFields

Updates the custom fields values for selected entities.

Request
POST /api/storage/v1/designs/batchUpdateCustomFields[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

body body BatchUpdateCustomFieldsInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

BatchUpdateParentFolder

Updates the parent folder for selected entities and folders.

Request
POST /api/storage/v1/designs/batchUpdateParentFolder[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

body body BatchUpdateParentFolderInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

409 BatchConflictDto

Conflict

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

GetAllCollections

Returns all collections.

Request
GET /api/storage/v1/designs/collections[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 CollectionDto []

Success

401

Unauthorized

403

Forbidden

CreateCollection

Creates a new collection.

Request
POST /api/storage/v1/designs/collections[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

body body CreateCollectionDto

Operation parameters.

Responses
Status Code Type Description Samples
201 CollectionDto

Success

409 NameConflictDto

Conflict

401

Unauthorized

403

Forbidden

GetCollection

Returns the collection content by collection ID.

Request
GET /api/storage/v1/designs/collections/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Collection identifier.

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 CollectionContentOfDesignDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

UpdateCollection

Updates the specified collection.

Request
PUT /api/storage/v1/designs/collections/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Collection identifier.

tenantId query

Tenant identifier

body body UpdateCollectionDto

Update operation parameters.

Responses
Status Code Type Description Samples
200 CollectionDto

Success

404 ProblemDetails

Not Found

409 NameConflictDto

Conflict

401

Unauthorized

403

Forbidden

DeleteCollection

Deletes the specified collection.

Request
DELETE /api/storage/v1/designs/collections/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Collection identifier.

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 CollectionDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

GetFileStorageInfo

Returns information about the use of file storage.

Request
GET /api/storage/v1/designs/file-storage-info[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 FileStorageInfoDto

Success

401

Unauthorized

403

Forbidden

GetFolder

Returns the folder content by folder path.

Request
GET /api/storage/v1/designs/folders[?fullPath&tenantId]
Parameters
Name In Type Default Notes
fullPath query

Full folder path, if not set then root folder path is used

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 FolderContentOfDesignDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

CreateFolder

Creates a new folder.

Request
POST /api/storage/v1/designs/folders[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

body body CreateFolderDto

Create operation parameters.

Responses
Status Code Type Description Samples
201 FolderDto

Success

409 NameConflictDto

Conflict

401

Unauthorized

403

Forbidden

DeleteFolder

Deletes the specified folder.

Request
DELETE /api/storage/v1/designs/folders[?fullPath&tenantId]
Parameters
Name In Type Default Notes
fullPath query

Folder full path.

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 FolderDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

GetFolderInfo

Returns a folder by ID.

Request
GET /api/storage/v1/designs/folders/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Folder identifier

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 FolderDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

UpdateFolder

Updates the specified folder.

Request
PUT /api/storage/v1/designs/folders/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Folder identifier.

tenantId query

Tenant identifier

body body UpdateFolderDto

Operation parameters.

Responses
Status Code Type Description Samples
200 FolderDto

Success

404 ProblemDetails

Not Found

409 NameConflictDto

Conflict

401

Unauthorized

403

Forbidden

GetAllFolders

Returns all folders.

Request
GET /api/storage/v1/designs/folders/all[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 FolderDto []

Success

401

Unauthorized

403

Forbidden

Fonts

These endpoints are used to manage tenant public fonts. They cover obvious set of CRUD operations with file, including folder and collection manipulations.

Create

Creates a new entity.

Request
POST /api/storage/v1/fonts[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

metadata.postscriptName formData

Font postscript name

metadata.family formData

Font family name

metadata.style formData

Font style

file formData

Entity file content

*path formData

Parent folder full path

*name formData

Entity name

customFields formData

Entity custom attributes

Responses
Status Code Type Description Samples
201 FontDto

Success

409 NameConflictDto

Conflict

401

Unauthorized

403

Forbidden

GetAll

Return all entities relevant to specified query parameters.

Request
GET /api/storage/v1/fonts[?postscriptNames&path&includeSubfolders&skip&take&sorting&search&customFields&tenantId]
Parameters
Name In Type Default Notes
postscriptNames query

Font postscript names filter

path query

Folder path filter parameter

includeSubfolders query

If set to 'true', query result will contain list of all entities in desired folder and subfolders

skip query

Defines page start offset from beginning of sorted result list

take query

Defines page length (how much consequent items of sorted result list should be taken)

sorting query

Defines sorting order of result list e.g.: "Title ASC, LastModified DESC"

search query

Search string for partial match

customFields query

Custom attributes dictionary filter. For example: {"public":"true","name":"my item"}

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 PagedOfFontDto

Success

401

Unauthorized

403

Forbidden

Copy

Copies the specified entity.

Request
POST /api/storage/v1/fonts/{id}[?path&name&strategy&tenantId]
Parameters
Name In Type Default Notes
*id path

Source entity identifier.

path query

Desired path.

name query

Desired name.

strategy query

Conflict resolving strategy.

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
201 FontDto

Success

409 NameConflictDto

Conflict

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

Update

Updates the specified entity.

Request
PUT /api/storage/v1/fonts/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Entity identifier.

tenantId query

Tenant identifier

metadata.postscriptName formData

Font postscript name

metadata.family formData

Font family name

metadata.style formData

Font style

file formData

Entity file content

path formData

Parent folder full path

name formData

Entity name

customFields formData

Entity custom attributes

Responses
Status Code Type Description Samples
200 FontDto

Success

404 ProblemDetails

Not Found

409 NameConflictDto

Conflict

401

Unauthorized

403

Forbidden

Get

Returns an entity by ID.

Request
GET /api/storage/v1/fonts/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Entity identifier.

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 FontDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

Delete

Deletes the specified entity.

Request
DELETE /api/storage/v1/fonts/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Entity identifier.

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 FontDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

GetFile

Returns an entity file from file storage.

Request
GET /api/storage/v1/fonts/{id}/file[?attachment&tenantId]
Parameters
Name In Type Default Notes
*id path

Entity identifier.

attachment query

Indicates if file should be provided as an attachment with proper filename supplied (default value is 'false').

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 string

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

AddPreview

Creates a preview entity for specified source entity.

If a preview entity with specified namespace and name already exists it will be overwritten.

Request
PUT /api/storage/v1/fonts/{id}/preview[?tenantId]
Parameters
Name In Type Default Notes
*id path

Source entity identifier.

tenantId query

Tenant identifier

*name formData

Preview name

*namespace formData

Preview namespace

*width formData

Preview image width

*height formData

Preview image height

format formData

Preview image format, e.g. Jpeg, Png, Bmp ...

file formData

Preview file content

Responses
Status Code Type Description Samples
200 FontDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

BatchCopy

Copies the selected entities and folders to another folder specified by path.

Request
POST /api/storage/v1/fonts/batchCopy[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

body body BatchCopyInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

409 BatchConflictDto

Conflict

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

BatchDelete

Deletes the selected entities and folders.

Request
POST /api/storage/v1/fonts/batchDelete[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

body body BatchDeleteInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

BatchUpdateCustomFields

Updates the custom fields values for selected entities.

Request
POST /api/storage/v1/fonts/batchUpdateCustomFields[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

body body BatchUpdateCustomFieldsInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

BatchUpdateParentFolder

Updates the parent folder for selected entities and folders.

Request
POST /api/storage/v1/fonts/batchUpdateParentFolder[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

body body BatchUpdateParentFolderInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

409 BatchConflictDto

Conflict

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

GetAllCollections

Returns all collections.

Request
GET /api/storage/v1/fonts/collections[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 CollectionDto []

Success

401

Unauthorized

403

Forbidden

CreateCollection

Creates a new collection.

Request
POST /api/storage/v1/fonts/collections[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

body body CreateCollectionDto

Operation parameters.

Responses
Status Code Type Description Samples
201 CollectionDto

Success

409 NameConflictDto

Conflict

401

Unauthorized

403

Forbidden

GetCollection

Returns the collection content by collection ID.

Request
GET /api/storage/v1/fonts/collections/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Collection identifier.

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 CollectionContentOfFontDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

UpdateCollection

Updates the specified collection.

Request
PUT /api/storage/v1/fonts/collections/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Collection identifier.

tenantId query

Tenant identifier

body body UpdateCollectionDto

Update operation parameters.

Responses
Status Code Type Description Samples
200 CollectionDto

Success

404 ProblemDetails

Not Found

409 NameConflictDto

Conflict

401

Unauthorized

403

Forbidden

DeleteCollection

Deletes the specified collection.

Request
DELETE /api/storage/v1/fonts/collections/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Collection identifier.

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 CollectionDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

GetFileStorageInfo

Returns information about the use of file storage.

Request
GET /api/storage/v1/fonts/file-storage-info[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 FileStorageInfoDto

Success

401

Unauthorized

403

Forbidden

GetFolder

Returns the folder content by folder path.

Request
GET /api/storage/v1/fonts/folders[?fullPath&tenantId]
Parameters
Name In Type Default Notes
fullPath query

Full folder path, if not set then root folder path is used

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 FolderContentOfFontDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

CreateFolder

Creates a new folder.

Request
POST /api/storage/v1/fonts/folders[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

body body CreateFolderDto

Create operation parameters.

Responses
Status Code Type Description Samples
201 FolderDto

Success

409 NameConflictDto

Conflict

401

Unauthorized

403

Forbidden

DeleteFolder

Deletes the specified folder.

Request
DELETE /api/storage/v1/fonts/folders[?fullPath&tenantId]
Parameters
Name In Type Default Notes
fullPath query

Folder full path.

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 FolderDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

GetFolderInfo

Returns a folder by ID.

Request
GET /api/storage/v1/fonts/folders/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Folder identifier

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 FolderDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

UpdateFolder

Updates the specified folder.

Request
PUT /api/storage/v1/fonts/folders/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Folder identifier.

tenantId query

Tenant identifier

body body UpdateFolderDto

Operation parameters.

Responses
Status Code Type Description Samples
200 FolderDto

Success

404 ProblemDetails

Not Found

409 NameConflictDto

Conflict

401

Unauthorized

403

Forbidden

GetAllFolders

Returns all folders.

Request
GET /api/storage/v1/fonts/folders/all[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 FolderDto []

Success

401

Unauthorized

403

Forbidden

Images

These endpoints are used to manage tenant public images. They cover obvious set of CRUD operations with file, including folder and collection manipulations.

Create

Creates a new entity.

Request
POST /api/storage/v1/images[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

metadata.isVector formData

Indicates whether image is vector

metadata.width formData

Image width

metadata.height formData

Image height

metadata.format formData

Image format, e.g. Jpeg, Png, Bmp..

metadata.dpiX formData

Image horizontal dpi

metadata.dpiY formData

Image vertical dpi

metadata.pages formData

Image page metadata list (for multipaged images, like pdf)

file formData

Entity file content

*path formData

Parent folder full path

*name formData

Entity name

customFields formData

Entity custom attributes

Responses
Status Code Type Description Samples
201 ImageDto

Success

409 NameConflictDto

Conflict

401

Unauthorized

403

Forbidden

GetAll

Return all entities relevant to specified query parameters.

Request
GET /api/storage/v1/images[?path&includeSubfolders&skip&take&sorting&search&customFields&tenantId]
Parameters
Name In Type Default Notes
path query

Folder path filter parameter

includeSubfolders query

If set to 'true', query result will contain list of all entities in desired folder and subfolders

skip query

Defines page start offset from beginning of sorted result list

take query

Defines page length (how much consequent items of sorted result list should be taken)

sorting query

Defines sorting order of result list e.g.: "Title ASC, LastModified DESC"

search query

Search string for partial match

customFields query

Custom attributes dictionary filter. For example: {"public":"true","name":"my item"}

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 PagedOfImageDto

Success

401

Unauthorized

403

Forbidden

Copy

Copies the specified entity.

Request
POST /api/storage/v1/images/{id}[?path&name&strategy&tenantId]
Parameters
Name In Type Default Notes
*id path

Source entity identifier.

path query

Desired path.

name query

Desired name.

strategy query

Conflict resolving strategy.

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
201 ImageDto

Success

409 NameConflictDto

Conflict

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

Update

Updates the specified entity.

Request
PUT /api/storage/v1/images/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Entity identifier.

tenantId query

Tenant identifier

metadata.isVector formData

Indicates whether image is vector

metadata.width formData

Image width

metadata.height formData

Image height

metadata.format formData

Image format, e.g. Jpeg, Png, Bmp..

metadata.dpiX formData

Image horizontal dpi

metadata.dpiY formData

Image vertical dpi

metadata.pages formData

Image page metadata list (for multipaged images, like pdf)

file formData

Entity file content

path formData

Parent folder full path

name formData

Entity name

customFields formData

Entity custom attributes

Responses
Status Code Type Description Samples
200 ImageDto

Success

404 ProblemDetails

Not Found

409 NameConflictDto

Conflict

401

Unauthorized

403

Forbidden

Get

Returns an entity by ID.

Request
GET /api/storage/v1/images/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Entity identifier.

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 ImageDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

Delete

Deletes the specified entity.

Request
DELETE /api/storage/v1/images/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Entity identifier.

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 ImageDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

GetFile

Returns an entity file from file storage.

Request
GET /api/storage/v1/images/{id}/file[?attachment&tenantId]
Parameters
Name In Type Default Notes
*id path

Entity identifier.

attachment query

Indicates if file should be provided as an attachment with proper filename supplied (default value is 'false').

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 string

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

AddPreview

Creates a preview entity for specified source entity.

If a preview entity with specified namespace and name already exists it will be overwritten.

Request
PUT /api/storage/v1/images/{id}/preview[?tenantId]
Parameters
Name In Type Default Notes
*id path

Source entity identifier.

tenantId query

Tenant identifier

*name formData

Preview name

*namespace formData

Preview namespace

*width formData

Preview image width

*height formData

Preview image height

format formData

Preview image format, e.g. Jpeg, Png, Bmp ...

file formData

Preview file content

Responses
Status Code Type Description Samples
200 ImageDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

BatchCopy

Copies the selected entities and folders to another folder specified by path.

Request
POST /api/storage/v1/images/batchCopy[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

body body BatchCopyInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

409 BatchConflictDto

Conflict

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

BatchDelete

Deletes the selected entities and folders.

Request
POST /api/storage/v1/images/batchDelete[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

body body BatchDeleteInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

BatchUpdateCustomFields

Updates the custom fields values for selected entities.

Request
POST /api/storage/v1/images/batchUpdateCustomFields[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

body body BatchUpdateCustomFieldsInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

BatchUpdateParentFolder

Updates the parent folder for selected entities and folders.

Request
POST /api/storage/v1/images/batchUpdateParentFolder[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

body body BatchUpdateParentFolderInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

409 BatchConflictDto

Conflict

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

GetAllCollections

Returns all collections.

Request
GET /api/storage/v1/images/collections[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 CollectionDto []

Success

401

Unauthorized

403

Forbidden

CreateCollection

Creates a new collection.

Request
POST /api/storage/v1/images/collections[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

body body CreateCollectionDto

Operation parameters.

Responses
Status Code Type Description Samples
201 CollectionDto

Success

409 NameConflictDto

Conflict

401

Unauthorized

403

Forbidden

GetCollection

Returns the collection content by collection ID.

Request
GET /api/storage/v1/images/collections/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Collection identifier.

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 CollectionContentOfImageDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

UpdateCollection

Updates the specified collection.

Request
PUT /api/storage/v1/images/collections/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Collection identifier.

tenantId query

Tenant identifier

body body UpdateCollectionDto

Update operation parameters.

Responses
Status Code Type Description Samples
200 CollectionDto

Success

404 ProblemDetails

Not Found

409 NameConflictDto

Conflict

401

Unauthorized

403

Forbidden

DeleteCollection

Deletes the specified collection.

Request
DELETE /api/storage/v1/images/collections/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Collection identifier.

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 CollectionDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

GetFileStorageInfo

Returns information about the use of file storage.

Request
GET /api/storage/v1/images/file-storage-info[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 FileStorageInfoDto

Success

401

Unauthorized

403

Forbidden

GetFolder

Returns the folder content by folder path.

Request
GET /api/storage/v1/images/folders[?fullPath&tenantId]
Parameters
Name In Type Default Notes
fullPath query

Full folder path, if not set then root folder path is used

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 FolderContentOfImageDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

CreateFolder

Creates a new folder.

Request
POST /api/storage/v1/images/folders[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

body body CreateFolderDto

Create operation parameters.

Responses
Status Code Type Description Samples
201 FolderDto

Success

409 NameConflictDto

Conflict

401

Unauthorized

403

Forbidden

DeleteFolder

Deletes the specified folder.

Request
DELETE /api/storage/v1/images/folders[?fullPath&tenantId]
Parameters
Name In Type Default Notes
fullPath query

Folder full path.

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 FolderDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

GetFolderInfo

Returns a folder by ID.

Request
GET /api/storage/v1/images/folders/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Folder identifier

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 FolderDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

UpdateFolder

Updates the specified folder.

Request
PUT /api/storage/v1/images/folders/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Folder identifier.

tenantId query

Tenant identifier

body body UpdateFolderDto

Operation parameters.

Responses
Status Code Type Description Samples
200 FolderDto

Success

404 ProblemDetails

Not Found

409 NameConflictDto

Conflict

401

Unauthorized

403

Forbidden

GetAllFolders

Returns all folders.

Request
GET /api/storage/v1/images/folders/all[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 FolderDto []

Success

401

Unauthorized

403

Forbidden

BuildInfo

These endpoints are used to get the technical information about the service such as version, build date and similar. They are also useful for a quick test whether the service is available. All of them are working in the same way and return the same information - use the HEAD or GET flavor of this endpoint based on your preference.

HeadInfo

Retruns an assembly build info.

Request
HEAD /api/storage/v1/info
Responses
Status Code Type Description Samples
200

Success

Headers
X-Aurigma-Version string

A version number

X-Aurigma-Build-Date string

A build date (UTC)

X-Aurigma-Configuration string

A build configuration (Debug | Release)

X-Aurigma-App-Name string

A service name

GetInfo

Returns an assembly build info.

Request
GET /api/storage/v1/info
Responses
Status Code Type Description Samples
200 BuildInfoModel

Success

Mockups

These endpoints are used to manage tenant public mockups.

Create

Creates a new entity.

Request
POST /api/storage/v1/mockups[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

metadata.format formData

Mockup file format.

type formData

Mockup type.

file formData

Entity file content

*path formData

Parent folder full path

*name formData

Entity name

customFields formData

Entity custom attributes

Responses
Status Code Type Description Samples
201 MockupDto

Success

409 NameConflictDto

Conflict

401

Unauthorized

403

Forbidden

GetAll

Return all entities relevant to specified query parameters.

Request
GET /api/storage/v1/mockups[?type&path&includeSubfolders&skip&take&sorting&search&customFields&tenantId]
Parameters
Name In Type Default Notes
type query

Mockup type.

path query

Folder path filter parameter

includeSubfolders query

If set to 'true', query result will contain list of all entities in desired folder and subfolders

skip query

Defines page start offset from beginning of sorted result list

take query

Defines page length (how much consequent items of sorted result list should be taken)

sorting query

Defines sorting order of result list e.g.: "Title ASC, LastModified DESC"

search query

Search string for partial match

customFields query

Custom attributes dictionary filter. For example: {"public":"true","name":"my item"}

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 PagedOfMockupDto

Success

401

Unauthorized

403

Forbidden

Copy

Copies the specified entity.

Request
POST /api/storage/v1/mockups/{id}[?path&name&strategy&tenantId]
Parameters
Name In Type Default Notes
*id path

Source entity ID.

path query

Desired path.

name query

Desired name.

strategy query

Conflict resolving strategy.

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
201 MockupDto

Success

409 NameConflictDto

Conflict

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

Update

Updates the specified entity.

Request
PUT /api/storage/v1/mockups/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Entity identifier.

tenantId query

Tenant identifier

metadata.format formData

Mockup file format.

file formData

Entity file content

path formData

Parent folder full path

name formData

Entity name

customFields formData

Entity custom attributes

Responses
Status Code Type Description Samples
200 MockupDto

Success

404 ProblemDetails

Not Found

409 NameConflictDto

Conflict

401

Unauthorized

403

Forbidden

Get

Returns an entity by ID.

Request
GET /api/storage/v1/mockups/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Entity identifier.

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 MockupDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

Delete

Deletes the specified entity.

Request
DELETE /api/storage/v1/mockups/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Entity identifier.

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 MockupDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

GetFile

Returns an entity file from file storage.

Request
GET /api/storage/v1/mockups/{id}/file[?attachment&tenantId]
Parameters
Name In Type Default Notes
*id path

Entity identifier.

attachment query

Indicates if file should be provided as an attachment with proper filename supplied (default value is 'false').

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 string

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

AddPreview

Creates a preview entity for specified source entity.

If a preview entity with specified namespace and name already exists it will be overwritten.

Request
PUT /api/storage/v1/mockups/{id}/preview[?tenantId]
Parameters
Name In Type Default Notes
*id path

Source entity identifier.

tenantId query

Tenant identifier

*name formData

Preview name

*namespace formData

Preview namespace

*width formData

Preview image width

*height formData

Preview image height

format formData

Preview image format, e.g. Jpeg, Png, Bmp ...

file formData

Preview file content

Responses
Status Code Type Description Samples
200 MockupDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

BatchCopy

Copies the selected entities and folders to another folder specified by the path.

Request
POST /api/storage/v1/mockups/batchCopy[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

body body BatchCopyInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

409 BatchConflictDto

Conflict

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

BatchDelete

Deletes the selected entities and folders.

Request
POST /api/storage/v1/mockups/batchDelete[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

body body BatchDeleteInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

BatchUpdateCustomFields

Updates the custom fields values for selected entities.

Request
POST /api/storage/v1/mockups/batchUpdateCustomFields[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

body body BatchUpdateCustomFieldsInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

BatchUpdateParentFolder

Updates the parent folder for selected entities and folders.

Request
POST /api/storage/v1/mockups/batchUpdateParentFolder[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

body body BatchUpdateParentFolderInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

409 BatchConflictDto

Conflict

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

GetAllCollections

Returns all collections.

Request
GET /api/storage/v1/mockups/collections[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 CollectionDto []

Success

401

Unauthorized

403

Forbidden

CreateCollection

Creates a new collection.

Request
POST /api/storage/v1/mockups/collections[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

body body CreateCollectionDto

Operation parameters.

Responses
Status Code Type Description Samples
201 CollectionDto

Success

409 NameConflictDto

Conflict

401

Unauthorized

403

Forbidden

GetCollection

Returns the collection content by collection ID.

Request
GET /api/storage/v1/mockups/collections/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Collection identifier.

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 CollectionContentOfMockupDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

UpdateCollection

Updates the specified collection.

Request
PUT /api/storage/v1/mockups/collections/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Collection identifier.

tenantId query

Tenant identifier

body body UpdateCollectionDto

Update operation parameters.

Responses
Status Code Type Description Samples
200 CollectionDto

Success

404 ProblemDetails

Not Found

409 NameConflictDto

Conflict

401

Unauthorized

403

Forbidden

DeleteCollection

Deletes the specified collection.

Request
DELETE /api/storage/v1/mockups/collections/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Collection identifier.

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 CollectionDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

GetFileStorageInfo

Returns information about the use of file storage.

Request
GET /api/storage/v1/mockups/file-storage-info[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 FileStorageInfoDto

Success

401

Unauthorized

403

Forbidden

GetFolder

Returns the folder content by folder path.

Request
GET /api/storage/v1/mockups/folders[?fullPath&tenantId]
Parameters
Name In Type Default Notes
fullPath query

Full folder path, if not set then root folder path is used

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 FolderContentOfMockupDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

CreateFolder

Creates a new folder.

Request
POST /api/storage/v1/mockups/folders[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

body body CreateFolderDto

Create operation parameters.

Responses
Status Code Type Description Samples
201 FolderDto

Success

409 NameConflictDto

Conflict

401

Unauthorized

403

Forbidden

DeleteFolder

Deletes the specified folder.

Request
DELETE /api/storage/v1/mockups/folders[?fullPath&tenantId]
Parameters
Name In Type Default Notes
fullPath query

Folder full path.

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 FolderDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

GetFolderInfo

Returns a folder by ID.

Request
GET /api/storage/v1/mockups/folders/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Folder identifier

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 FolderDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

UpdateFolder

Updates the specified folder.

Request
PUT /api/storage/v1/mockups/folders/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Folder identifier.

tenantId query

Tenant identifier

body body UpdateFolderDto

Operation parameters.

Responses
Status Code Type Description Samples
200 FolderDto

Success

404 ProblemDetails

Not Found

409 NameConflictDto

Conflict

401

Unauthorized

403

Forbidden

GetAllFolders

Returns all folders.

Request
GET /api/storage/v1/mockups/folders/all[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 FolderDto []

Success

401

Unauthorized

403

Forbidden

Previews

These endpoints are used to access preview (file or metadata).

Get

Returns preview entity by ID.

Request
GET /api/storage/v1/previews/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Entity identifier.

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 PreviewDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

GetFile

Returns a preview entity file from file storage.

Request
GET /api/storage/v1/previews/{id}/file[?attachment&tenantId]
Parameters
Name In Type Default Notes
*id path

Preview entity identifier.

attachment query

Indicates if file should be provided as an attachment with proper filename supplied (default value is 'false').

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 string

Success

404 ProblemDetails

Not Found

GetFileStorageInfo

Returns information about storage usage by preview files.

Request
GET /api/storage/v1/previews/file-storage-info[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 FileStorageInfoDto

Success

401

Unauthorized

403

Forbidden

PrivateDesigns

These endpoints are used to manage end user private designs. They cover obvious set of CRUD operations with file, including folder and collection manipulations.

GetAll

Returns all entities relevant to specified query parameters.

Request
GET /api/storage/v1/private-designs[?dataSchemaId&fontPostScriptName&path&includeSubfolders&skip&take&sorting&search&customFields&tenantId&ownerId]
Parameters
Name In Type Default Notes
dataSchemaId query

Associated data schema identifier filter

fontPostScriptName query

Design font postscript name filter

path query

Folder path filter parameter

includeSubfolders query

If set to 'true', query result will contain list of all entities in desired folder and subfolders

skip query

Defines page start offset from beginning of sorted result list

take query

Defines page length (how much consequent items of sorted result list should be taken)

sorting query

Defines sorting order of result list e.g.: "Title ASC, LastModified DESC"

search query

Search string for partial match

customFields query

Custom attributes dictionary filter. For example: {"public":"true","name":"my item"}

tenantId query

Tenant identifier

ownerId query

Private storage owner identifier.

Responses
Status Code Type Description Samples
200 PagedOfDesignDto

Success

401

Unauthorized

403

Forbidden

Create

Creates a new entity.

Request
POST /api/storage/v1/private-designs[?tenantId&ownerId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

ownerId query

Private storage owner identifier.

id formData

Desired unique design identifier for new design

metadata.fonts formData

Design font metadata list.

metadata.surfaces formData

Design surface metadata list.

metadata.printAreas formData

Design print area metadata list.

metadata.hasDataSchema formData

Indicates whether design has data schema.

metadata.dataSchemaId formData

Design data schema identifier. Empty string for embedded schema.

metadata.dataSchemaName formData

Design data schema name.

hasProblems formData

Indicates whether design has any problems preventing normal processing, e.g. missing font etc.

file formData

Entity file content

*path formData

Parent folder full path

*name formData

Entity name

customFields formData

Entity custom attributes

Responses
Status Code Type Description Samples
201 DesignDto

Success

409 NameConflictDto

Conflict

401

Unauthorized

403

Forbidden

Get

Returns an entity by ID.

Request
GET /api/storage/v1/private-designs/{id}[?tenantId&ownerId]
Parameters
Name In Type Default Notes
*id path

Entity identifier.

tenantId query

Tenant identifier

ownerId query

Private storage owner identifier.

Responses
Status Code Type Description Samples
200 DesignDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

Copy

Copies the specified entity.

Request
POST /api/storage/v1/private-designs/{id}[?path&name&strategy&tenantId&ownerId]
Parameters
Name In Type Default Notes
*id path

Source entity identifier.

path query

Desired path.

name query

Desired name.

strategy query

Conflict resolving strategy.

tenantId query

Tenant identifier

ownerId query

Private storage owner identifier.

Responses
Status Code Type Description Samples
201 DesignDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

Update

Updates the specified entity.

Request
PUT /api/storage/v1/private-designs/{id}[?tenantId&ownerId]
Parameters
Name In Type Default Notes
*id path

Entity identifier.

tenantId query

Tenant identifier

ownerId query

Private storage owner identifier.

metadata.fonts formData

Design font metadata list.

metadata.surfaces formData

Design surface metadata list.

metadata.printAreas formData

Design print area metadata list.

metadata.hasDataSchema formData

Indicates whether design has data schema.

metadata.dataSchemaId formData

Design data schema identifier. Empty string for embedded schema.

metadata.dataSchemaName formData

Design data schema name.

hasProblems formData

Indicates whether design has any problems preventing normal processing, e.g. missing font etc.

file formData

Entity file content

path formData

Parent folder full path

name formData

Entity name

customFields formData

Entity custom attributes

Responses
Status Code Type Description Samples
200 DesignDto

Success

404 ProblemDetails

Not Found

409 NameConflictDto

Conflict

401

Unauthorized

403

Forbidden

Delete

Deletes the specified entity.

Request
DELETE /api/storage/v1/private-designs/{id}[?tenantId&ownerId]
Parameters
Name In Type Default Notes
*id path

Entity identifier.

tenantId query

Tenant identifier

ownerId query

Private storage owner identifier.

Responses
Status Code Type Description Samples
200 DesignDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

GetFile

Returns an entity file from file storage.

Request
GET /api/storage/v1/private-designs/{id}/file[?attachment&tenantId&ownerId]
Parameters
Name In Type Default Notes
*id path

Entity identifier.

attachment query

Indicates if file should be provided as an attachment with proper filename supplied (default value is 'false').

tenantId query

Tenant identifier

ownerId query

Private storage owner identifier.

Responses
Status Code Type Description Samples
200 string

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

AddPreview

Creates a preview entity for specified source entity.

If a preview entity with specified namespace and name already exists it will be overwritten.

Request
PUT /api/storage/v1/private-designs/{id}/preview[?tenantId&ownerId]
Parameters
Name In Type Default Notes
*id path

Source entity identifier.

tenantId query

Tenant identifier

ownerId query

Private storage owner identifier.

*name formData

Preview name

*namespace formData

Preview namespace

*width formData

Preview image width

*height formData

Preview image height

format formData

Preview image format, e.g. Jpeg, Png, Bmp ...

file formData

Preview file content

Responses
Status Code Type Description Samples
200 DesignDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

GetRetentionPolicy

Returns an entity retention policy by entity identifier.

Request
GET /api/storage/v1/private-designs/{id}/retention-policy[?tenantId&ownerId]
Parameters
Name In Type Default Notes
*id path

Entity identifier.

tenantId query

Tenant identifier

ownerId query

Private storage owner identifier.

Responses
Status Code Type Description Samples
200 RetentionPolicy

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

SetRetentionPolicy

Updates an entity retention policy by entity identifier.

Request
POST /api/storage/v1/private-designs/{id}/retention-policy[?policy&tenantId&ownerId]
Parameters
Name In Type Default Notes
*id path

Entity identifier.

policy query

New entity retention policy.

tenantId query

Tenant identifier

ownerId query

Private storage owner identifier.

Responses
Status Code Type Description Samples
200

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

BatchCopy

Copies the selected entities and folders to another folder specified by path.

Request
POST /api/storage/v1/private-designs/batchCopy[?tenantId&ownerId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

ownerId query

Private storage owner identifier.

body body BatchCopyInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

409 BatchConflictDto

Conflict

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

BatchDelete

Deletes the selected entities and folders.

Request
POST /api/storage/v1/private-designs/batchDelete[?tenantId&ownerId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

ownerId query

Private storage owner identifier.

body body BatchDeleteInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

BatchUpdateCustomFields

Updates the custom fields values for selected entities.

Request
POST /api/storage/v1/private-designs/batchUpdateCustomFields[?tenantId&ownerId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

ownerId query

Private storage owner identifierю

body body BatchUpdateCustomFieldsInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

BatchUpdateOwner

Updates the owner for selected entities and folders.

Request
POST /api/storage/v1/private-designs/batchUpdateOwner[?oldOwnerId&tenantId&ownerId]
Parameters
Name In Type Default Notes
oldOwnerId query

Current private storage owner identifier.

tenantId query

Tenant identifier

ownerId query

New private storage owner identifier.

body body BatchUpdateOwnerInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

409 BatchConflictDto

Conflict

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

BatchUpdateParentFolder

Updates the parent folder for selected entities and folders.

Request
POST /api/storage/v1/private-designs/batchUpdateParentFolder[?tenantId&ownerId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

ownerId query

Private storage owner identifier.

body body BatchUpdateParentFolderInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

409 BatchConflictDto

Conflict

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

GetAllCollections

Returns all collections.

Request
GET /api/storage/v1/private-designs/collections[?tenantId&ownerId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

ownerId query

Private storage owner identifier.

Responses
Status Code Type Description Samples
200 CollectionDto []

Success

401

Unauthorized

403

Forbidden

CreateCollection

Creates a new collection.

Request
POST /api/storage/v1/private-designs/collections[?tenantId&ownerId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

ownerId query

Private storage owner identifier.

body body CreateCollectionDto

Operation parameters.

Responses
Status Code Type Description Samples
201 CollectionDto

Success

409 NameConflictDto

Conflict

401

Unauthorized

403

Forbidden

GetCollection

Returns the collection content by collection ID.

Request
GET /api/storage/v1/private-designs/collections/{id}[?tenantId&ownerId]
Parameters
Name In Type Default Notes
*id path

Collection identifier.

tenantId query

Tenant identifier

ownerId query

Private storage owner identifier.

Responses
Status Code Type Description Samples
200 CollectionContentOfDesignDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

UpdateCollection

Updates the specified collection.

Request
PUT /api/storage/v1/private-designs/collections/{id}[?tenantId&ownerId]
Parameters
Name In Type Default Notes
*id path

Collection identifier.

tenantId query

Tenant identifier

ownerId query

Private storage owner identifier.

body body UpdateCollectionDto

Operation parameters.

Responses
Status Code Type Description Samples
200 CollectionDto

Success

404 ProblemDetails

Not Found

409 NameConflictDto

Conflict

401

Unauthorized

403

Forbidden

DeleteCollection

Deletes the specified collection.

Request
DELETE /api/storage/v1/private-designs/collections/{id}[?tenantId&ownerId]
Parameters
Name In Type Default Notes
*id path

Collection identifier.

tenantId query

Tenant identifier

ownerId query

Private storage owner identifier.

Responses
Status Code Type Description Samples
200 CollectionDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

GetFileStorageInfo

Returns information about storage usage by private design files.

Request
GET /api/storage/v1/private-designs/file-storage-info[?tenantId&ownerId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

ownerId query

Private storage owner identifier.

Responses
Status Code Type Description Samples
200 FileStorageInfoDto

Success

401

Unauthorized

403

Forbidden

GetFolder

Returns the folder content by folder path.

Request
GET /api/storage/v1/private-designs/folders[?fullPath&tenantId&ownerId]
Parameters
Name In Type Default Notes
fullPath query

Full folder path, if not set then root folder path is used.

tenantId query

Tenant identifier

ownerId query

Private storage owner identifier.

Responses
Status Code Type Description Samples
200 FolderContentOfDesignDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

CreateFolder

Creates a new folder.

Request
POST /api/storage/v1/private-designs/folders[?tenantId&ownerId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

ownerId query

Private storage owner identifier.

body body CreateFolderDto

Operation parameters.

Responses
Status Code Type Description Samples
201 FolderDto

Success

409 NameConflictDto

Conflict

401

Unauthorized

403

Forbidden

DeleteFolder

Deletes the specified folder.

Request
DELETE /api/storage/v1/private-designs/folders[?fullPath&tenantId&ownerId]
Parameters
Name In Type Default Notes
fullPath query

Folder full path.

tenantId query

Tenant identifier

ownerId query

Private storage owner identifier.

Responses
Status Code Type Description Samples
200 FolderDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

UpdateFolder

Updates the specified folder.

Request
PUT /api/storage/v1/private-designs/folders/{id}[?tenantId&ownerId]
Parameters
Name In Type Default Notes
*id path

Folder identifier.

tenantId query

Tenant identifier

ownerId query

Private storage owner identifier.

body body UpdateFolderDto

Operation parameters.

Responses
Status Code Type Description Samples
200 FolderDto

Success

404 ProblemDetails

Not Found

409 NameConflictDto

Conflict

401

Unauthorized

403

Forbidden

GetFolderInfo

Returns a folder by ID.

Request
GET /api/storage/v1/private-designs/folders/{id}[?tenantId&ownerId]
Parameters
Name In Type Default Notes
*id path

Folder identifier.

tenantId query

Tenant identifier

ownerId query

Private storage owner identifier.

Responses
Status Code Type Description Samples
200 FolderDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

GetAllFolders

Returns all folders.

Request
GET /api/storage/v1/private-designs/folders/all[?tenantId&ownerId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

ownerId query

Private storage owner identifier.

Responses
Status Code Type Description Samples
200 FolderDto []

Success

401

Unauthorized

403

Forbidden

PrivateImages

These endpoints are used to manage end user private images. They cover obvious set of CRUD operations with file, including folder and collection manipulations.

GetAll

Returns all entities relevant to specified query parameters.

Request
GET /api/storage/v1/private-images[?path&includeSubfolders&skip&take&sorting&search&customFields&tenantId&ownerId]
Parameters
Name In Type Default Notes
path query

Folder path filter parameter

includeSubfolders query

If set to 'true', query result will contain list of all entities in desired folder and subfolders

skip query

Defines page start offset from beginning of sorted result list

take query

Defines page length (how much consequent items of sorted result list should be taken)

sorting query

Defines sorting order of result list e.g.: "Title ASC, LastModified DESC"

search query

Search string for partial match

customFields query

Custom attributes dictionary filter. For example: {"public":"true","name":"my item"}

tenantId query

Tenant identifier

ownerId query

Private storage owner identifier.

Responses
Status Code Type Description Samples
200 PagedOfImageDto

Success

401

Unauthorized

403

Forbidden

Create

Creates a new entity.

Request
POST /api/storage/v1/private-images[?tenantId&ownerId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

ownerId query

Private storage owner identifier.

metadata.isVector formData

Indicates whether image is vector

metadata.width formData

Image width

metadata.height formData

Image height

metadata.format formData

Image format, e.g. Jpeg, Png, Bmp..

metadata.dpiX formData

Image horizontal dpi

metadata.dpiY formData

Image vertical dpi

metadata.pages formData

Image page metadata list (for multipaged images, like pdf)

file formData

Entity file content

*path formData

Parent folder full path

*name formData

Entity name

customFields formData

Entity custom attributes

Responses
Status Code Type Description Samples
201 ImageDto

Success

409 NameConflictDto

Conflict

401

Unauthorized

403

Forbidden

Get

Returns an entity by ID.

Request
GET /api/storage/v1/private-images/{id}[?tenantId&ownerId]
Parameters
Name In Type Default Notes
*id path

Entity identifier.

tenantId query

Tenant identifier

ownerId query

Private storage owner identifier.

Responses
Status Code Type Description Samples
200 ImageDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

Copy

Copies the specified entity.

Request
POST /api/storage/v1/private-images/{id}[?path&name&strategy&tenantId&ownerId]
Parameters
Name In Type Default Notes
*id path

Source entity identifier.

path query

Desired path.

name query

Desired name.

strategy query

Conflict resolving strategy.

tenantId query

Tenant identifier

ownerId query

Private storage owner identifier.

Responses
Status Code Type Description Samples
201 ImageDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

Update

Updates the specified entity.

Request
PUT /api/storage/v1/private-images/{id}[?tenantId&ownerId]
Parameters
Name In Type Default Notes
*id path

Entity identifier.

tenantId query

Tenant identifier

ownerId query

Private storage owner identifier.

metadata.isVector formData

Indicates whether image is vector

metadata.width formData

Image width

metadata.height formData

Image height

metadata.format formData

Image format, e.g. Jpeg, Png, Bmp..

metadata.dpiX formData

Image horizontal dpi

metadata.dpiY formData

Image vertical dpi

metadata.pages formData

Image page metadata list (for multipaged images, like pdf)

file formData

Entity file content

path formData

Parent folder full path

name formData

Entity name

customFields formData

Entity custom attributes

Responses
Status Code Type Description Samples
200 ImageDto

Success

404 ProblemDetails

Not Found

409 NameConflictDto

Conflict

401

Unauthorized

403

Forbidden

Delete

Deletes the specified entity.

Request
DELETE /api/storage/v1/private-images/{id}[?tenantId&ownerId]
Parameters
Name In Type Default Notes
*id path

Entity identifier.

tenantId query

Tenant identifier

ownerId query

Private storage owner identifier.

Responses
Status Code Type Description Samples
200 ImageDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

GetFile

Returns an entity file from file storage.

Request
GET /api/storage/v1/private-images/{id}/file[?attachment&tenantId&ownerId]
Parameters
Name In Type Default Notes
*id path

Entity identifier.

attachment query

Indicates if a file should be provided as an attachment with proper filename supplied (default value is 'false').

tenantId query

Tenant identifier

ownerId query

Private storage owner identifier.

Responses
Status Code Type Description Samples
200 string

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

AddPreview

Creates a preview entity for specified source entity.

If a preview entity with specified namespace and name already exists it will be overwritten.

Request
PUT /api/storage/v1/private-images/{id}/preview[?tenantId&ownerId]
Parameters
Name In Type Default Notes
*id path

Source entity identifier.

tenantId query

Tenant identifier

ownerId query

Private storage owner identifier.

*name formData

Preview name

*namespace formData

Preview namespace

*width formData

Preview image width

*height formData

Preview image height

format formData

Preview image format, e.g. Jpeg, Png, Bmp ...

file formData

Preview file content

Responses
Status Code Type Description Samples
200 ImageDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

GetRetentionPolicy

Returns an entity retention policy by entity identifier.

Request
GET /api/storage/v1/private-images/{id}/retention-policy[?tenantId&ownerId]
Parameters
Name In Type Default Notes
*id path

Entity identifier.

tenantId query

Tenant identifier

ownerId query

Private storage owner identifier.

Responses
Status Code Type Description Samples
200 RetentionPolicy

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

SetRetentionPolicy

Updates an entity retention policy by entity identifier.

Request
POST /api/storage/v1/private-images/{id}/retention-policy[?policy&tenantId&ownerId]
Parameters
Name In Type Default Notes
*id path

Entity identifier.

policy query

New entity retention policy.

tenantId query

Tenant identifier

ownerId query

Private storage owner identifier.

Responses
Status Code Type Description Samples
200

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

BatchCopy

Copies the selected entities and folders to another folder specified by path.

Request
POST /api/storage/v1/private-images/batchCopy[?tenantId&ownerId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

ownerId query

Private storage owner identifier.

body body BatchCopyInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

409 BatchConflictDto

Conflict

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

BatchDelete

Deletes the selected entities and folders.

Request
POST /api/storage/v1/private-images/batchDelete[?tenantId&ownerId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

ownerId query

Private storage owner identifier.

body body BatchDeleteInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

BatchUpdateCustomFields

Updates the custom fields values for selected entities.

Request
POST /api/storage/v1/private-images/batchUpdateCustomFields[?tenantId&ownerId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

ownerId query

Private storage owner identifier.

body body BatchUpdateCustomFieldsInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

BatchUpdateOwner

Updates the owner for selected entities and folders.

Request
POST /api/storage/v1/private-images/batchUpdateOwner[?oldOwnerId&tenantId&ownerId]
Parameters
Name In Type Default Notes
oldOwnerId query

Source private storage owner identifier.

tenantId query

Tenant identifier

ownerId query

New private storage owner identifier.

body body BatchUpdateOwnerInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

409 BatchConflictDto

Conflict

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

BatchUpdateParentFolder

Updates the parent folder for selected entities and folders.

Request
POST /api/storage/v1/private-images/batchUpdateParentFolder[?tenantId&ownerId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

ownerId query

Private storage owner identifier.

body body BatchUpdateParentFolderInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

409 BatchConflictDto

Conflict

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

GetAllCollections

Returns all collections.

Request
GET /api/storage/v1/private-images/collections[?tenantId&ownerId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

ownerId query

Private storage owner identifier.

Responses
Status Code Type Description Samples
200 CollectionDto []

Success

401

Unauthorized

403

Forbidden

CreateCollection

Creates a new collection.

Request
POST /api/storage/v1/private-images/collections[?tenantId&ownerId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

ownerId query

Private storage owner identifier.

body body CreateCollectionDto

Operation parameters.

Responses
Status Code Type Description Samples
201 CollectionDto

Success

409 NameConflictDto

Conflict

401

Unauthorized

403

Forbidden

GetCollection

Returns the collection content by collection ID.

Request
GET /api/storage/v1/private-images/collections/{id}[?tenantId&ownerId]
Parameters
Name In Type Default Notes
*id path

Collection identifier.

tenantId query

Tenant identifier

ownerId query

Private storage owner identifier.

Responses
Status Code Type Description Samples
200 CollectionContentOfImageDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

UpdateCollection

Updates the specified collection.

Request
PUT /api/storage/v1/private-images/collections/{id}[?tenantId&ownerId]
Parameters
Name In Type Default Notes
*id path

Collection identifier.

tenantId query

Tenant identifier

ownerId query

Private storage owner identifier.

body body UpdateCollectionDto

Operation parameters.

Responses
Status Code Type Description Samples
200 CollectionDto

Success

404 ProblemDetails

Not Found

409 NameConflictDto

Conflict

401

Unauthorized

403

Forbidden

DeleteCollection

Deletes the specified collection.

Request
DELETE /api/storage/v1/private-images/collections/{id}[?tenantId&ownerId]
Parameters
Name In Type Default Notes
*id path

Collection identifier.

tenantId query

Tenant identifier

ownerId query

Private storage owner identifier.

Responses
Status Code Type Description Samples
200 CollectionDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

GetFileStorageInfo

Returns information about storage usage by private image files.

Request
GET /api/storage/v1/private-images/file-storage-info[?tenantId&ownerId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

ownerId query

Private storage owner identifier.

Responses
Status Code Type Description Samples
200 FileStorageInfoDto

Success

401

Unauthorized

403

Forbidden

GetFolder

Returns the folder content by folder path.

Request
GET /api/storage/v1/private-images/folders[?fullPath&tenantId&ownerId]
Parameters
Name In Type Default Notes
fullPath query

Full folder path, if not set then root folder path is used.

tenantId query

Tenant identifier

ownerId query

Private storage owner identifier.

Responses
Status Code Type Description Samples
200 FolderContentOfImageDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

CreateFolder

Creates a new folder.

Request
POST /api/storage/v1/private-images/folders[?tenantId&ownerId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

ownerId query

Private storage owner identifier.

body body CreateFolderDto

Operation parameters.

Responses
Status Code Type Description Samples
201 FolderDto

Success

409 NameConflictDto

Conflict

401

Unauthorized

403

Forbidden

DeleteFolder

Deletes the specified folder.

Request
DELETE /api/storage/v1/private-images/folders[?fullPath&tenantId&ownerId]
Parameters
Name In Type Default Notes
fullPath query

Folder full path.

tenantId query

Tenant identifier

ownerId query

Private storage owner identifier.

Responses
Status Code Type Description Samples
200 FolderDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

UpdateFolder

Updates the specified folder.

Request
PUT /api/storage/v1/private-images/folders/{id}[?tenantId&ownerId]
Parameters
Name In Type Default Notes
*id path

Folder identifier.

tenantId query

Tenant identifier

ownerId query

Private storage owner identifier.

body body UpdateFolderDto

Operation parameters.

Responses
Status Code Type Description Samples
200 FolderDto

Success

404 ProblemDetails

Not Found

409 NameConflictDto

Conflict

401

Unauthorized

403

Forbidden

GetFolderInfo

Returns folder by ID.

Request
GET /api/storage/v1/private-images/folders/{id}[?tenantId&ownerId]
Parameters
Name In Type Default Notes
*id path

Folder identifier.

tenantId query

Tenant identifier

ownerId query

Private storage owner identifier.

Responses
Status Code Type Description Samples
200 FolderDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

GetAllFolders

Returns all folders.

Request
GET /api/storage/v1/private-images/folders/all[?tenantId&ownerId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

ownerId query

Private storage owner identifier.

Responses
Status Code Type Description Samples
200 FolderDto []

Success

401

Unauthorized

403

Forbidden

PrivateResources

These endpoints are used to manage end user private resources.

GetAll

Returns all entities relevant to specified query parameters.

Request
GET /api/storage/v1/private-resources[?namespace&sourceId&type&skip&take&sorting&search&customFields&tenantId&ownerId]
Parameters
Name In Type Default Notes
namespace query

Resource namespace filter

sourceId query

Resource source identifier filter

type query

Resource type filter

skip query

Defines page start offset from beginning of sorted result list

take query

Defines page length (how much consequent items of sorted result list should be taken)

sorting query

Defines sorting order of result list e.g.: "Title ASC, LastModified DESC"

search query

Search string for partial match

customFields query

Custom attributes dictionary filter. For example: {"public":"true","name":"my item"}

tenantId query

Tenant identifier

ownerId query

Private storage owner identifier.

Responses
Status Code Type Description Samples
200 PagedOfResourceDto

Success

401

Unauthorized

403

Forbidden

Create

Creates a new entity.

Request
POST /api/storage/v1/private-resources[?tenantId&ownerId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

ownerId query

Private storage owner identifier.

file formData

Entity file content.

id formData

Desired unique identifier for new resource.

namespace formData

Resource namespace.

sourceId formData

Resource source identifier.

type formData

Resource type.

format formData

Resource file format.

anonymousAccess formData

Resource 'anonymous access' tag. It indicates whether resource can be accessed anonymously.

*name formData

Entity name

customFields formData

Entity custom attributes

Responses
Status Code Type Description Samples
201 ResourceDto

Success

409 NameConflictDto

Conflict

401

Unauthorized

403

Forbidden

Get

Returns an entity by ID.

Request
GET /api/storage/v1/private-resources/{id}[?tenantId&ownerId]
Parameters
Name In Type Default Notes
*id path

Entity identifier.

tenantId query

Tenant identifier

ownerId query

Private storage owner identifier.

Responses
Status Code Type Description Samples
200 ResourceDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

Update

Updates the specified entity.

Request
PUT /api/storage/v1/private-resources/{id}[?tenantId&ownerId]
Parameters
Name In Type Default Notes
*id path

Entity identifier.

tenantId query

Tenant identifier

ownerId query

Private storage owner identifier.

file formData

Entity file content.

namespace formData

Resource namespace.

sourceId formData

Resource source identifier.

type formData

Resource type.

format formData

Resource file format.

anonymousAccess formData

Resource 'anonymous access' tag. It indicates whether resource can be accessed anonymously.

name formData

Entity name

customFields formData

Entity custom attributes

Responses
Status Code Type Description Samples
200 ResourceDto

Success

404 ProblemDetails

Not Found

409 NameConflictDto

Conflict

401

Unauthorized

403

Forbidden

Delete

Deletes the specified entity.

Request
DELETE /api/storage/v1/private-resources/{id}[?tenantId&ownerId]
Parameters
Name In Type Default Notes
*id path

Entity identifier.

tenantId query

Tenant identifier

ownerId query

Private storage owner identifier.

Responses
Status Code Type Description Samples
200 ResourceDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

GetFile

Returns an entity file from file storage.

Request
GET /api/storage/v1/private-resources/{id}/file[?attachment&tenantId&ownerId]
Parameters
Name In Type Default Notes
*id path

Entity identifier.

attachment query

Indicates if file should be provided as an attachment with proper filename supplied (default value is 'false').

tenantId query

Tenant identifier

ownerId query

Private storage owner identifier.

Responses
Status Code Type Description Samples
200 string

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

GetRetentionPolicy

Returns an entity retention policy by entity identifier.

Request
GET /api/storage/v1/private-resources/{id}/retention-policy[?tenantId&ownerId]
Parameters
Name In Type Default Notes
*id path

Entity identifier.

tenantId query

Tenant identifier

ownerId query

Private storage owner identifier.

Responses
Status Code Type Description Samples
200 RetentionPolicy

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

SetRetentionPolicy

Updates an entity retention policy by entity identifier.

Request
POST /api/storage/v1/private-resources/{id}/retention-policy[?policy&tenantId&ownerId]
Parameters
Name In Type Default Notes
*id path

Entity identifier.

policy query

New entity retention policy.

tenantId query

Tenant identifier

ownerId query

Private storage owner identifier.

Responses
Status Code Type Description Samples
200

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

BatchDelete

Deletes the selected entities and folders.

Request
POST /api/storage/v1/private-resources/batchDelete[?tenantId&ownerId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

ownerId query

Private storage owner identifier.

body body BatchDeleteResourcesInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

BatchUpdateCustomFields

Updates the custom fields values for selected entities.

Request
POST /api/storage/v1/private-resources/batchUpdateCustomFields[?tenantId&ownerId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

ownerId query

Private storage owner identifier.

body body BatchUpdateCustomFieldsInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

BatchUpdateOwner

Updates the owner for selected entities and folders.

Request
POST /api/storage/v1/private-resources/batchUpdateOwner[?oldOwnerId&tenantId&ownerId]
Parameters
Name In Type Default Notes
oldOwnerId query

Source private storage owner identifier.

tenantId query

Tenant identifier

ownerId query

New private storage owner identifier.

body body BatchUpdateResourcesOwnerInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

409 BatchConflictDto

Conflict

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

GetFileStorageInfo

Returns information about storage usage by private resource files.

Request
GET /api/storage/v1/private-resources/file-storage-info[?tenantId&ownerId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

ownerId query

Private storage owner identifier.

Responses
Status Code Type Description Samples
200 FileStorageInfoDto

Success

401

Unauthorized

403

Forbidden

Resources

These endpoints are used to manage tenant public resources.

GetAll

Returns all entities relevant to specified query parameters.

Request
GET /api/storage/v1/resources[?namespace&sourceId&type&skip&take&sorting&search&customFields&tenantId]
Parameters
Name In Type Default Notes
namespace query

Resource namespace filter

sourceId query

Resource source identifier filter

type query

Resource type filter

skip query

Defines page start offset from beginning of sorted result list

take query

Defines page length (how much consequent items of sorted result list should be taken)

sorting query

Defines sorting order of result list e.g.: "Title ASC, LastModified DESC"

search query

Search string for partial match

customFields query

Custom attributes dictionary filter. For example: {"public":"true","name":"my item"}

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 PagedOfResourceDto

Success

401

Unauthorized

403

Forbidden

Create

Creates a new entity.

Request
POST /api/storage/v1/resources[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

file formData

Entity file content.

id formData

Desired unique identifier for new resource.

namespace formData

Resource namespace.

sourceId formData

Resource source identifier.

type formData

Resource type.

format formData

Resource file format.

anonymousAccess formData

Resource 'anonymous access' tag. It indicates whether resource can be accessed anonymously.

*name formData

Entity name

customFields formData

Entity custom attributes

Responses
Status Code Type Description Samples
201 ResourceDto

Success

409 NameConflictDto

Conflict

401

Unauthorized

403

Forbidden

Get

Returns an entity by ID.

Request
GET /api/storage/v1/resources/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Entity identifier.

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 ResourceDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

Update

Updates the specified entity.

Request
PUT /api/storage/v1/resources/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Entity identifier.

tenantId query

Tenant identifier

file formData

Entity file content.

namespace formData

Resource namespace.

sourceId formData

Resource source identifier.

type formData

Resource type.

format formData

Resource file format.

anonymousAccess formData

Resource 'anonymous access' tag. It indicates whether resource can be accessed anonymously.

name formData

Entity name

customFields formData

Entity custom attributes

Responses
Status Code Type Description Samples
200 ResourceDto

Success

404 ProblemDetails

Not Found

409 NameConflictDto

Conflict

401

Unauthorized

403

Forbidden

Delete

Deletes the specified entity.

Request
DELETE /api/storage/v1/resources/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Entity identifier.

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 ResourceDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

GetFile

Returns an entity file from file storage.

Request
GET /api/storage/v1/resources/{id}/file[?attachment&tenantId]
Parameters
Name In Type Default Notes
*id path

Entity identifier.

attachment query

Indicates if file should be provided as an attachment with proper filename supplied (default value is 'false').

tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 string

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

BatchDelete

Deletes the selected entities.

Request
POST /api/storage/v1/resources/batchDelete[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

body body BatchDeleteResourcesInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

BatchUpdateCustomFields

Updates the custom fields for selected entities.

Request
POST /api/storage/v1/resources/batchUpdateCustomFields[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

body body BatchUpdateCustomFieldsInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

GetFileStorageInfo

Returns information about storage usage by resource files.

Request
GET /api/storage/v1/resources/file-storage-info[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier

Responses
Status Code Type Description Samples
200 FileStorageInfoDto

Success

401

Unauthorized

403

Forbidden

Tenants

These endpoints are used to manage tenants.

GetAll

Returns all tenants.

Request
GET /api/storage/v1/tenants[?skip&take&sorting&search&customFields]
Parameters
Name In Type Default Notes
skip query

Defines page start offset from beginning of sorted result list

take query

Defines page length (how much consequent items of sorted result list should be taken)

sorting query

Defines sorting order of result list e.g.: "Title ASC, LastModified DESC"

search query

Search string for partial match

customFields query

Custom attributes dictionary filter. For example: {"public":"true","name":"my item"}

Responses
Status Code Type Description Samples
200 PagedOfTenantDto

Success

401

Unauthorized

403

Forbidden

Create

Creates a new tenant.

Request
POST /api/storage/v1/tenants
Parameters
Name In Type Default Notes
body body CreateTenantDto

Operation parameters.

Responses
Status Code Type Description Samples
201 TenantDto

Success

409 NameConflictDto

Conflict

401

Unauthorized

403

Forbidden

Get

Returns a tenant by ID.

Request
GET /api/storage/v1/tenants/{id}
Parameters
Name In Type Default Notes
*id path

Tenant identifier.

Responses
Status Code Type Description Samples
200 TenantDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

Update

Updates the specified tenant.

Request
PUT /api/storage/v1/tenants/{id}
Parameters
Name In Type Default Notes
*id path

Tenant identifier.

body body UpdateTenantDto

Operation parameters

Responses
Status Code Type Description Samples
200 TenantDto

Success

404 ProblemDetails

Not Found

409 NameConflictDto

Conflict

401

Unauthorized

403

Forbidden

Delete

Deletes the specified tenant.

Request
DELETE /api/storage/v1/tenants/{id}
Parameters
Name In Type Default Notes
*id path

Tenant identifier.

Responses
Status Code Type Description Samples
200 TenantDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

CleanUp

Forcefully starts obsolete assets clean-up as background job.

Request
POST /api/storage/v1/tenants/{id}/clean-up
Parameters
Name In Type Default Notes
*id path

Tenant identifier.

Responses
Status Code Type Description Samples
200 StatusCodeResult

Success

401

Unauthorized

403

Forbidden

Definitions

PagedOfArtifactDto

Paged list of items

Name Type Notes
total integer (int64)

Items count

items ArtifactDto[]

Items list

ArtifactDto

Items list

Name Type Notes
size integer (int64)

Artifact file size.

description string

Artifact description.

group string

Artifact group.

alias string

Artifact alias (special name within group).

type ArtifactType

Artifact type.

format string

Artifact file format.

anonymousAccess boolean

Artifact 'anonymous access' tag. It indicates whether artifact can be accessed anonymously.

url string

Artifact URL.

tenantId integer (int32)

Entity tenant identifier

id string

Entity unique identifier

ownerId string

Entity owner identifier

name string

Entity name

customFields object

Entity custom attributes

lastModified string (date-time)

Last entity modification date and time

ArtifactType

Artifact type.

Enum Values

Temporary Final Service

NameConflictDto

Information about operation subject which has name conflict

Name Type Notes
type ConflictType

Coflict type

id string

Operation subject identifier

name string

Operation subject name

path string

Operation subject folder path

ConflictType

Coflict type

Enum Values

Name FolderOverwrite

ProblemDetails

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

FileStorageInfoDto

Information about the use of file storage.

Name Type Notes
fileSizeInBytes integer (int64)

Size of files in bytes.

fileCount integer (int64)

Number of files.

ColorProfileDto

Color profile dto class

Name Type Notes
metadata ColorProfileMetadata[]

Color profile metadata

size integer (int64)

Entity file size

folderId string

Parent folder id

tenantId integer (int32)

Entity tenant identifier

id string

Entity unique identifier

ownerId string

Entity owner identifier

name string

Entity name

customFields object

Entity custom attributes

lastModified string (date-time)

Last entity modification date and time

ColorProfileMetadata

Color profile metadata

Name Type Notes
description string

Color profile description

model string

Color profile model

copyright string

Color profile copyright

manufacturer string

Color profile manufacturer

colorSpace

Color profile colorspace

deviceClass

Color profile device class

PagedOfColorProfileDto

Paged list of items

Name Type Notes
total integer (int64)

Items count

items ColorProfileDto[]

Items list

BatchCopyInput

Operation parameters.

Name Type Notes
entityIds array

List of entities, which are operation subjects.

folderIds array

List of folders, which are operation subjects.

conflictStrategy

Conflict resolving strategy.

path string

Folder path, specifies folder which will hold copies.

BatchConflictDto

Information about batch operation subjects(folder and entities) which have name conflicts

Name Type Notes
entityConflicts ConflictDto[]

List of operation subject entity descriptions

folderConflicts ConflictDto[]

List of operation subject folder descriptions

type ConflictType

Coflict type

ConflictDto

List of operation subject entity descriptions

Name Type Notes
id string

Operation subject identifier

name string

Operation subject name

path string

Operation subject folder path

BatchDeleteInput

Operation parameters.

Name Type Notes
entityIds array

List of entities, which are operation subjects.

folderIds array

List of folders, which are operation subjects.

BatchUpdateCustomFieldsInput

Operation parameters.

Name Type Notes
entityIds array

List of entities, which are operation subjects.

customFields object

Custom fields dictionary.

updateStrategy

Custom fields update strategy

BatchUpdateParentFolderInput

Operation parameters.

Name Type Notes
entityIds array

List of entities, which are operation subjects.

folderIds array

List of folders, which are operation subjects.

path string

New parent folder path.

conflictStrategy

Conflict resolving strategy.

CollectionDto

Name Type Notes
id string

Collection unique identifier

ownerId string

Entity owner identifier

name string

Entity name

customFields object

Entity custom attributes

lastModified string (date-time)

Last entity modification date and time

CreateCollectionDto

Operation parameters.

Name Type Notes
name string

Collection name

CollectionContentOfColorProfileDto

Collection content information

Name Type Notes
id string

Collection unique identifier

name string

Collection name

collections CollectionDto[]

List of contained collections

folders FolderDto[]

List of contained folders

entities ColorProfileDto[]

List of contained entities

FolderDto

List of contained folders

Name Type Notes
id string

Folder unique identifier

path string

Parent folder full path

private boolean

Folder 'private' tag indicates whether folder is private

ownerId string

Entity owner identifier

name string

Entity name

customFields object

Entity custom attributes

lastModified string (date-time)

Last entity modification date and time

UpdateCollectionDto

Update operation parameters.

Name Type Notes
name string

Collection name

entities array

Entity identifier list specifing entities, which are part of specified collection

folders array

Folder identifier list specifying folders, which are part of specified collection

collections array

Collection identifier list specifying collections, which are part of specified collection

FolderContentOfColorProfileDto

Folder content information

Name Type Notes
id string

Folder unique identifier

folders FolderInfoDto[]

List of contained subfolders

entities ColorProfileDto[]

List of contained entities

entitiesCount integer (int64)

Count of all contained entities (including all subfolder entities)

FolderInfoDto

List of contained subfolders

Name Type Notes
hasChildren boolean

Folder 'has children' tag

id string

Folder unique identifier

path string

Parent folder full path

private boolean

Folder 'private' tag indicates whether folder is private

ownerId string

Entity owner identifier

name string

Entity name

customFields object

Entity custom attributes

lastModified string (date-time)

Last entity modification date and time

CreateFolderDto

Create operation parameters.

Name Type Notes
name string

Folder name

path string

Parent folder path

UpdateFolderDto

Operation parameters.

Name Type Notes
name string

Folder name

path string

Parent folder path

DataSchemaDto

Data schema dto class

Name Type Notes
metadata DataSchemaMetadata[]

Data schema metadata

size integer (int64)

Entity file size

folderId string

Parent folder id

tenantId integer (int32)

Entity tenant identifier

id string

Entity unique identifier

ownerId string

Entity owner identifier

name string

Entity name

customFields object

Entity custom attributes

lastModified string (date-time)

Last entity modification date and time

DataSchemaMetadata

Data schema metadata

Name Type Notes
fields string

DataSchema fields

PagedOfDataSchemaDto

Paged list of items

Name Type Notes
total integer (int64)

Items count

items DataSchemaDto[]

Items list

CollectionContentOfDataSchemaDto

Collection content information

Name Type Notes
id string

Collection unique identifier

name string

Collection name

collections CollectionDto[]

List of contained collections

folders FolderDto[]

List of contained folders

entities DataSchemaDto[]

List of contained entities

FolderContentOfDataSchemaDto

Folder content information

Name Type Notes
id string

Folder unique identifier

folders FolderInfoDto[]

List of contained subfolders

entities DataSchemaDto[]

List of contained entities

entitiesCount integer (int64)

Count of all contained entities (including all subfolder entities)

DataSetDto

Data set dto class

Name Type Notes
metadata DataSetMetadata[]

Data set metadata

hasProblems boolean

Indicates whether data set has any schema validation problems.

size integer (int64)

Entity file size

folderId string

Parent folder id

tenantId integer (int32)

Entity tenant identifier

id string

Entity unique identifier

ownerId string

Entity owner identifier

name string

Entity name

customFields object

Entity custom attributes

lastModified string (date-time)

Last entity modification date and time

DataSetMetadata

Data set metadata

Name Type Notes
dataSchemaId string

DataSet data schema id. Empty string for embedded schema

dataSchemaName string

DataSet data schema name

rowCount integer (int32)

Row count

PagedOfDataSetDto

Paged list of items

Name Type Notes
total integer (int64)

Items count

items DataSetDto[]

Items list

CollectionContentOfDataSetDto

Collection content information

Name Type Notes
id string

Collection unique identifier

name string

Collection name

collections CollectionDto[]

List of contained collections

folders FolderDto[]

List of contained folders

entities DataSetDto[]

List of contained entities

FolderContentOfDataSetDto

Folder content information

Name Type Notes
id string

Folder unique identifier

folders FolderInfoDto[]

List of contained subfolders

entities DataSetDto[]

List of contained entities

entitiesCount integer (int64)

Count of all contained entities (including all subfolder entities)

DesignDto

Design dto class

Name Type Notes
metadata DesignMetadata[]

Design metadata.

hasProblems boolean

Design 'hasProblems' tag indicates whether design has any problems preventing normal processing, e.g. missing font etc.

private boolean

Design 'private' tag indicates whether design is private.

previews object

Preview dictionary Key: "previewMetadata.namespace-previewMetadata.name" Value: "previewMetadata"

size integer (int64)

Entity file size

folderId string

Parent folder id

tenantId integer (int32)

Entity tenant identifier

id string

Entity unique identifier

ownerId string

Entity owner identifier

name string

Entity name

customFields object

Entity custom attributes

lastModified string (date-time)

Last entity modification date and time

DesignMetadata

Design metadata.

Name Type Notes
fonts DesignFontMetadata[]

Design font metadata list.

surfaces DesignSurfaceMetadata[]

Design surface metadata list.

printAreas DesignPrintAreaMetadata[]

Design print area metadata list.

hasDataSchema boolean

Indicates whether design has data schema.

dataSchemaId string

Design data schema identifier. Empty string for embedded schema.

dataSchemaName string

Design data schema name.

DesignFontMetadata

Design font metadata list.

Name Type Notes
postscriptName string

Font postscript name.

family string

Font family name.

style string

Font style.

DesignSurfaceMetadata

Design surface metadata list.

Name Type Notes
width number (float)

Design surface width.

height number (float)

Design surface height.

DesignPrintAreaMetadata

Design print area metadata list.

Name Type Notes
width number (float)

Design print area width.

height number (float)

Design print area height.

PagedOfDesignDto

Paged list of items

Name Type Notes
total integer (int64)

Items count

items DesignDto[]

Items list

CollectionContentOfDesignDto

Collection content information

Name Type Notes
id string

Collection unique identifier

name string

Collection name

collections CollectionDto[]

List of contained collections

folders FolderDto[]

List of contained folders

entities DesignDto[]

List of contained entities

FolderContentOfDesignDto

Folder content information

Name Type Notes
id string

Folder unique identifier

folders FolderInfoDto[]

List of contained subfolders

entities DesignDto[]

List of contained entities

entitiesCount integer (int64)

Count of all contained entities (including all subfolder entities)

FontDto

Font dto class

Name Type Notes
metadata FontMetadata[]

Font metadata

previews object

Preview dictionary Key: "previewMetadata.namespace-previewMetadata.name" Value: "previewMetadata"

size integer (int64)

Entity file size

folderId string

Parent folder id

tenantId integer (int32)

Entity tenant identifier

id string

Entity unique identifier

ownerId string

Entity owner identifier

name string

Entity name

customFields object

Entity custom attributes

lastModified string (date-time)

Last entity modification date and time

FontMetadata

Font metadata

Name Type Notes
postscriptName string

Font postscript name

family string

Font family name

style string

Font style

PagedOfFontDto

Paged list of items

Name Type Notes
total integer (int64)

Items count

items FontDto[]

Items list

CollectionContentOfFontDto

Collection content information

Name Type Notes
id string

Collection unique identifier

name string

Collection name

collections CollectionDto[]

List of contained collections

folders FolderDto[]

List of contained folders

entities FontDto[]

List of contained entities

FolderContentOfFontDto

Folder content information

Name Type Notes
id string

Folder unique identifier

folders FolderInfoDto[]

List of contained subfolders

entities FontDto[]

List of contained entities

entitiesCount integer (int64)

Count of all contained entities (including all subfolder entities)

ImageDto

Image dto class

Name Type Notes
metadata ImageMetadata[]

Image metadata

private boolean

Image 'private' tag indicates whether image is private

mimeType string

Image file associated media format type

previews object

Preview dictionary Key: "previewMetadata.namespace-previewMetadata.name" Value: "previewMetadata"

size integer (int64)

Entity file size

folderId string

Parent folder id

tenantId integer (int32)

Entity tenant identifier

id string

Entity unique identifier

ownerId string

Entity owner identifier

name string

Entity name

customFields object

Entity custom attributes

lastModified string (date-time)

Last entity modification date and time

ImageMetadata

Image metadata

Name Type Notes
isVector boolean

Indicates whether image is vector

width integer (int32)

Image width

height integer (int32)

Image height

format string

Image format, e.g. Jpeg, Png, Bmp..

dpiX string

Image horizontal dpi

dpiY string

Image vertical dpi

pages ImagePageMetadata[]

Image page metadata list (for multipaged images, like pdf)

ImagePageMetadata

Image page metadata list (for multipaged images, like pdf)

Name Type Notes
width integer (int32)

Image page width

height integer (int32)

Image page height

PagedOfImageDto

Paged list of items

Name Type Notes
total integer (int64)

Items count

items ImageDto[]

Items list

CollectionContentOfImageDto

Collection content information

Name Type Notes
id string

Collection unique identifier

name string

Collection name

collections CollectionDto[]

List of contained collections

folders FolderDto[]

List of contained folders

entities ImageDto[]

List of contained entities

FolderContentOfImageDto

Folder content information

Name Type Notes
id string

Folder unique identifier

folders FolderInfoDto[]

List of contained subfolders

entities ImageDto[]

List of contained entities

entitiesCount integer (int64)

Count of all contained entities (including all subfolder entities)

BuildInfoModel

Information about a service

Name Type Notes
version string

Version number

buildDate string

Build date (UTC)

configuration string

Build configuration (Debug | Release)

appName string

Service name

MockupDto

DTO of the mockup entity.

Name Type Notes
metadata MockupMetadataDto[]

Mockup metadata.

private boolean

Indicates if the mockup is private.

type MockupType

Mockup type.

previews object

Preview dictionary Key: "previewMetadata.namespace-previewMetadata.name" Value: "previewMetadata"

size integer (int64)

Entity file size

folderId string

Parent folder id

tenantId integer (int32)

Entity tenant identifier

id string

Entity unique identifier

ownerId string

Entity owner identifier

name string

Entity name

customFields object

Entity custom attributes

lastModified string (date-time)

Last entity modification date and time

MockupMetadataDto

Mockup metadata.

Name Type Notes
format

Mockup file format.

MockupType

Mockup type.

Enum Values

Mockup2D Mockup3D

PagedOfMockupDto

Paged list of items

Name Type Notes
total integer (int64)

Items count

items MockupDto[]

Items list

CollectionContentOfMockupDto

Collection content information

Name Type Notes
id string

Collection unique identifier

name string

Collection name

collections CollectionDto[]

List of contained collections

folders FolderDto[]

List of contained folders

entities MockupDto[]

List of contained entities

FolderContentOfMockupDto

Folder content information

Name Type Notes
id string

Folder unique identifier

folders FolderInfoDto[]

List of contained subfolders

entities MockupDto[]

List of contained entities

entitiesCount integer (int64)

Count of all contained entities (including all subfolder entities)

PreviewDto

Preview dto class.

Name Type Notes
size integer (int64)

Preview image file size.

namespace string

Preview image namespace.

sourceId string

Preview source entity identifier.

width integer (int32)

Preview image width.

height integer (int32)

Preview image height.

format string

Preview image file format, e.g. Jpeg, Png, Bmp...

mimeType string

Preview image media format type.

url string

Preview URL.

tenantId integer (int32)

Entity tenant identifier

id string

Entity unique identifier

name string

Entity name

lastModified string (date-time)

Last entity modification date and time

RetentionPolicy

Asset retention policy.

Enum Values

Unknown Never Default

BatchUpdateOwnerInput

Operation parameters.

Name Type Notes
entityIds array

List of entities, which are operation subjects

folderIds array

List of folders, which are operation subjects.

conflictStrategy

Conflict resolving strategy.

updateAll boolean

If set to 'true', all folders and entities, which belong to specified ownerId, should be updated with new ownerId.

PagedOfResourceDto

Paged list of items

Name Type Notes
total integer (int64)

Items count

items ResourceDto[]

Items list

ResourceDto

Items list

Name Type Notes
size integer (int64)

Resource file size.

namespace string

Resource namespace.

sourceId string

Resource source identifier.

type string

Resource Type.

format string

Resource Format.

private boolean

Resource 'private' tag. It indicates whether resource is private.

anonymousAccess boolean

Resource 'anonymous access' tag. It indicates whether resource can be accessed anonymously.

url string

Resource URL.

tenantId integer (int32)

Entity tenant identifier

id string

Entity unique identifier

ownerId string

Entity owner identifier

name string

Entity name

customFields object

Entity custom attributes

lastModified string (date-time)

Last entity modification date and time

BatchDeleteResourcesInput

Operation parameters.

Name Type Notes
entityIds array

List of entities, which are operation subjects

BatchUpdateResourcesOwnerInput

Operation parameters.

Name Type Notes
entityIds array

List of entities, which are operation subjects

conflictStrategy

List of folders, which are operation subjects

updateAll boolean

If set to 'true' all folders and entities, which belong to specified ownerId should be updated with new ownerId

PagedOfTenantDto

Paged list of items

Name Type Notes
total integer (int64)

Items count

items TenantDto[]

Items list

TenantDto

Items list

Name Type Notes
id integer (int32)

Tenant entity unique identifier.

settings TenantSettingsDto[]

Tenant settings.

name string

Entity name

customFields object

Entity custom attributes

lastModified string (date-time)

Last entity modification date and time

TenantSettingsDto

Tenant settings.

Name Type Notes
enableAssetsRetention boolean

Indicates if specific assets should be removed after a retention period.

assetsRetentionPeriodInDays integer (int32)

Period of assets retention in days.

CreateTenantDto

Operation parameters.

Name Type Notes
id integer (int32)

Tenant entity desired identifier.

settings

Tenant settings.

name string

Entity name

customFields object

Entity custom attributes

UpdateTenantDto

Operation parameters

Name Type Notes
settings

Tenant settings.

name string

Entity name

customFields object

Entity custom attributes

StatusCodeResult

Name Type Notes
statusCode integer (int32)
Was this page helpful?
Thanks for your feedback!
Back to top Copyright © 2001–2022 Aurigma, Inc. All rights reserved.
Loading...
    Thank for your vote
    Your opinion is important to us. To provide details, send feedback.
    Send feedback