Back to Website
Show / Hide Table of Contents

AssetStorage 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 AssetProcessor API service.

Interactive API Docs

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

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

Returns 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

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 ID.

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 ID.

*file formData

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

Created

409 ConflictDto

Conflict

404 ProblemDetails

Not Found

429 ProblemDetails

Too Many Requests

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 ID.

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 ID.

file formData

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 ConflictDto

Conflict

429 ProblemDetails

Too Many Requests

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 ID.

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 ID.

Responses
Status Code Type Description Samples
200 string

Success

404 ProblemDetails

Not Found

429 ProblemDetails

Too Many Requests

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 ID.

Responses
Status Code Type Description Samples
200 FileStorageInfoDto

Success

401

Unauthorized

403

Forbidden

DeleteGroup

Deletes all entities within the specified group.

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

Group name.

tenantId query

Tenant ID.

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.

GetAll

Returns all entities relevant to specified query parameters.

Request
GET /api/storage/v1/color-profiles[?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 ID.

Responses
Status Code Type Description Samples
200 PagedOfColorProfileDto

Success

401

Unauthorized

403

Forbidden

Create

Creates a new entity.

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

Tenant ID.

metadata.description formData
metadata.model formData
metadata.copyright formData
metadata.manufacturer formData
metadata.colorSpace formData
metadata.deviceClass formData
*file formData

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

Created

404 ProblemDetails

Not Found

409 ConflictDto

Conflict

429 ProblemDetails

Too Many Requests

401

Unauthorized

403

Forbidden

Get

Returns an entity by ID.

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

Entity identifier.

tenantId query

Tenant ID.

Responses
Status Code Type Description Samples
200 ColorProfileDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

Update

Updates the specified entity.

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

Entity identifier.

tenantId query

Tenant ID.

metadata.description formData
metadata.model formData
metadata.copyright formData
metadata.manufacturer formData
metadata.colorSpace formData
metadata.deviceClass formData
file formData

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 ConflictDto

Conflict

429 ProblemDetails

Too Many Requests

401

Unauthorized

403

Forbidden

Delete

Deletes the specified entity.

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

Entity identifier.

tenantId query

Tenant ID.

Responses
Status Code Type Description Samples
200 ColorProfileDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

Copy

Copies the specified entity.

Request
POST /api/storage/v1/color-profiles/{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 Rename

Conflict resolving strategy.

tenantId query

Tenant ID.

Responses
Status Code Type Description Samples
201 ColorProfileDto

Created

409 ConflictDto

Conflict

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

GetFile

Returns an entity file from file storage.

Request
GET /api/storage/v1/color-profiles/{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 ID.

Responses
Status Code Type Description Samples
200 string

Success

404 ProblemDetails

Not Found

429 ProblemDetails

Too Many Requests

401

Unauthorized

403

Forbidden

GetFileStorageInfo

Returns information about the use of file storage.

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

Tenant ID.

Responses
Status Code Type Description Samples
200 FileStorageInfoDto

Success

401

Unauthorized

403

Forbidden

GetAllFolders

Returns all folders.

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

Tenant ID.

Responses
Status Code Type Description Samples
200 FolderDto []

Success

401

Unauthorized

403

Forbidden

GetFolder

Returns a folder and its content by folder path.

Request
GET /api/storage/v1/color-profiles/folders/content-by-path[?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 ID.

Responses
Status Code Type Description Samples
200 FolderContentOfColorProfileDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

DeleteFolder

Deletes the specified folder and its content by folder path.

Request
DELETE /api/storage/v1/color-profiles/folders/content-by-path[?fullPath&tenantId]
Parameters
Name In Type Default Notes
fullPath query

Folder full path.

tenantId query

Tenant ID.

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/color-profiles/folders/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Folder identifier.

tenantId query

Tenant ID.

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/color-profiles/folders/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Folder identifier.

tenantId query

Tenant ID.

body body UpdateFolderDto

Operation parameters.

Responses
Status Code Type Description Samples
200 FolderDto

Success

404 ProblemDetails

Not Found

409 ConflictDto

Conflict

401

Unauthorized

403

Forbidden

DeleteFolderById

Deletes the specified folder and its content by folder identifier.

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

Folder identifier.

tenantId query

Tenant ID.

Responses
Status Code Type Description Samples
200 FolderDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

CreateFolder

Creates a new folder.

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

Tenant ID.

body body CreateFolderDto

Create operation parameters.

Responses
Status Code Type Description Samples
201 FolderDto

Created

404 ProblemDetails

Not Found

409 ConflictDto

Conflict

401

Unauthorized

403

Forbidden

BatchCopy

Copies the specified entities and folders to another folder.

Request
POST /api/storage/v1/color-profiles/batch-copy[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant ID.

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 specified entities and folders.

Request
POST /api/storage/v1/color-profiles/batch-delete[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant ID.

body body BatchDeleteInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

BatchUpdateCustomFields

Updates custom fields values for the specified entities.

Request
POST /api/storage/v1/color-profiles/batch-update-custom-fields[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant ID.

body body BatchUpdateCustomFieldsInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

BatchUpdateParentFolder

Updates parent folder for the specified entities and folders.

Request
POST /api/storage/v1/color-profiles/batch-update-parent-folder[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant ID.

body body BatchUpdateParentFolderInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

409 BatchConflictDto

Conflict

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

DataSchemas

These endpoints are used to manage tenant data schemas.

GetAll

Returns all entities relevant to specified query parameters.

Request
GET /api/storage/v1/data-schemas[?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 ID.

Responses
Status Code Type Description Samples
200 PagedOfDataSchemaDto

Success

401

Unauthorized

403

Forbidden

Create

Creates a new entity.

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

Tenant ID.

metadata.fields formData
*file formData

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

Created

404 ProblemDetails

Not Found

409 ConflictDto

Conflict

429 ProblemDetails

Too Many Requests

401

Unauthorized

403

Forbidden

Get

Returns an entity by ID.

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

Entity identifier.

tenantId query

Tenant ID.

Responses
Status Code Type Description Samples
200 DataSchemaDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

Update

Updates the specified entity.

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

Entity identifier.

tenantId query

Tenant ID.

metadata.fields formData
file formData

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 ConflictDto

Conflict

429 ProblemDetails

Too Many Requests

401

Unauthorized

403

Forbidden

Delete

Deletes the specified entity.

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

Entity identifier.

tenantId query

Tenant ID.

Responses
Status Code Type Description Samples
200 DataSchemaDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

Copy

Copies the specified entity.

Request
POST /api/storage/v1/data-schemas/{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 Rename

Conflict resolving strategy.

tenantId query

Tenant ID.

Responses
Status Code Type Description Samples
201 DataSchemaDto

Created

409 ConflictDto

Conflict

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

GetFile

Returns an entity file from file storage.

Request
GET /api/storage/v1/data-schemas/{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 ID.

Responses
Status Code Type Description Samples
200 string

Success

404 ProblemDetails

Not Found

429 ProblemDetails

Too Many Requests

401

Unauthorized

403

Forbidden

GetFileStorageInfo

Returns information about the use of file storage.

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

Tenant ID.

Responses
Status Code Type Description Samples
200 FileStorageInfoDto

Success

401

Unauthorized

403

Forbidden

GetAllFolders

Returns all folders.

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

Tenant ID.

Responses
Status Code Type Description Samples
200 FolderDto []

Success

401

Unauthorized

403

Forbidden

GetFolder

Returns a folder and its content by folder path.

Request
GET /api/storage/v1/data-schemas/folders/content-by-path[?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 ID.

Responses
Status Code Type Description Samples
200 FolderContentOfDataSchemaDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

DeleteFolder

Deletes the specified folder and its content by folder path.

Request
DELETE /api/storage/v1/data-schemas/folders/content-by-path[?fullPath&tenantId]
Parameters
Name In Type Default Notes
fullPath query

Folder full path.

tenantId query

Tenant ID.

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/data-schemas/folders/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Folder identifier.

tenantId query

Tenant ID.

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/data-schemas/folders/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Folder identifier.

tenantId query

Tenant ID.

body body UpdateFolderDto

Operation parameters.

Responses
Status Code Type Description Samples
200 FolderDto

Success

404 ProblemDetails

Not Found

409 ConflictDto

Conflict

401

Unauthorized

403

Forbidden

DeleteFolderById

Deletes the specified folder and its content by folder identifier.

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

Folder identifier.

tenantId query

Tenant ID.

Responses
Status Code Type Description Samples
200 FolderDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

CreateFolder

Creates a new folder.

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

Tenant ID.

body body CreateFolderDto

Create operation parameters.

Responses
Status Code Type Description Samples
201 FolderDto

Created

404 ProblemDetails

Not Found

409 ConflictDto

Conflict

401

Unauthorized

403

Forbidden

BatchCopy

Copies the specified entities and folders to another folder.

Request
POST /api/storage/v1/data-schemas/batch-copy[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant ID.

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 specified entities and folders.

Request
POST /api/storage/v1/data-schemas/batch-delete[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant ID.

body body BatchDeleteInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

BatchUpdateCustomFields

Updates custom fields values for the specified entities.

Request
POST /api/storage/v1/data-schemas/batch-update-custom-fields[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant ID.

body body BatchUpdateCustomFieldsInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

BatchUpdateParentFolder

Updates parent folder for the specified entities and folders.

Request
POST /api/storage/v1/data-schemas/batch-update-parent-folder[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant ID.

body body BatchUpdateParentFolderInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

409 BatchConflictDto

Conflict

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

DataSets

These endpoints are used to manage tenant data sets.

GetAll

Returns all entities relevant to specified query parameters.

Request
GET /api/storage/v1/data-sets[?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 ID.

Responses
Status Code Type Description Samples
200 PagedOfDataSetDto

Success

401

Unauthorized

403

Forbidden

Create

Creates a new entity.

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

Tenant ID.

metadata.dataSchemaId formData
metadata.dataSchemaName formData
metadata.rowCount formData
hasProblems formData

Indicates whether data set has any schema validation problems.

*file formData

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

Created

404 ProblemDetails

Not Found

409 ConflictDto

Conflict

429 ProblemDetails

Too Many Requests

401

Unauthorized

403

Forbidden

Get

Returns an entity by ID.

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

Entity identifier.

tenantId query

Tenant ID.

Responses
Status Code Type Description Samples
200 DataSetDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

Update

Updates the specified entity.

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

Entity identifier.

tenantId query

Tenant ID.

metadata.dataSchemaId formData
metadata.dataSchemaName formData
metadata.rowCount formData
hasProblems formData

Indicates whether data set has any schema validation problems.

file formData

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 ConflictDto

Conflict

429 ProblemDetails

Too Many Requests

401

Unauthorized

403

Forbidden

Delete

Deletes the specified entity.

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

Entity identifier.

tenantId query

Tenant ID.

Responses
Status Code Type Description Samples
200 DataSetDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

Copy

Copies the specified entity.

Request
POST /api/storage/v1/data-sets/{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 Rename

Conflict resolving strategy.

tenantId query

Tenant ID.

Responses
Status Code Type Description Samples
201 DataSetDto

Created

409 ConflictDto

Conflict

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

GetFile

Returns an entity file from file storage.

Request
GET /api/storage/v1/data-sets/{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 ID.

Responses
Status Code Type Description Samples
200 string

Success

404 ProblemDetails

Not Found

429 ProblemDetails

Too Many Requests

401

Unauthorized

403

Forbidden

GetFileStorageInfo

Returns information about the use of file storage.

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

Tenant ID.

Responses
Status Code Type Description Samples
200 FileStorageInfoDto

Success

401

Unauthorized

403

Forbidden

GetAllFolders

Returns all folders.

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

Tenant ID.

Responses
Status Code Type Description Samples
200 FolderDto []

Success

401

Unauthorized

403

Forbidden

GetFolder

Returns a folder and its content by folder path.

Request
GET /api/storage/v1/data-sets/folders/content-by-path[?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 ID.

Responses
Status Code Type Description Samples
200 FolderContentOfDataSetDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

DeleteFolder

Deletes the specified folder and its content by folder path.

Request
DELETE /api/storage/v1/data-sets/folders/content-by-path[?fullPath&tenantId]
Parameters
Name In Type Default Notes
fullPath query

Folder full path.

tenantId query

Tenant ID.

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/data-sets/folders/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Folder identifier.

tenantId query

Tenant ID.

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/data-sets/folders/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Folder identifier.

tenantId query

Tenant ID.

body body UpdateFolderDto

Operation parameters.

Responses
Status Code Type Description Samples
200 FolderDto

Success

404 ProblemDetails

Not Found

409 ConflictDto

Conflict

401

Unauthorized

403

Forbidden

DeleteFolderById

Deletes the specified folder and its content by folder identifier.

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

Folder identifier.

tenantId query

Tenant ID.

Responses
Status Code Type Description Samples
200 FolderDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

CreateFolder

Creates a new folder.

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

Tenant ID.

body body CreateFolderDto

Create operation parameters.

Responses
Status Code Type Description Samples
201 FolderDto

Created

404 ProblemDetails

Not Found

409 ConflictDto

Conflict

401

Unauthorized

403

Forbidden

BatchCopy

Copies the specified entities and folders to another folder.

Request
POST /api/storage/v1/data-sets/batch-copy[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant ID.

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 specified entities and folders.

Request
POST /api/storage/v1/data-sets/batch-delete[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant ID.

body body BatchDeleteInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

BatchUpdateCustomFields

Updates custom fields values for the specified entities.

Request
POST /api/storage/v1/data-sets/batch-update-custom-fields[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant ID.

body body BatchUpdateCustomFieldsInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

BatchUpdateParentFolder

Updates parent folder for the specified entities and folders.

Request
POST /api/storage/v1/data-sets/batch-update-parent-folder[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant ID.

body body BatchUpdateParentFolderInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

409 BatchConflictDto

Conflict

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

Designs

These endpoints are used to manage tenant public designs.

GetAll

Returns all entities relevant to specified query parameters.

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

Associated data schema identifier filter.

toggleSetId query

Associated toggle set identifier filter.

paletteId query

Associated palette identifier filter.

paletteUID query

Associated palette UID 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 ID.

Responses
Status Code Type Description Samples
200 PagedOfDesignDto

Success

401

Unauthorized

403

Forbidden

Create

Creates a new entity.

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

Tenant ID.

id formData

Desired unique design identifier for a new design.

metadata.fonts formData
metadata.surfaces formData
metadata.printAreas formData
metadata.hasDataSchema formData
metadata.dataSchemaId formData
metadata.dataSchemaName formData
metadata.hasToggleSet formData
metadata.toggleSetId formData
metadata.toggleSetName formData
metadata.hasPalettes formData
metadata.palettes formData
hasProblems formData

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

*file formData

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

Created

404 ProblemDetails

Not Found

409 ConflictDto

Conflict

429 ProblemDetails

Too Many Requests

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 ID.

Responses
Status Code Type Description Samples
200 DesignDto

Success

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 ID.

metadata.fonts formData
metadata.surfaces formData
metadata.printAreas formData
metadata.hasDataSchema formData
metadata.dataSchemaId formData
metadata.dataSchemaName formData
metadata.hasToggleSet formData
metadata.toggleSetId formData
metadata.toggleSetName formData
metadata.hasPalettes formData
metadata.palettes formData
hasProblems formData

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

file formData

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 ConflictDto

Conflict

429 ProblemDetails

Too Many Requests

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 ID.

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/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 Rename

Conflict resolving strategy.

tenantId query

Tenant ID.

Responses
Status Code Type Description Samples
201 DesignDto

Created

409 ConflictDto

Conflict

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 ID.

Responses
Status Code Type Description Samples
200 string

Success

404 ProblemDetails

Not Found

429 ProblemDetails

Too Many Requests

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 ID.

Responses
Status Code Type Description Samples
200 FileStorageInfoDto

Success

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 ID.

Responses
Status Code Type Description Samples
200 FolderDto []

Success

401

Unauthorized

403

Forbidden

GetFolder

Returns a folder and its content by folder path.

Request
GET /api/storage/v1/designs/folders/content-by-path[?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 ID.

Responses
Status Code Type Description Samples
200 FolderContentOfDesignDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

DeleteFolder

Deletes the specified folder and its content by folder path.

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

Folder full path.

tenantId query

Tenant ID.

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 ID.

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 ID.

body body UpdateFolderDto

Operation parameters.

Responses
Status Code Type Description Samples
200 FolderDto

Success

404 ProblemDetails

Not Found

409 ConflictDto

Conflict

401

Unauthorized

403

Forbidden

DeleteFolderById

Deletes the specified folder and its content by folder identifier.

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

Folder identifier.

tenantId query

Tenant ID.

Responses
Status Code Type Description Samples
200 FolderDto

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 ID.

body body CreateFolderDto

Create operation parameters.

Responses
Status Code Type Description Samples
201 FolderDto

Created

404 ProblemDetails

Not Found

409 ConflictDto

Conflict

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 ID.

*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.

isCustom formData

Indicates if the preview is custom. Custom previews preserved even if source is changed.

Responses
Status Code Type Description Samples
200 DesignDto

Success

404 ProblemDetails

Not Found

429 ProblemDetails

Too Many Requests

401

Unauthorized

403

Forbidden

BatchCopy

Copies the specified entities and folders to another folder.

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

Tenant ID.

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 specified entities and folders.

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

Tenant ID.

body body BatchDeleteInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

BatchUpdateCustomFields

Updates custom fields values for the specified entities.

Request
POST /api/storage/v1/designs/batch-update-custom-fields[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant ID.

body body BatchUpdateCustomFieldsInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

BatchUpdateParentFolder

Updates parent folder for the specified entities and folders.

Request
POST /api/storage/v1/designs/batch-update-parent-folder[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant ID.

body body BatchUpdateParentFolderInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

409 BatchConflictDto

Conflict

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

Documents

These endpoints are used to manage tenant documents.

GetAll

Returns all entities relevant to specified query parameters.

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

Document type.

format query

Document format.

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 ID.

Responses
Status Code Type Description Samples
200 PagedOfDocumentDto

Success

401

Unauthorized

403

Forbidden

Create

Creates a new entity.

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

Tenant ID.

type formData

Document type.

format formData

Document format.

*file formData

File content.

*path formData

Parent folder full path.

*name formData

Entity name.

customFields formData

Entity custom attributes.

Responses
Status Code Type Description Samples
201 DocumentDto

Created

404 ProblemDetails

Not Found

409 ConflictDto

Conflict

429 ProblemDetails

Too Many Requests

401

Unauthorized

403

Forbidden

Get

Returns an entity by ID.

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

Entity identifier.

tenantId query

Tenant ID.

Responses
Status Code Type Description Samples
200 DocumentDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

Update

Updates the specified entity.

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

Entity identifier.

tenantId query

Tenant ID.

type formData

Document type.

format formData

Document format.

file formData

File content.

path formData

Parent folder full path.

name formData

Entity name.

customFields formData

Entity custom attributes.

Responses
Status Code Type Description Samples
200 DocumentDto

Success

404 ProblemDetails

Not Found

409 ConflictDto

Conflict

429 ProblemDetails

Too Many Requests

401

Unauthorized

403

Forbidden

Delete

Deletes the specified entity.

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

Entity identifier.

tenantId query

Tenant ID.

Responses
Status Code Type Description Samples
200 DocumentDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

Copy

Copies the specified entity.

Request
POST /api/storage/v1/documents/{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 Rename

Conflict resolving strategy.

tenantId query

Tenant ID.

Responses
Status Code Type Description Samples
201 DocumentDto

Created

409 ConflictDto

Conflict

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

GetFile

Returns an entity file from file storage.

Request
GET /api/storage/v1/documents/{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 ID.

Responses
Status Code Type Description Samples
200 string

Success

404 ProblemDetails

Not Found

429 ProblemDetails

Too Many Requests

401

Unauthorized

403

Forbidden

GetFileStorageInfo

Returns information about the use of file storage.

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

Tenant ID.

Responses
Status Code Type Description Samples
200 FileStorageInfoDto

Success

401

Unauthorized

403

Forbidden

GetAllFolders

Returns all folders.

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

Tenant ID.

Responses
Status Code Type Description Samples
200 FolderDto []

Success

401

Unauthorized

403

Forbidden

GetFolder

Returns a folder and its content by folder path.

Request
GET /api/storage/v1/documents/folders/content-by-path[?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 ID.

Responses
Status Code Type Description Samples
200 FolderContentOfDocumentDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

DeleteFolder

Deletes the specified folder and its content by folder path.

Request
DELETE /api/storage/v1/documents/folders/content-by-path[?fullPath&tenantId]
Parameters
Name In Type Default Notes
fullPath query

Folder full path.

tenantId query

Tenant ID.

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/documents/folders/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Folder identifier.

tenantId query

Tenant ID.

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/documents/folders/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Folder identifier.

tenantId query

Tenant ID.

body body UpdateFolderDto

Operation parameters.

Responses
Status Code Type Description Samples
200 FolderDto

Success

404 ProblemDetails

Not Found

409 ConflictDto

Conflict

401

Unauthorized

403

Forbidden

DeleteFolderById

Deletes the specified folder and its content by folder identifier.

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

Folder identifier.

tenantId query

Tenant ID.

Responses
Status Code Type Description Samples
200 FolderDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

CreateFolder

Creates a new folder.

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

Tenant ID.

body body CreateFolderDto

Create operation parameters.

Responses
Status Code Type Description Samples
201 FolderDto

Created

404 ProblemDetails

Not Found

409 ConflictDto

Conflict

401

Unauthorized

403

Forbidden

BatchCopy

Copies the specified entities and folders to another folder.

Request
POST /api/storage/v1/documents/batch-copy[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant ID.

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 specified entities and folders.

Request
POST /api/storage/v1/documents/batch-delete[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant ID.

body body BatchDeleteInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

BatchUpdateCustomFields

Updates custom fields values for the specified entities.

Request
POST /api/storage/v1/documents/batch-update-custom-fields[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant ID.

body body BatchUpdateCustomFieldsInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

BatchUpdateParentFolder

Updates parent folder for the specified entities and folders.

Request
POST /api/storage/v1/documents/batch-update-parent-folder[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant ID.

body body BatchUpdateParentFolderInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

409 BatchConflictDto

Conflict

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

Fonts

These endpoints are used to manage tenant public fonts.

GetAll

Returns 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 ID.

Responses
Status Code Type Description Samples
200 PagedOfFontDto

Success

401

Unauthorized

403

Forbidden

Create

Creates a new entity.

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

Tenant ID.

metadata.postscriptName formData
metadata.family formData
metadata.style formData
*file formData

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

Created

404 ProblemDetails

Not Found

409 ConflictDto

Conflict

429 ProblemDetails

Too Many Requests

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 ID.

Responses
Status Code Type Description Samples
200 FontDto

Success

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 ID.

metadata.postscriptName formData
metadata.family formData
metadata.style formData
file formData

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 ConflictDto

Conflict

429 ProblemDetails

Too Many Requests

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 ID.

Responses
Status Code Type Description Samples
200 FontDto

Success

404 ProblemDetails

Not Found

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 Rename

Conflict resolving strategy.

tenantId query

Tenant ID.

Responses
Status Code Type Description Samples
201 FontDto

Created

409 ConflictDto

Conflict

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 ID.

Responses
Status Code Type Description Samples
200 string

Success

404 ProblemDetails

Not Found

429 ProblemDetails

Too Many Requests

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 ID.

Responses
Status Code Type Description Samples
200 FileStorageInfoDto

Success

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 ID.

Responses
Status Code Type Description Samples
200 FolderDto []

Success

401

Unauthorized

403

Forbidden

GetFolder

Returns a folder and its content by folder path.

Request
GET /api/storage/v1/fonts/folders/content-by-path[?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 ID.

Responses
Status Code Type Description Samples
200 FolderContentOfFontDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

DeleteFolder

Deletes the specified folder and its content by folder path.

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

Folder full path.

tenantId query

Tenant ID.

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 ID.

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 ID.

body body UpdateFolderDto

Operation parameters.

Responses
Status Code Type Description Samples
200 FolderDto

Success

404 ProblemDetails

Not Found

409 ConflictDto

Conflict

401

Unauthorized

403

Forbidden

DeleteFolderById

Deletes the specified folder and its content by folder identifier.

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

Folder identifier.

tenantId query

Tenant ID.

Responses
Status Code Type Description Samples
200 FolderDto

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 ID.

body body CreateFolderDto

Create operation parameters.

Responses
Status Code Type Description Samples
201 FolderDto

Created

404 ProblemDetails

Not Found

409 ConflictDto

Conflict

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 ID.

*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.

isCustom formData

Indicates if the preview is custom. Custom previews preserved even if source is changed.

Responses
Status Code Type Description Samples
200 FontDto

Success

404 ProblemDetails

Not Found

429 ProblemDetails

Too Many Requests

401

Unauthorized

403

Forbidden

BatchCopy

Copies the specified entities and folders to another folder.

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

Tenant ID.

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 specified entities and folders.

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

Tenant ID.

body body BatchDeleteInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

BatchUpdateCustomFields

Updates custom fields values for the specified entities.

Request
POST /api/storage/v1/fonts/batch-update-custom-fields[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant ID.

body body BatchUpdateCustomFieldsInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

BatchUpdateParentFolder

Updates parent folder for the specified entities and folders.

Request
POST /api/storage/v1/fonts/batch-update-parent-folder[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant ID.

body body BatchUpdateParentFolderInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

409 BatchConflictDto

Conflict

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

Images

These endpoints are used to manage tenant public images.

GetAll

Returns 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 ID.

Responses
Status Code Type Description Samples
200 PagedOfImageDto

Success

401

Unauthorized

403

Forbidden

Create

Creates a new entity.

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

Tenant ID.

metadata.isVector formData
metadata.width formData
metadata.height formData
metadata.format formData
metadata.dpiX formData
metadata.dpiY formData
metadata.pages formData
*file formData

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

Created

404 ProblemDetails

Not Found

409 ConflictDto

Conflict

429 ProblemDetails

Too Many Requests

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 ID.

Responses
Status Code Type Description Samples
200 ImageDto

Success

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 ID.

metadata.isVector formData
metadata.width formData
metadata.height formData
metadata.format formData
metadata.dpiX formData
metadata.dpiY formData
metadata.pages formData
file formData

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 ConflictDto

Conflict

429 ProblemDetails

Too Many Requests

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 ID.

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/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 Rename

Conflict resolving strategy.

tenantId query

Tenant ID.

Responses
Status Code Type Description Samples
201 ImageDto

Created

409 ConflictDto

Conflict

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 ID.

Responses
Status Code Type Description Samples
200 string

Success

404 ProblemDetails

Not Found

429 ProblemDetails

Too Many Requests

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 ID.

Responses
Status Code Type Description Samples
200 FileStorageInfoDto

Success

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 ID.

Responses
Status Code Type Description Samples
200 FolderDto []

Success

401

Unauthorized

403

Forbidden

GetFolder

Returns a folder and its content by folder path.

Request
GET /api/storage/v1/images/folders/content-by-path[?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 ID.

Responses
Status Code Type Description Samples
200 FolderContentOfImageDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

DeleteFolder

Deletes the specified folder and its content by folder path.

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

Folder full path.

tenantId query

Tenant ID.

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 ID.

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 ID.

body body UpdateFolderDto

Operation parameters.

Responses
Status Code Type Description Samples
200 FolderDto

Success

404 ProblemDetails

Not Found

409 ConflictDto

Conflict

401

Unauthorized

403

Forbidden

DeleteFolderById

Deletes the specified folder and its content by folder identifier.

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

Folder identifier.

tenantId query

Tenant ID.

Responses
Status Code Type Description Samples
200 FolderDto

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 ID.

body body CreateFolderDto

Create operation parameters.

Responses
Status Code Type Description Samples
201 FolderDto

Created

404 ProblemDetails

Not Found

409 ConflictDto

Conflict

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 ID.

*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.

isCustom formData

Indicates if the preview is custom. Custom previews preserved even if source is changed.

Responses
Status Code Type Description Samples
200 ImageDto

Success

404 ProblemDetails

Not Found

429 ProblemDetails

Too Many Requests

401

Unauthorized

403

Forbidden

BatchCopy

Copies the specified entities and folders to another folder.

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

Tenant ID.

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 specified entities and folders.

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

Tenant ID.

body body BatchDeleteInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

BatchUpdateCustomFields

Updates custom fields values for the specified entities.

Request
POST /api/storage/v1/images/batch-update-custom-fields[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant ID.

body body BatchUpdateCustomFieldsInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

BatchUpdateParentFolder

Updates parent folder for the specified entities and folders.

Request
POST /api/storage/v1/images/batch-update-parent-folder[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant ID.

body body BatchUpdateParentFolderInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

409 BatchConflictDto

Conflict

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

Mockups

These endpoints are used to manage tenant public mockups.

GetAll

Returns 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 ID.

Responses
Status Code Type Description Samples
200 PagedOfMockupDto

Success

401

Unauthorized

403

Forbidden

Create

Creates a new entity.

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

Tenant ID.

metadata.format formData

Mockup file format.

type formData

Mockup type.

*file formData

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

Created

404 ProblemDetails

Not Found

409 ConflictDto

Conflict

429 ProblemDetails

Too Many Requests

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 ID.

Responses
Status Code Type Description Samples
200 MockupDto

Success

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 ID.

metadata.format formData

Mockup file format.

file formData

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 ConflictDto

Conflict

429 ProblemDetails

Too Many Requests

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 ID.

Responses
Status Code Type Description Samples
200 MockupDto

Success

404 ProblemDetails

Not Found

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 identifier.

path query

Desired path.

name query

Desired name.

strategy query Rename

Conflict resolving strategy.

tenantId query

Tenant ID.

Responses
Status Code Type Description Samples
201 MockupDto

Created

409 ConflictDto

Conflict

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 ID.

Responses
Status Code Type Description Samples
200 string

Success

404 ProblemDetails

Not Found

429 ProblemDetails

Too Many Requests

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 ID.

Responses
Status Code Type Description Samples
200 FileStorageInfoDto

Success

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 ID.

Responses
Status Code Type Description Samples
200 FolderDto []

Success

401

Unauthorized

403

Forbidden

GetFolder

Returns a folder and its content by folder path.

Request
GET /api/storage/v1/mockups/folders/content-by-path[?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 ID.

Responses
Status Code Type Description Samples
200 FolderContentOfMockupDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

DeleteFolder

Deletes the specified folder and its content by folder path.

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

Folder full path.

tenantId query

Tenant ID.

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 ID.

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 ID.

body body UpdateFolderDto

Operation parameters.

Responses
Status Code Type Description Samples
200 FolderDto

Success

404 ProblemDetails

Not Found

409 ConflictDto

Conflict

401

Unauthorized

403

Forbidden

DeleteFolderById

Deletes the specified folder and its content by folder identifier.

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

Folder identifier.

tenantId query

Tenant ID.

Responses
Status Code Type Description Samples
200 FolderDto

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 ID.

body body CreateFolderDto

Create operation parameters.

Responses
Status Code Type Description Samples
201 FolderDto

Created

404 ProblemDetails

Not Found

409 ConflictDto

Conflict

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 ID.

*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.

isCustom formData

Indicates if the preview is custom. Custom previews preserved even if source is changed.

Responses
Status Code Type Description Samples
200 MockupDto

Success

404 ProblemDetails

Not Found

429 ProblemDetails

Too Many Requests

401

Unauthorized

403

Forbidden

BatchCopy

Copies the specified entities and folders to another folder.

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

Tenant ID.

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 specified entities and folders.

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

Tenant ID.

body body BatchDeleteInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

BatchUpdateCustomFields

Updates custom fields values for the specified entities.

Request
POST /api/storage/v1/mockups/batch-update-custom-fields[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant ID.

body body BatchUpdateCustomFieldsInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

BatchUpdateParentFolder

Updates parent folder for the specified entities and folders.

Request
POST /api/storage/v1/mockups/batch-update-parent-folder[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant ID.

body body BatchUpdateParentFolderInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

409 BatchConflictDto

Conflict

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

Palettes

These endpoints are used to manage tenant public palettes.

GetAll

Returns all entities relevant to specified query parameters.

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

Palette UIDs 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 ID.

Responses
Status Code Type Description Samples
200 PagedOfPaletteDto

Success

401

Unauthorized

403

Forbidden

Create

Creates a new entity.

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

Tenant ID.

metadata.uID formData
*file formData

File content.

*path formData

Parent folder full path.

*name formData

Entity name.

customFields formData

Entity custom attributes.

Responses
Status Code Type Description Samples
201 PaletteDto

Created

404 ProblemDetails

Not Found

409 ConflictDto

Conflict

429 ProblemDetails

Too Many Requests

401

Unauthorized

403

Forbidden

Get

Returns an entity by ID.

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

Entity identifier.

tenantId query

Tenant ID.

Responses
Status Code Type Description Samples
200 PaletteDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

Update

Updates the specified entity.

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

Entity identifier.

tenantId query

Tenant ID.

metadata.uID formData
file formData

File content.

path formData

Parent folder full path.

name formData

Entity name.

customFields formData

Entity custom attributes.

Responses
Status Code Type Description Samples
200 PaletteDto

Success

404 ProblemDetails

Not Found

409 ConflictDto

Conflict

429 ProblemDetails

Too Many Requests

401

Unauthorized

403

Forbidden

Delete

Deletes the specified entity.

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

Entity identifier.

tenantId query

Tenant ID.

Responses
Status Code Type Description Samples
200 PaletteDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

Copy

Copies the specified entity.

Request
POST /api/storage/v1/palettes/{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 Rename

Conflict resolving strategy.

tenantId query

Tenant ID.

Responses
Status Code Type Description Samples
201 PaletteDto

Created

409 ConflictDto

Conflict

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

GetFile

Returns an entity file from file storage.

Request
GET /api/storage/v1/palettes/{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 ID.

Responses
Status Code Type Description Samples
200 string

Success

404 ProblemDetails

Not Found

429 ProblemDetails

Too Many Requests

401

Unauthorized

403

Forbidden

GetFileStorageInfo

Returns information about the use of file storage.

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

Tenant ID.

Responses
Status Code Type Description Samples
200 FileStorageInfoDto

Success

401

Unauthorized

403

Forbidden

GetAllFolders

Returns all folders.

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

Tenant ID.

Responses
Status Code Type Description Samples
200 FolderDto []

Success

401

Unauthorized

403

Forbidden

GetFolder

Returns a folder and its content by folder path.

Request
GET /api/storage/v1/palettes/folders/content-by-path[?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 ID.

Responses
Status Code Type Description Samples
200 FolderContentOfPaletteDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

DeleteFolder

Deletes the specified folder and its content by folder path.

Request
DELETE /api/storage/v1/palettes/folders/content-by-path[?fullPath&tenantId]
Parameters
Name In Type Default Notes
fullPath query

Folder full path.

tenantId query

Tenant ID.

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/palettes/folders/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Folder identifier.

tenantId query

Tenant ID.

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/palettes/folders/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Folder identifier.

tenantId query

Tenant ID.

body body UpdateFolderDto

Operation parameters.

Responses
Status Code Type Description Samples
200 FolderDto

Success

404 ProblemDetails

Not Found

409 ConflictDto

Conflict

401

Unauthorized

403

Forbidden

DeleteFolderById

Deletes the specified folder and its content by folder identifier.

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

Folder identifier.

tenantId query

Tenant ID.

Responses
Status Code Type Description Samples
200 FolderDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

CreateFolder

Creates a new folder.

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

Tenant ID.

body body CreateFolderDto

Create operation parameters.

Responses
Status Code Type Description Samples
201 FolderDto

Created

404 ProblemDetails

Not Found

409 ConflictDto

Conflict

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/palettes/{id}/preview[?tenantId]
Parameters
Name In Type Default Notes
*id path

Source entity identifier.

tenantId query

Tenant ID.

*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.

isCustom formData

Indicates if the preview is custom. Custom previews preserved even if source is changed.

Responses
Status Code Type Description Samples
200 PaletteDto

Success

404 ProblemDetails

Not Found

429 ProblemDetails

Too Many Requests

401

Unauthorized

403

Forbidden

BatchCopy

Copies the specified entities and folders to another folder.

Request
POST /api/storage/v1/palettes/batch-copy[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant ID.

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 specified entities and folders.

Request
POST /api/storage/v1/palettes/batch-delete[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant ID.

body body BatchDeleteInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

BatchUpdateCustomFields

Updates custom fields values for the specified entities.

Request
POST /api/storage/v1/palettes/batch-update-custom-fields[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant ID.

body body BatchUpdateCustomFieldsInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

BatchUpdateParentFolder

Updates parent folder for the specified entities and folders.

Request
POST /api/storage/v1/palettes/batch-update-parent-folder[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant ID.

body body BatchUpdateParentFolderInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

409 BatchConflictDto

Conflict

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

Previews

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

GetAll

Returns all entities relevant to specified query parameters.

Request
GET /api/storage/v1/previews[?sourceId&skip&take&sorting&tenantId]
Parameters
Name In Type Default Notes
sourceId query

Defines preview source 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".

tenantId query

Tenant ID.

Responses
Status Code Type Description Samples
200 PagedOfPreviewDto

Success

401

Unauthorized

403

Forbidden

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 ID.

Responses
Status Code Type Description Samples
200 PreviewDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

Delete

Deletes the specified entity.

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

Entity identifier.

tenantId query

Tenant ID.

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 ID.

Responses
Status Code Type Description Samples
200 string

Success

404 ProblemDetails

Not Found

429 ProblemDetails

Too Many Requests

401

Unauthorized

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 ID.

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 ID.

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 ID.

*file formData

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

Created

404 ProblemDetails

Not Found

409 ConflictDto

Conflict

429 ProblemDetails

Too Many Requests

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 ID.

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 ID.

file formData

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 ConflictDto

Conflict

429 ProblemDetails

Too Many Requests

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 ID.

Responses
Status Code Type Description Samples
200 ResourceDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

Copy

Copies the specified entity.

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

Source entity identifier.

name query

Desired name.

namespace query

Desired namespace.

sourceId query

Desired source identifier.

strategy query Rename

Conflict resolving strategy.

tenantId query

Tenant ID.

Responses
Status Code Type Description Samples
201 ResourceDto

Created

409 ConflictDto

Conflict

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 ID.

Responses
Status Code Type Description Samples
200 string

Success

404 ProblemDetails

Not Found

429 ProblemDetails

Too Many Requests

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 ID.

Responses
Status Code Type Description Samples
200 FileStorageInfoDto

Success

401

Unauthorized

403

Forbidden

BatchUpdateCustomFields

Updates custom fields values for the specified entities.

Request
POST /api/storage/v1/resources/batch-update-custom-fields[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant ID.

body body BatchUpdateCustomFieldsInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

BatchCopy

Copies the specified entities.

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

Tenant ID.

body body BatchCopyResourcesInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

409 BatchConflictDto

Conflict

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

BatchDelete

Deletes the specified entities.

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

Tenant ID.

body body BatchDeleteResourcesInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

DeleteByNamespace

Deletes all resources that use a specified namespace.

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

Namespace value.

tenantId query

Tenant ID.

Responses
Status Code Type Description Samples
200

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

Tenants

These endpoints are used to manage tenants.

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

Success

401

Unauthorized

403

Forbidden

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

Created

409 ConflictDto

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 ConflictDto

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

PrivateDesigns

These endpoints are used to manage end user private designs.

GetAll

Returns all entities relevant to specified query parameters.

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

Associated data schema identifier filter.

toggleSetId query

Associated toggle set identifier filter.

paletteId query

Associated palette identifier filter.

paletteUID query

Associated palette UID 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 ID.

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 ID.

ownerId query

Private storage owner identifier.

id formData

Desired unique design identifier for a new design.

metadata.fonts formData
metadata.surfaces formData
metadata.printAreas formData
metadata.hasDataSchema formData
metadata.dataSchemaId formData
metadata.dataSchemaName formData
metadata.hasToggleSet formData
metadata.toggleSetId formData
metadata.toggleSetName formData
metadata.hasPalettes formData
metadata.palettes formData
hasProblems formData

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

*file formData

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

Created

404 ProblemDetails

Not Found

409 ConflictDto

Conflict

429 ProblemDetails

Too Many Requests

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 ID.

ownerId query

Private storage owner identifier.

Responses
Status Code Type Description Samples
200 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 ID.

ownerId query

Private storage owner identifier.

metadata.fonts formData
metadata.surfaces formData
metadata.printAreas formData
metadata.hasDataSchema formData
metadata.dataSchemaId formData
metadata.dataSchemaName formData
metadata.hasToggleSet formData
metadata.toggleSetId formData
metadata.toggleSetName formData
metadata.hasPalettes formData
metadata.palettes formData
hasProblems formData

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

file formData

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 ConflictDto

Conflict

429 ProblemDetails

Too Many Requests

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 ID.

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 Rename

Conflict resolving strategy.

tenantId query

Tenant ID.

ownerId query

Private storage owner identifier.

Responses
Status Code Type Description Samples
201 DesignDto

Created

409 ConflictDto

Conflict

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 ID.

ownerId query

Private storage owner identifier.

Responses
Status Code Type Description Samples
200 string

Success

404 ProblemDetails

Not Found

429 ProblemDetails

Too Many Requests

401

Unauthorized

403

Forbidden

GetFileStorageInfo

Returns information about the use of file storage.

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

Tenant ID.

ownerId query

Private storage owner identifier.

Responses
Status Code Type Description Samples
200 FileStorageInfoDto

Success

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 ID.

ownerId query

Private storage owner identifier.

Responses
Status Code Type Description Samples
200 FolderDto []

Success

401

Unauthorized

403

Forbidden

GetFolder

Returns a folder and its content by folder path.

Request
GET /api/storage/v1/private-designs/folders/content-by-path[?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 ID.

ownerId query

Private storage owner identifier.

Responses
Status Code Type Description Samples
200 FolderContentOfDesignDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

DeleteFolder

Deletes the specified folder and its content by folder path.

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

Folder full path.

tenantId query

Tenant ID.

ownerId query

Private storage owner 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/private-designs/folders/{id}[?tenantId&ownerId]
Parameters
Name In Type Default Notes
*id path

Folder identifier.

tenantId query

Tenant ID.

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 ID.

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 ConflictDto

Conflict

401

Unauthorized

403

Forbidden

DeleteFolderById

Deletes the specified folder and its content by folder identifier.

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

Folder identifier.

tenantId query

Tenant ID.

ownerId query

Private storage owner identifier.

Responses
Status Code Type Description Samples
200 FolderDto

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 ID.

ownerId query

Private storage owner identifier.

body body CreateFolderDto

Create operation parameters.

Responses
Status Code Type Description Samples
201 FolderDto

Created

404 ProblemDetails

Not Found

409 ConflictDto

Conflict

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 ID.

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.

isCustom formData

Indicates if the preview is custom. Custom previews preserved even if source is changed.

Responses
Status Code Type Description Samples
200 DesignDto

Success

404 ProblemDetails

Not Found

429 ProblemDetails

Too Many Requests

401

Unauthorized

403

Forbidden

BatchCopy

Copies the specified entities and folders to another folder.

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

Tenant ID.

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 specified entities and folders.

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

Tenant ID.

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 custom fields values for the specified entities.

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

Tenant ID.

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

BatchUpdateParentFolder

Updates parent folder for the specified entities and folders.

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

Tenant ID.

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

BatchUpdateOwner

Updates owner for the specified entities and folders.

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

Source private storage owner identifier.

tenantId query

Tenant ID.

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

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 ID.

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 ID.

ownerId query

Private storage owner identifier.

Responses
Status Code Type Description Samples
200

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

PrivateImages

These endpoints are used to manage end user private images.

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 ID.

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 ID.

ownerId query

Private storage owner identifier.

metadata.isVector formData
metadata.width formData
metadata.height formData
metadata.format formData
metadata.dpiX formData
metadata.dpiY formData
metadata.pages formData
*file formData

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

Created

404 ProblemDetails

Not Found

409 ConflictDto

Conflict

429 ProblemDetails

Too Many Requests

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 ID.

ownerId query

Private storage owner identifier.

Responses
Status Code Type Description Samples
200 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 ID.

ownerId query

Private storage owner identifier.

metadata.isVector formData
metadata.width formData
metadata.height formData
metadata.format formData
metadata.dpiX formData
metadata.dpiY formData
metadata.pages formData
file formData

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 ConflictDto

Conflict

429 ProblemDetails

Too Many Requests

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 ID.

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 Rename

Conflict resolving strategy.

tenantId query

Tenant ID.

ownerId query

Private storage owner identifier.

Responses
Status Code Type Description Samples
201 ImageDto

Created

409 ConflictDto

Conflict

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 file should be provided as an attachment with proper filename supplied (default value is 'false').

tenantId query

Tenant ID.

ownerId query

Private storage owner identifier.

Responses
Status Code Type Description Samples
200 string

Success

404 ProblemDetails

Not Found

429 ProblemDetails

Too Many Requests

401

Unauthorized

403

Forbidden

GetFileStorageInfo

Returns information about the use of file storage.

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

Tenant ID.

ownerId query

Private storage owner identifier.

Responses
Status Code Type Description Samples
200 FileStorageInfoDto

Success

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 ID.

ownerId query

Private storage owner identifier.

Responses
Status Code Type Description Samples
200 FolderDto []

Success

401

Unauthorized

403

Forbidden

GetFolder

Returns a folder and its content by folder path.

Request
GET /api/storage/v1/private-images/folders/content-by-path[?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 ID.

ownerId query

Private storage owner identifier.

Responses
Status Code Type Description Samples
200 FolderContentOfImageDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

DeleteFolder

Deletes the specified folder and its content by folder path.

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

Folder full path.

tenantId query

Tenant ID.

ownerId query

Private storage owner 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/private-images/folders/{id}[?tenantId&ownerId]
Parameters
Name In Type Default Notes
*id path

Folder identifier.

tenantId query

Tenant ID.

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 ID.

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 ConflictDto

Conflict

401

Unauthorized

403

Forbidden

DeleteFolderById

Deletes the specified folder and its content by folder identifier.

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

Folder identifier.

tenantId query

Tenant ID.

ownerId query

Private storage owner identifier.

Responses
Status Code Type Description Samples
200 FolderDto

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 ID.

ownerId query

Private storage owner identifier.

body body CreateFolderDto

Create operation parameters.

Responses
Status Code Type Description Samples
201 FolderDto

Created

404 ProblemDetails

Not Found

409 ConflictDto

Conflict

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 ID.

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.

isCustom formData

Indicates if the preview is custom. Custom previews preserved even if source is changed.

Responses
Status Code Type Description Samples
200 ImageDto

Success

404 ProblemDetails

Not Found

429 ProblemDetails

Too Many Requests

401

Unauthorized

403

Forbidden

BatchCopy

Copies the specified entities and folders to another folder.

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

Tenant ID.

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 specified entities and folders.

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

Tenant ID.

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 custom fields values for the specified entities.

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

Tenant ID.

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

BatchUpdateParentFolder

Updates parent folder for the specified entities and folders.

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

Tenant ID.

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

BatchUpdateOwner

Updates owner for the specified entities and folders.

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

Source private storage owner identifier.

tenantId query

Tenant ID.

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

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 ID.

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 ID.

ownerId query

Private storage owner identifier.

Responses
Status Code Type Description Samples
200

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

PrivateMockups

These endpoints are used to manage end user private mockups.

GetAll

Returns all entities relevant to specified query parameters.

Request
GET /api/storage/v1/private-mockups[?type&path&includeSubfolders&skip&take&sorting&search&customFields&tenantId&ownerId]
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 ID.

ownerId query

Private storage owner identifier.

Responses
Status Code Type Description Samples
200 PagedOfMockupDto

Success

401

Unauthorized

403

Forbidden

Create

Creates a new entity.

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

Tenant ID.

ownerId query

Private storage owner identifier.

metadata.format formData

Mockup file format.

type formData

Mockup type.

*file formData

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

Created

404 ProblemDetails

Not Found

409 ConflictDto

Conflict

429 ProblemDetails

Too Many Requests

401

Unauthorized

403

Forbidden

Get

Returns an entity by ID.

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

Entity identifier.

tenantId query

Tenant ID.

ownerId query

Private storage owner identifier.

Responses
Status Code Type Description Samples
200 MockupDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

Update

Updates the specified entity.

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

Entity identifier.

tenantId query

Tenant ID.

ownerId query

Private storage owner identifier.

metadata.format formData

Mockup file format.

file formData

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 ConflictDto

Conflict

429 ProblemDetails

Too Many Requests

401

Unauthorized

403

Forbidden

Delete

Deletes the specified entity.

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

Entity identifier.

tenantId query

Tenant ID.

ownerId query

Private storage owner identifier.

Responses
Status Code Type Description Samples
200 MockupDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

Copy

Copies the specified entity.

Request
POST /api/storage/v1/private-mockups/{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 Rename

Conflict resolving strategy.

tenantId query

Tenant ID.

ownerId query

Private storage owner identifier.

Responses
Status Code Type Description Samples
201 MockupDto

Created

409 ConflictDto

Conflict

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

GetFile

Returns an entity file from file storage.

Request
GET /api/storage/v1/private-mockups/{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 ID.

ownerId query

Private storage owner identifier.

Responses
Status Code Type Description Samples
200 string

Success

404 ProblemDetails

Not Found

429 ProblemDetails

Too Many Requests

401

Unauthorized

403

Forbidden

GetFileStorageInfo

Returns information about the use of file storage.

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

Tenant ID.

ownerId query

Private storage owner identifier.

Responses
Status Code Type Description Samples
200 FileStorageInfoDto

Success

401

Unauthorized

403

Forbidden

GetAllFolders

Returns all folders.

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

Tenant ID.

ownerId query

Private storage owner identifier.

Responses
Status Code Type Description Samples
200 FolderDto []

Success

401

Unauthorized

403

Forbidden

GetFolder

Returns a folder and its content by folder path.

Request
GET /api/storage/v1/private-mockups/folders/content-by-path[?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 ID.

ownerId query

Private storage owner identifier.

Responses
Status Code Type Description Samples
200 FolderContentOfMockupDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

DeleteFolder

Deletes the specified folder and its content by folder path.

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

Folder full path.

tenantId query

Tenant ID.

ownerId query

Private storage owner 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/private-mockups/folders/{id}[?tenantId&ownerId]
Parameters
Name In Type Default Notes
*id path

Folder identifier.

tenantId query

Tenant ID.

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-mockups/folders/{id}[?tenantId&ownerId]
Parameters
Name In Type Default Notes
*id path

Folder identifier.

tenantId query

Tenant ID.

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 ConflictDto

Conflict

401

Unauthorized

403

Forbidden

DeleteFolderById

Deletes the specified folder and its content by folder identifier.

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

Folder identifier.

tenantId query

Tenant ID.

ownerId query

Private storage owner identifier.

Responses
Status Code Type Description Samples
200 FolderDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

CreateFolder

Creates a new folder.

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

Tenant ID.

ownerId query

Private storage owner identifier.

body body CreateFolderDto

Create operation parameters.

Responses
Status Code Type Description Samples
201 FolderDto

Created

404 ProblemDetails

Not Found

409 ConflictDto

Conflict

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-mockups/{id}/preview[?tenantId&ownerId]
Parameters
Name In Type Default Notes
*id path

Source entity identifier.

tenantId query

Tenant ID.

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.

isCustom formData

Indicates if the preview is custom. Custom previews preserved even if source is changed.

Responses
Status Code Type Description Samples
200 MockupDto

Success

404 ProblemDetails

Not Found

429 ProblemDetails

Too Many Requests

401

Unauthorized

403

Forbidden

BatchCopy

Copies the specified entities and folders to another folder.

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

Tenant ID.

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 specified entities and folders.

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

Tenant ID.

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 custom fields values for the specified entities.

Request
POST /api/storage/v1/private-mockups/batch-update-custom-fields[?tenantId&ownerId]
Parameters
Name In Type Default Notes
tenantId query

Tenant ID.

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

BatchUpdateParentFolder

Updates parent folder for the specified entities and folders.

Request
POST /api/storage/v1/private-mockups/batch-update-parent-folder[?tenantId&ownerId]
Parameters
Name In Type Default Notes
tenantId query

Tenant ID.

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

BatchUpdateOwner

Updates owner for the specified entities and folders.

Request
POST /api/storage/v1/private-mockups/batch-update-owner[?oldOwnerId&tenantId&ownerId]
Parameters
Name In Type Default Notes
oldOwnerId query

Source private storage owner identifier.

tenantId query

Tenant ID.

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

GetRetentionPolicy

Returns an entity retention policy by entity identifier.

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

Entity identifier.

tenantId query

Tenant ID.

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-mockups/{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 ID.

ownerId query

Private storage owner identifier.

Responses
Status Code Type Description Samples
200

Success

404 ProblemDetails

Not Found

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 ID.

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 ID.

ownerId query

Private storage owner identifier.

*file formData

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

Created

404 ProblemDetails

Not Found

409 ConflictDto

Conflict

429 ProblemDetails

Too Many Requests

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 ID.

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 ID.

ownerId query

Private storage owner identifier.

file formData

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 ConflictDto

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 ID.

ownerId query

Private storage owner identifier.

Responses
Status Code Type Description Samples
200 ResourceDto

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

Copy

Copies the specified entity.

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

Source entity identifier.

name query

Desired name.

namespace query

Desired namespace.

sourceId query

Desired source identifier.

strategy query Rename

Conflict resolving strategy.

tenantId query

Tenant ID.

ownerId query

Private storage owner identifier.

Responses
Status Code Type Description Samples
201 ResourceDto

Created

409 ConflictDto

Conflict

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 ID.

ownerId query

Private storage owner identifier.

Responses
Status Code Type Description Samples
200 string

Success

404 ProblemDetails

Not Found

429 ProblemDetails

Too Many Requests

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 ID.

ownerId query

Private storage owner identifier.

Responses
Status Code Type Description Samples
200 FileStorageInfoDto

Success

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 ID.

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 ID.

ownerId query

Private storage owner identifier.

Responses
Status Code Type Description Samples
200

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

BatchUpdateCustomFields

Updates custom fields values for the specified entities.

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

Tenant ID.

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

BatchCopy

Copies the specified entities.

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

Tenant ID.

ownerId query

Private storage owner identifier.

body body BatchCopyResourcesInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

409 BatchConflictDto

Conflict

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

BatchDelete

Deletes the specified entities.

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

Tenant ID.

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

BatchUpdateOwner

Updates owner for the specified entities.

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

Source private storage owner identifier.

tenantId query

Tenant ID.

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

DeleteByNamespace

Deletes all resources that use a specified namespace.

Request
DELETE /api/storage/v1/private-resources/namespaces/{namespace}[?namespace&tenantId&ownerId]
Parameters
Name In Type Default Notes
namespace query

Namespace value.

*namespace path
tenantId query

Tenant ID.

ownerId query

Private resources owner identifier.

Responses
Status Code Type Description Samples
200

Success

404 ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

Definitions

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.

PagedOfArtifactDto

DTO, containing results of paged query.

Name Type Notes
total integer (int64)

Items count

items ArtifactDto[]

Items list

ArtifactDto

Items list

Name Type Notes
size integer (int64)

File size.

descriptor string

File descriptor.

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

ConflictDto

Name Type Notes
specifier ConflictSpecifierDto[]

Information about operation conflict.

description string

Problem description.

type ConflictType

Conflict types.

ConflictSpecifierDto

Information about operation conflict.

Name Type Notes
id string

Operation conflict entity identifier.

name string

Operation conflict entity name.

path string

Operation conflict entity folder path.

ConflictType

Conflict types.

Enum Values

NameConflict FolderOverwriteConflict IdConflict GeneralConflict

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.

PagedOfColorProfileDto

DTO, containing results of paged query.

Name Type Notes
total integer (int64)

Items count

items ColorProfileDto[]

Items list

ColorProfileDto

Items list

Name Type Notes
metadata ColorProfileMetadata[]

Color profile metadata.

size integer (int64)

File size.

descriptor string

File descriptor.

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
model string
copyright string
manufacturer string
colorSpace
deviceClass

FolderDto

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.

lastModified string (date-time)

Last entity modification date and time.

FolderContentOfColorProfileDto

Folder content DTO.

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.

lastModified string (date-time)

Last entity modification date and time.

UpdateFolderDto

DTO, containing update operation parameters for a folder.

Name Type Notes
name string

Folder name.

path string

Parent folder path.

CreateFolderDto

DTO, containing create operation parameters for a folder.

Name Type Notes
name string

Folder name.

path string

Parent folder path.

BatchCopyInput

DTO, containing parameters for batch copy operation.

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 conflicts rised by existing entity ID.

Name Type Notes
entityConflicts ConflictSpecifierDto[]

List of operation conflict entity descriptions.

folderConflicts ConflictSpecifierDto[]

List of operation conflict folder descriptions.

type ConflictType

Coflict type.

description string

Problem description.

BatchDeleteInput

DTO, containing parameters for batch delete operation.

Name Type Notes
entityIds array

List of entities, which are operation subjects.

folderIds array

List of folders, which are operation subjects.

BatchUpdateCustomFieldsInput

DTO, containing parameters for a batch update custom fields values operation.

Name Type Notes
entityIds array

List of entities, which are operation subjects.

customFields object

Custom fields dictionary.

updateStrategy

Custom fields update strategy.

BatchUpdateParentFolderInput

DTO, containing parameters for batch update parent folder operation.

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.

PagedOfDataSchemaDto

DTO, containing results of paged query.

Name Type Notes
total integer (int64)

Items count

items DataSchemaDto[]

Items list

DataSchemaDto

Items list

Name Type Notes
metadata DataSchemaMetadata[]

Data schema metadata.

size integer (int64)

File size.

descriptor string

File descriptor.

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

FolderContentOfDataSchemaDto

Folder content DTO.

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).

PagedOfDataSetDto

DTO, containing results of paged query.

Name Type Notes
total integer (int64)

Items count

items DataSetDto[]

Items list

DataSetDto

Items list

Name Type Notes
metadata DataSetMetadata[]

Data set metadata.

hasProblems boolean

Indicates whether data set has any schema validation problems.

size integer (int64)

File size.

descriptor string

File descriptor.

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
dataSchemaName string
rowCount integer (int32)

FolderContentOfDataSetDto

Folder content DTO.

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).

PagedOfDesignDto

DTO, containing results of paged query.

Name Type Notes
total integer (int64)

Items count

items DesignDto[]

Items list

DesignDto

Items list

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: %preview_namespace%-%preview_name%. Value: "preview description".

size integer (int64)

File size.

descriptor string

File descriptor.

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[]
surfaces DesignSurfaceMetadata[]
printAreas DesignPrintAreaMetadata[]
hasDataSchema boolean
dataSchemaId string
dataSchemaName string
hasToggleSet boolean
toggleSetId string
toggleSetName string
hasPalettes boolean
palettes DesignPaletteMetadata[]

DesignFontMetadata

Name Type Notes
postscriptName string
family string
style string

DesignSurfaceMetadata

Name Type Notes
width number (float)
height number (float)

DesignPrintAreaMetadata

Name Type Notes
width number (float)
height number (float)

DesignPaletteMetadata

Name Type Notes
id string
name string
uid string
relation

FolderContentOfDesignDto

Folder content DTO.

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).

PagedOfDocumentDto

DTO, containing results of paged query.

Name Type Notes
total integer (int64)

Items count

items DocumentDto[]

Items list

DocumentDto

Items list

Name Type Notes
type DocumentType

Document type.

format DocumentFormatType

Document format.

size integer (int64)

File size.

descriptor string

File descriptor.

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.

DocumentType

Document type.

Enum Values

General Config ToggleSet

DocumentFormatType

Document format.

Enum Values

Binary Json Xml Protobuf

FolderContentOfDocumentDto

Folder content DTO.

Name Type Notes
id string

Folder unique identifier.

folders FolderInfoDto[]

List of contained subfolders.

entities DocumentDto[]

List of contained entities.

entitiesCount integer (int64)

Count of all contained entities (including all subfolder entities).

PagedOfFontDto

DTO, containing results of paged query.

Name Type Notes
total integer (int64)

Items count

items FontDto[]

Items list

FontDto

Items list

Name Type Notes
metadata FontMetadata[]

Font metadata.

previews object

Preview dictionary. Key: %preview_namespace%-%preview_name%. Value: "preview description".

size integer (int64)

File size.

descriptor string

File descriptor.

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
family string
style string

FolderContentOfFontDto

Folder content DTO.

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).

PagedOfImageDto

DTO, containing results of paged query.

Name Type Notes
total integer (int64)

Items count

items ImageDto[]

Items list

ImageDto

Items list

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: %preview_namespace%-%preview_name%. Value: "preview description".

size integer (int64)

File size.

descriptor string

File descriptor.

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
width integer (int32)
height integer (int32)
format string
dpiX string
dpiY string
pages ImagePageMetadata[]

ImagePageMetadata

Name Type Notes
width integer (int32)
height integer (int32)

FolderContentOfImageDto

Folder content DTO.

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).

PagedOfMockupDto

DTO, containing results of paged query.

Name Type Notes
total integer (int64)

Items count

items MockupDto[]

Items list

MockupDto

Items list

Name Type Notes
metadata MockupMetadataDto[]

Mockup metadata.

private boolean

Indicates if the mockup is private.

type MockupType

Mockup type.

previews object

Preview dictionary. Key: %preview_namespace%-%preview_name%. Value: "preview description".

size integer (int64)

File size.

descriptor string

File descriptor.

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

FolderContentOfMockupDto

Folder content DTO.

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).

PagedOfPaletteDto

DTO, containing results of paged query.

Name Type Notes
total integer (int64)

Items count

items PaletteDto[]

Items list

PaletteDto

Items list

Name Type Notes
metadata PaletteMetadata[]

Palette metadata.

previews object

Preview dictionary. Key: %preview_namespace%-%preview_name%. Value: "preview description".

size integer (int64)

File size.

descriptor string

File descriptor.

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.

PaletteMetadata

Palette metadata.

Name Type Notes
uid string

FolderContentOfPaletteDto

Folder content DTO.

Name Type Notes
id string

Folder unique identifier.

folders FolderInfoDto[]

List of contained subfolders.

entities PaletteDto[]

List of contained entities.

entitiesCount integer (int64)

Count of all contained entities (including all subfolder entities).

PagedOfPreviewDto

DTO, containing results of paged query.

Name Type Notes
total integer (int64)

Items count

items PreviewDto[]

Items list

PreviewDto

Items list

Name Type Notes
size integer (int64)

File size.

descriptor string

File descriptor.

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.

isCustom boolean

Indicates if the preview is custom. In this case, it should not be deleted when the source is changed.

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.

PagedOfResourceDto

DTO, containing results of paged query.

Name Type Notes
total integer (int64)

Items count

items ResourceDto[]

Items list

ResourceDto

Items list

Name Type Notes
size integer (int64)

File size.

descriptor string

File descriptor.

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.

BatchCopyResourcesInput

DTO, containing parameters for batch delete resources operation.

Name Type Notes
entityIds array

List of entities, which are operation subjects.

conflictStrategy

Conflict resolving strategy.

namespace string

Resource namespace.

sourceId string

Resource source identifier.

BatchDeleteResourcesInput

DTO, containing parameters for batch delete resources operation.

Name Type Notes
entityIds array

List of entities, which are operation subjects.

PagedOfTenantDto

DTO, containing results of paged query.

Name Type Notes
total integer (int64)

Items count

items TenantDto[]

Items list

TenantDto

Items list

Name Type Notes
id integer (int32)

Tenant 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

DTO, containing create operation parameters for a tenant entity.

Name Type Notes
id integer (int32)

Tenant entity desired identifier.

settings

Tenant settings.

name string

Entity name.

customFields object

Entity custom attributes.

UpdateTenantDto

DTO, containing update operation parameters for a tenant entity.

Name Type Notes
settings

Tenant settings.

name string

Entity name.

customFields object

Entity custom attributes.

BatchUpdateOwnerInput

DTO, containing parameters for batch update owner operation.

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.

RetentionPolicy

Enum Values

Unknown Never Default

BatchUpdateResourcesOwnerInput

DTO, containing parameters for batch update resources owner operation.

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.

Was this page helpful?
Thanks for your feedback!
Back to top Copyright © 2001–2024 Aurigma, Inc. All rights reserved.
Loading...
    Thank for your vote
    Your opinion is important to us. To provide details, send feedback.
    Send feedback