Asset Storage API
This API is used to manipulate assets in a storage - list them, update, delete, organize in folders, etc.
You may think of it as an abstraction of a file system. The assets (such as designs, fonts, images, etc) are similar to files, they can be organized in folders, you can perform the CRUD operations on them.
Note, on practice you won't want to create files using this API. The reason is that you are usually need not just to put a file to the system, but also get its metadata and a preview image. So to upload anything to the storage, we recommend using the import operation of the Asset Processor API service.
Api Clients
.Net Client
You can install it from Nuget as follows:
Install-Package Aurigma.AssetStorage.ApiClient
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
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
PHP Client
PHP client can be installed through composer as follows:
composer require aurigma/php-asset-storage-client
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 |
|
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: |
||
tenantId | query | Tenant identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
401 | Unauthorized |
||
403 | Forbidden |
Create
Creates a new entity.
Request
POST /api/storage/v1/artifacts[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
tenantId | query | Tenant identifier. |
||
*file | formData | 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 |
|
Success |
|
409 |
|
Conflict |
|
429 |
|
Client Error |
|
401 | Unauthorized |
||
403 | Forbidden |
Get
Returns an entity by ID.
Request
GET /api/storage/v1/artifacts/{id}[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Entity identifier. |
||
tenantId | query | Tenant identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
Not Found |
|
401 | Unauthorized |
||
403 | Forbidden |
Update
Updates the specified entity.
Request
PUT /api/storage/v1/artifacts/{id}[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Entity identifier. |
||
tenantId | query | Tenant identifier. |
||
file | formData | 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 |
|
Success |
|
404 |
|
Not Found |
|
409 |
|
Conflict |
|
429 |
|
Client Error |
|
401 | Unauthorized |
||
403 | Forbidden |
Delete
Deletes the specified entity.
Request
DELETE /api/storage/v1/artifacts/{id}[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Entity identifier. |
||
tenantId | query | Tenant identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
Not Found |
|
401 | Unauthorized |
||
403 | Forbidden |
GetFile
Returns an entity file from file storage.
Request
GET /api/storage/v1/artifacts/{id}/file[?attachment&tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Entity identifier. |
||
attachment | query | Indicates if file should be provided as an attachment with proper filename supplied (default value is 'false'). |
||
tenantId | query | Tenant identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | string | Success |
|
404 |
|
Not Found |
|
429 |
|
Client Error |
|
401 | Unauthorized |
||
403 | Forbidden |
GetFileStorageInfo
Returns information about storage usage by artifact files.
Request
GET /api/storage/v1/artifacts/file-storage-info[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
tenantId | query | Tenant identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
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 identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
404 |
|
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: |
||
tenantId | query | Tenant identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
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 identifier. |
||
metadata.description | formData | Color profile description. |
||
metadata.model | formData | Color profile model. |
||
metadata.copyright | formData | Color profile copyright. |
||
metadata.manufacturer | formData | Color profile manufacturer. |
||
metadata.colorSpace | formData | Color profile colorspace. |
||
metadata.deviceClass | formData | Color profile device class. |
||
*file | formData | File content. |
||
*path | formData | Parent folder full path. |
||
*name | formData | Entity name. |
||
customFields | formData | Entity custom attributes. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
201 |
|
Success |
|
409 |
|
Conflict |
|
429 |
|
Client Error |
|
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 identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
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 identifier. |
||
metadata.description | formData | Color profile description. |
||
metadata.model | formData | Color profile model. |
||
metadata.copyright | formData | Color profile copyright. |
||
metadata.manufacturer | formData | Color profile manufacturer. |
||
metadata.colorSpace | formData | Color profile colorspace. |
||
metadata.deviceClass | formData | Color profile device class. |
||
file | formData | File content. |
||
path | formData | Parent folder full path. |
||
name | formData | Entity name. |
||
customFields | formData | Entity custom attributes. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
Not Found |
|
409 |
|
Conflict |
|
429 |
|
Client Error |
|
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 identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
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 | Conflict resolving strategy. |
||
tenantId | query | Tenant identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
201 |
|
Success |
|
409 |
|
Conflict |
|
404 |
|
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 identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | string | Success |
|
404 |
|
Not Found |
|
429 |
|
Client Error |
|
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 identifier. |
||
body | body |
|
Operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
409 |
|
Conflict |
|
404 |
|
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 identifier. |
||
body | body |
|
Operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
404 |
|
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 identifier. |
||
body | body |
|
Operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
404 |
|
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 identifier. |
||
body | body |
|
Operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
409 |
|
Conflict |
|
404 |
|
Not Found |
|
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 identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
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 identifier. |
||
body | body |
|
Create operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
201 |
|
Success |
|
409 |
|
Conflict |
|
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 identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
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 identifier. |
||
body | body |
|
Operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
Not Found |
|
409 |
|
Conflict |
|
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 identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
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 identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
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 identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
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: |
||
tenantId | query | Tenant identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
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 identifier. |
||
metadata.fields | formData | DataSchema fields. |
||
*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 |
|
Success |
|
409 |
|
Conflict |
|
429 |
|
Client Error |
|
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 identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
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 identifier. |
||
metadata.fields | formData | DataSchema fields. |
||
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 |
|
Success |
|
404 |
|
Not Found |
|
409 |
|
Conflict |
|
429 |
|
Client Error |
|
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 identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
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 | Conflict resolving strategy. |
||
tenantId | query | Tenant identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
201 |
|
Success |
|
409 |
|
Conflict |
|
404 |
|
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 identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | string | Success |
|
404 |
|
Not Found |
|
429 |
|
Client Error |
|
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 identifier. |
||
body | body |
|
Operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
409 |
|
Conflict |
|
404 |
|
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 identifier. |
||
body | body |
|
Operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
404 |
|
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 identifier. |
||
body | body |
|
Operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
404 |
|
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 identifier. |
||
body | body |
|
Operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
409 |
|
Conflict |
|
404 |
|
Not Found |
|
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 identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
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 identifier. |
||
body | body |
|
Create operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
201 |
|
Success |
|
409 |
|
Conflict |
|
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 identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
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 identifier. |
||
body | body |
|
Operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
Not Found |
|
409 |
|
Conflict |
|
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 identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
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 identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
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 identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
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: |
||
tenantId | query | Tenant identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
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 identifier. |
||
metadata.dataSchemaId | formData | DataSet data schema id. Empty string for embedded schema. |
||
metadata.dataSchemaName | formData | DataSet data schema name. |
||
metadata.rowCount | formData | Row count. |
||
hasProblems | formData | Indicates whether data set has any schema validation problems. |
||
*file | formData | File content. |
||
*path | formData | Parent folder full path. |
||
*name | formData | Entity name. |
||
customFields | formData | Entity custom attributes. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
201 |
|
Success |
|
409 |
|
Conflict |
|
429 |
|
Client Error |
|
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 identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
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 identifier. |
||
metadata.dataSchemaId | formData | DataSet data schema id. Empty string for embedded schema. |
||
metadata.dataSchemaName | formData | DataSet data schema name. |
||
metadata.rowCount | formData | Row count. |
||
hasProblems | formData | Indicates whether data set has any schema validation problems. |
||
file | formData | File content. |
||
path | formData | Parent folder full path. |
||
name | formData | Entity name. |
||
customFields | formData | Entity custom attributes. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
Not Found |
|
409 |
|
Conflict |
|
429 |
|
Client Error |
|
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 identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
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 | Conflict resolving strategy. |
||
tenantId | query | Tenant identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
201 |
|
Success |
|
409 |
|
Conflict |
|
404 |
|
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 identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | string | Success |
|
404 |
|
Not Found |
|
429 |
|
Client Error |
|
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 identifier. |
||
body | body |
|
Operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
409 |
|
Conflict |
|
404 |
|
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 identifier. |
||
body | body |
|
Operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
404 |
|
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 identifier. |
||
body | body |
|
Operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
404 |
|
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 identifier. |
||
body | body |
|
Operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
409 |
|
Conflict |
|
404 |
|
Not Found |
|
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 identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
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 identifier. |
||
body | body |
|
Create operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
201 |
|
Success |
|
409 |
|
Conflict |
|
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 identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
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 identifier. |
||
body | body |
|
Operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
Not Found |
|
409 |
|
Conflict |
|
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 identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
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 identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
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 identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
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&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. |
||
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: |
||
tenantId | query | Tenant identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
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 identifier. |
||
id | formData | Desired unique design identifier for a new design. |
||
metadata.fonts | formData | Design font metadata list. |
||
metadata.surfaces | formData | Design surface metadata list. |
||
metadata.printAreas | formData | Design print area metadata list. |
||
metadata.hasDataSchema | formData | Indicates whether design has data schema. |
||
metadata.dataSchemaId | formData | Design data schema identifier. Empty string for embedded schema. |
||
metadata.dataSchemaName | formData | Design data schema name. |
||
metadata.hasToggleSet | formData | Indicates whether design has toggle set. |
||
metadata.toggleSetId | formData | Design toggle set identifier. Empty string for embedded schema. |
||
metadata.toggleSetName | formData | Design toggle set name. |
||
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 |
|
Success |
|
409 |
|
Conflict |
|
429 |
|
Client Error |
|
401 | Unauthorized |
||
403 | Forbidden |
Get
Returns an entity by ID.
Request
GET /api/storage/v1/designs/{id}[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Entity identifier. |
||
tenantId | query | Tenant identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
Not Found |
|
401 | Unauthorized |
||
403 | Forbidden |
Update
Updates the specified entity.
Request
PUT /api/storage/v1/designs/{id}[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Entity identifier. |
||
tenantId | query | Tenant identifier. |
||
metadata.fonts | formData | Design font metadata list. |
||
metadata.surfaces | formData | Design surface metadata list. |
||
metadata.printAreas | formData | Design print area metadata list. |
||
metadata.hasDataSchema | formData | Indicates whether design has data schema. |
||
metadata.dataSchemaId | formData | Design data schema identifier. Empty string for embedded schema. |
||
metadata.dataSchemaName | formData | Design data schema name. |
||
metadata.hasToggleSet | formData | Indicates whether design has toggle set. |
||
metadata.toggleSetId | formData | Design toggle set identifier. Empty string for embedded schema. |
||
metadata.toggleSetName | formData | Design toggle set name. |
||
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 |
|
Success |
|
404 |
|
Not Found |
|
409 |
|
Conflict |
|
429 |
|
Client Error |
|
401 | Unauthorized |
||
403 | Forbidden |
Delete
Deletes the specified entity.
Request
DELETE /api/storage/v1/designs/{id}[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Entity identifier. |
||
tenantId | query | Tenant identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
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 | Conflict resolving strategy. |
||
tenantId | query | Tenant identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
201 |
|
Success |
|
409 |
|
Conflict |
|
404 |
|
Not Found |
|
401 | Unauthorized |
||
403 | Forbidden |
GetFile
Returns an entity file from file storage.
Request
GET /api/storage/v1/designs/{id}/file[?attachment&tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Entity identifier. |
||
attachment | query | Indicates if file should be provided as an attachment with proper filename supplied (default value is 'false'). |
||
tenantId | query | Tenant identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | string | Success |
|
404 |
|
Not Found |
|
429 |
|
Client Error |
|
401 | Unauthorized |
||
403 | Forbidden |
AddPreview
Creates a preview entity for specified source entity.
If a preview entity with specified namespace and name already exists it will be overwritten.
Request
PUT /api/storage/v1/designs/{id}/preview[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Source entity identifier. |
||
tenantId | query | Tenant identifier. |
||
*name | formData | Preview name. |
||
*namespace | formData | Preview namespace. |
||
*width | formData | Preview image width. |
||
*height | formData | Preview image height. |
||
format | formData | Preview image format, e.g. Jpeg, Png, Bmp. |
||
file | formData | Preview file content. |
||
isCustom | formData | Indicates if the preview is custom. Custom previews preserved even if source is changed. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
Not Found |
|
429 |
|
Client Error |
|
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 identifier. |
||
body | body |
|
Operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
409 |
|
Conflict |
|
404 |
|
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 identifier. |
||
body | body |
|
Operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
404 |
|
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 identifier. |
||
body | body |
|
Operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
404 |
|
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 identifier. |
||
body | body |
|
Operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
409 |
|
Conflict |
|
404 |
|
Not Found |
|
401 | Unauthorized |
||
403 | Forbidden |
GetFileStorageInfo
Returns information about the use of file storage.
Request
GET /api/storage/v1/designs/file-storage-info[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
tenantId | query | Tenant identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
401 | Unauthorized |
||
403 | Forbidden |
CreateFolder
Creates a new folder.
Request
POST /api/storage/v1/designs/folders[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
tenantId | query | Tenant identifier. |
||
body | body |
|
Create operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
201 |
|
Success |
|
409 |
|
Conflict |
|
401 | Unauthorized |
||
403 | Forbidden |
GetFolderInfo
Returns a folder by ID.
Request
GET /api/storage/v1/designs/folders/{id}[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Folder identifier. |
||
tenantId | query | Tenant identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
Not Found |
|
401 | Unauthorized |
||
403 | Forbidden |
UpdateFolder
Updates the specified folder.
Request
PUT /api/storage/v1/designs/folders/{id}[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Folder identifier. |
||
tenantId | query | Tenant identifier. |
||
body | body |
|
Operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
Not Found |
|
409 |
|
Conflict |
|
401 | Unauthorized |
||
403 | Forbidden |
GetAllFolders
Returns all folders.
Request
GET /api/storage/v1/designs/folders/all[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
tenantId | query | Tenant identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
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 identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
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 identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
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: |
||
tenantId | query | Tenant identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
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 identifier. |
||
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 |
|
Success |
|
409 |
|
Conflict |
|
429 |
|
Client Error |
|
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 identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
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 identifier. |
||
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 |
|
Success |
|
404 |
|
Not Found |
|
409 |
|
Conflict |
|
429 |
|
Client Error |
|
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 identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
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 | Conflict resolving strategy. |
||
tenantId | query | Tenant identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
201 |
|
Success |
|
409 |
|
Conflict |
|
404 |
|
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 identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | string | Success |
|
404 |
|
Not Found |
|
429 |
|
Client Error |
|
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 identifier. |
||
body | body |
|
Operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
409 |
|
Conflict |
|
404 |
|
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 identifier. |
||
body | body |
|
Operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
404 |
|
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 identifier. |
||
body | body |
|
Operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
404 |
|
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 identifier. |
||
body | body |
|
Operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
409 |
|
Conflict |
|
404 |
|
Not Found |
|
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 identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
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 identifier. |
||
body | body |
|
Create operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
201 |
|
Success |
|
409 |
|
Conflict |
|
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 identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
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 identifier. |
||
body | body |
|
Operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
Not Found |
|
409 |
|
Conflict |
|
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 identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
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 identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
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 identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
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: |
||
tenantId | query | Tenant identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
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 identifier. |
||
metadata.postscriptName | formData | Font postscript name. |
||
metadata.family | formData | Font family name. |
||
metadata.style | formData | Font style. |
||
*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 |
|
Success |
|
409 |
|
Conflict |
|
429 |
|
Client Error |
|
401 | Unauthorized |
||
403 | Forbidden |
Get
Returns an entity by ID.
Request
GET /api/storage/v1/fonts/{id}[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Entity identifier. |
||
tenantId | query | Tenant identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
Not Found |
|
401 | Unauthorized |
||
403 | Forbidden |
Update
Updates the specified entity.
Request
PUT /api/storage/v1/fonts/{id}[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Entity identifier. |
||
tenantId | query | Tenant identifier. |
||
metadata.postscriptName | formData | Font postscript name. |
||
metadata.family | formData | Font family name. |
||
metadata.style | formData | Font style. |
||
file | formData | File content. |
||
path | formData | Parent folder full path. |
||
name | formData | Entity name. |
||
customFields | formData | Entity custom attributes. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
Not Found |
|
409 |
|
Conflict |
|
429 |
|
Client Error |
|
401 | Unauthorized |
||
403 | Forbidden |
Delete
Deletes the specified entity.
Request
DELETE /api/storage/v1/fonts/{id}[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Entity identifier. |
||
tenantId | query | Tenant identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
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 | Conflict resolving strategy. |
||
tenantId | query | Tenant identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
201 |
|
Success |
|
409 |
|
Conflict |
|
404 |
|
Not Found |
|
401 | Unauthorized |
||
403 | Forbidden |
GetFile
Returns an entity file from file storage.
Request
GET /api/storage/v1/fonts/{id}/file[?attachment&tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Entity identifier. |
||
attachment | query | Indicates if file should be provided as an attachment with proper filename supplied (default value is 'false'). |
||
tenantId | query | Tenant identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | string | Success |
|
404 |
|
Not Found |
|
429 |
|
Client Error |
|
401 | Unauthorized |
||
403 | Forbidden |
AddPreview
Creates a preview entity for specified source entity.
If a preview entity with specified namespace and name already exists it will be overwritten.
Request
PUT /api/storage/v1/fonts/{id}/preview[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Source entity identifier. |
||
tenantId | query | Tenant identifier. |
||
*name | formData | Preview name. |
||
*namespace | formData | Preview namespace. |
||
*width | formData | Preview image width. |
||
*height | formData | Preview image height. |
||
format | formData | Preview image format, e.g. Jpeg, Png, Bmp. |
||
file | formData | Preview file content. |
||
isCustom | formData | Indicates if the preview is custom. Custom previews preserved even if source is changed. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
Not Found |
|
429 |
|
Client Error |
|
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 identifier. |
||
body | body |
|
Operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
409 |
|
Conflict |
|
404 |
|
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 identifier. |
||
body | body |
|
Operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
404 |
|
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 identifier. |
||
body | body |
|
Operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
404 |
|
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 identifier. |
||
body | body |
|
Operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
409 |
|
Conflict |
|
404 |
|
Not Found |
|
401 | Unauthorized |
||
403 | Forbidden |
GetFileStorageInfo
Returns information about the use of file storage.
Request
GET /api/storage/v1/fonts/file-storage-info[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
tenantId | query | Tenant identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
401 | Unauthorized |
||
403 | Forbidden |
CreateFolder
Creates a new folder.
Request
POST /api/storage/v1/fonts/folders[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
tenantId | query | Tenant identifier. |
||
body | body |
|
Create operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
201 |
|
Success |
|
409 |
|
Conflict |
|
401 | Unauthorized |
||
403 | Forbidden |
GetFolderInfo
Returns a folder by ID.
Request
GET /api/storage/v1/fonts/folders/{id}[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Folder identifier. |
||
tenantId | query | Tenant identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
Not Found |
|
401 | Unauthorized |
||
403 | Forbidden |
UpdateFolder
Updates the specified folder.
Request
PUT /api/storage/v1/fonts/folders/{id}[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Folder identifier. |
||
tenantId | query | Tenant identifier. |
||
body | body |
|
Operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
Not Found |
|
409 |
|
Conflict |
|
401 | Unauthorized |
||
403 | Forbidden |
GetAllFolders
Returns all folders.
Request
GET /api/storage/v1/fonts/folders/all[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
tenantId | query | Tenant identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
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 identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
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 identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
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: |
||
tenantId | query | Tenant identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
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 identifier. |
||
metadata.isVector | formData | Indicates whether image is vector. |
||
metadata.width | formData | Image width. |
||
metadata.height | formData | Image height. |
||
metadata.format | formData | Image format, e.g. Jpeg, Png, Bmp... |
||
metadata.dpiX | formData | Image horizontal dpi. |
||
metadata.dpiY | formData | Image vertical dpi. |
||
metadata.pages | formData | Image page metadata list (for multipaged images, like pdf). |
||
*file | formData | File content. |
||
*path | formData | Parent folder full path. |
||
*name | formData | Entity name. |
||
customFields | formData | Entity custom attributes. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
201 |
|
Success |
|
409 |
|
Conflict |
|
429 |
|
Client Error |
|
401 | Unauthorized |
||
403 | Forbidden |
Get
Returns an entity by ID.
Request
GET /api/storage/v1/images/{id}[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Entity identifier. |
||
tenantId | query | Tenant identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
Not Found |
|
401 | Unauthorized |
||
403 | Forbidden |
Update
Updates the specified entity.
Request
PUT /api/storage/v1/images/{id}[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Entity identifier. |
||
tenantId | query | Tenant identifier. |
||
metadata.isVector | formData | Indicates whether image is vector. |
||
metadata.width | formData | Image width. |
||
metadata.height | formData | Image height. |
||
metadata.format | formData | Image format, e.g. Jpeg, Png, Bmp... |
||
metadata.dpiX | formData | Image horizontal dpi. |
||
metadata.dpiY | formData | Image vertical dpi. |
||
metadata.pages | formData | Image page metadata list (for multipaged images, like pdf). |
||
file | formData | File content. |
||
path | formData | Parent folder full path. |
||
name | formData | Entity name. |
||
customFields | formData | Entity custom attributes. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
Not Found |
|
409 |
|
Conflict |
|
429 |
|
Client Error |
|
401 | Unauthorized |
||
403 | Forbidden |
Delete
Deletes the specified entity.
Request
DELETE /api/storage/v1/images/{id}[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Entity identifier. |
||
tenantId | query | Tenant identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
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 | Conflict resolving strategy. |
||
tenantId | query | Tenant identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
201 |
|
Success |
|
409 |
|
Conflict |
|
404 |
|
Not Found |
|
401 | Unauthorized |
||
403 | Forbidden |
GetFile
Returns an entity file from file storage.
Request
GET /api/storage/v1/images/{id}/file[?attachment&tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Entity identifier. |
||
attachment | query | Indicates if file should be provided as an attachment with proper filename supplied (default value is 'false'). |
||
tenantId | query | Tenant identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | string | Success |
|
404 |
|
Not Found |
|
429 |
|
Client Error |
|
401 | Unauthorized |
||
403 | Forbidden |
AddPreview
Creates a preview entity for specified source entity.
If a preview entity with specified namespace and name already exists it will be overwritten.
Request
PUT /api/storage/v1/images/{id}/preview[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Source entity identifier. |
||
tenantId | query | Tenant identifier. |
||
*name | formData | Preview name. |
||
*namespace | formData | Preview namespace. |
||
*width | formData | Preview image width. |
||
*height | formData | Preview image height. |
||
format | formData | Preview image format, e.g. Jpeg, Png, Bmp. |
||
file | formData | Preview file content. |
||
isCustom | formData | Indicates if the preview is custom. Custom previews preserved even if source is changed. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
Not Found |
|
429 |
|
Client Error |
|
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 identifier. |
||
body | body |
|
Operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
409 |
|
Conflict |
|
404 |
|
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 identifier. |
||
body | body |
|
Operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
404 |
|
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 identifier. |
||
body | body |
|
Operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
404 |
|
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 identifier. |
||
body | body |
|
Operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
409 |
|
Conflict |
|
404 |
|
Not Found |
|
401 | Unauthorized |
||
403 | Forbidden |
GetFileStorageInfo
Returns information about the use of file storage.
Request
GET /api/storage/v1/images/file-storage-info[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
tenantId | query | Tenant identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
401 | Unauthorized |
||
403 | Forbidden |
CreateFolder
Creates a new folder.
Request
POST /api/storage/v1/images/folders[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
tenantId | query | Tenant identifier. |
||
body | body |
|
Create operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
201 |
|
Success |
|
409 |
|
Conflict |
|
401 | Unauthorized |
||
403 | Forbidden |
GetFolderInfo
Returns a folder by ID.
Request
GET /api/storage/v1/images/folders/{id}[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Folder identifier. |
||
tenantId | query | Tenant identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
Not Found |
|
401 | Unauthorized |
||
403 | Forbidden |
UpdateFolder
Updates the specified folder.
Request
PUT /api/storage/v1/images/folders/{id}[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Folder identifier. |
||
tenantId | query | Tenant identifier. |
||
body | body |
|
Operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
Not Found |
|
409 |
|
Conflict |
|
401 | Unauthorized |
||
403 | Forbidden |
GetAllFolders
Returns all folders.
Request
GET /api/storage/v1/images/folders/all[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
tenantId | query | Tenant identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
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 identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
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 identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
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: |
||
tenantId | query | Tenant identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
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 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 |
|
Success |
|
409 |
|
Conflict |
|
429 |
|
Client Error |
|
401 | Unauthorized |
||
403 | Forbidden |
Get
Returns an entity by ID.
Request
GET /api/storage/v1/mockups/{id}[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Entity identifier. |
||
tenantId | query | Tenant identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
Not Found |
|
401 | Unauthorized |
||
403 | Forbidden |
Update
Updates the specified entity.
Request
PUT /api/storage/v1/mockups/{id}[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Entity identifier. |
||
tenantId | query | Tenant identifier. |
||
metadata.format | formData | Mockup file format. |
||
file | formData | File content. |
||
path | formData | Parent folder full path. |
||
name | formData | Entity name. |
||
customFields | formData | Entity custom attributes. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
Not Found |
|
409 |
|
Conflict |
|
429 |
|
Client Error |
|
401 | Unauthorized |
||
403 | Forbidden |
Delete
Deletes the specified entity.
Request
DELETE /api/storage/v1/mockups/{id}[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Entity identifier. |
||
tenantId | query | Tenant identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
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 | Conflict resolving strategy. |
||
tenantId | query | Tenant identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
201 |
|
Success |
|
409 |
|
Conflict |
|
404 |
|
Not Found |
|
401 | Unauthorized |
||
403 | Forbidden |
GetFile
Returns an entity file from file storage.
Request
GET /api/storage/v1/mockups/{id}/file[?attachment&tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Entity identifier. |
||
attachment | query | Indicates if file should be provided as an attachment with proper filename supplied (default value is 'false'). |
||
tenantId | query | Tenant identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | string | Success |
|
404 |
|
Not Found |
|
429 |
|
Client Error |
|
401 | Unauthorized |
||
403 | Forbidden |
AddPreview
Creates a preview entity for specified source entity.
If a preview entity with specified namespace and name already exists it will be overwritten.
Request
PUT /api/storage/v1/mockups/{id}/preview[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Source entity identifier. |
||
tenantId | query | Tenant identifier. |
||
*name | formData | Preview name. |
||
*namespace | formData | Preview namespace. |
||
*width | formData | Preview image width. |
||
*height | formData | Preview image height. |
||
format | formData | Preview image format, e.g. Jpeg, Png, Bmp. |
||
file | formData | Preview file content. |
||
isCustom | formData | Indicates if the preview is custom. Custom previews preserved even if source is changed. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
Not Found |
|
429 |
|
Client Error |
|
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 identifier. |
||
body | body |
|
Operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
409 |
|
Conflict |
|
404 |
|
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 identifier. |
||
body | body |
|
Operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
404 |
|
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 identifier. |
||
body | body |
|
Operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
404 |
|
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 identifier. |
||
body | body |
|
Operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
409 |
|
Conflict |
|
404 |
|
Not Found |
|
401 | Unauthorized |
||
403 | Forbidden |
GetFileStorageInfo
Returns information about the use of file storage.
Request
GET /api/storage/v1/mockups/file-storage-info[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
tenantId | query | Tenant identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
401 | Unauthorized |
||
403 | Forbidden |
CreateFolder
Creates a new folder.
Request
POST /api/storage/v1/mockups/folders[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
tenantId | query | Tenant identifier. |
||
body | body |
|
Create operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
201 |
|
Success |
|
409 |
|
Conflict |
|
401 | Unauthorized |
||
403 | Forbidden |
GetFolderInfo
Returns a folder by ID.
Request
GET /api/storage/v1/mockups/folders/{id}[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Folder identifier. |
||
tenantId | query | Tenant identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
Not Found |
|
401 | Unauthorized |
||
403 | Forbidden |
UpdateFolder
Updates the specified folder.
Request
PUT /api/storage/v1/mockups/folders/{id}[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Folder identifier. |
||
tenantId | query | Tenant identifier. |
||
body | body |
|
Operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
Not Found |
|
409 |
|
Conflict |
|
401 | Unauthorized |
||
403 | Forbidden |
GetAllFolders
Returns all folders.
Request
GET /api/storage/v1/mockups/folders/all[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
tenantId | query | Tenant identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
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 identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
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 identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
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 identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
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 identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
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 identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
Not Found |
|
401 | Unauthorized |
||
403 | Forbidden |
GetFile
Returns a preview entity file from file storage.
Request
GET /api/storage/v1/previews/{id}/file[?attachment&tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Preview entity identifier. |
||
attachment | query | Indicates if file should be provided as an attachment with proper filename supplied (default value is 'false'). |
||
tenantId | query | Tenant identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | string | Success |
|
404 |
|
Not Found |
|
429 |
|
Client Error |
GetFileStorageInfo
Returns information about storage usage by preview files.
Request
GET /api/storage/v1/previews/file-storage-info[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
tenantId | query | Tenant identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
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: |
||
tenantId | query | Tenant identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
401 | Unauthorized |
||
403 | Forbidden |
Create
Creates a new entity.
Request
POST /api/storage/v1/resources[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
tenantId | query | Tenant identifier. |
||
*file | formData | 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 |
|
Success |
|
409 |
|
Conflict |
|
429 |
|
Client Error |
|
401 | Unauthorized |
||
403 | Forbidden |
Get
Returns an entity by ID.
Request
GET /api/storage/v1/resources/{id}[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Entity identifier. |
||
tenantId | query | Tenant identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
Not Found |
|
401 | Unauthorized |
||
403 | Forbidden |
Update
Updates the specified entity.
Request
PUT /api/storage/v1/resources/{id}[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Entity identifier. |
||
tenantId | query | Tenant identifier. |
||
file | formData | 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 |
|
Success |
|
404 |
|
Not Found |
|
409 |
|
Conflict |
|
429 |
|
Client Error |
|
401 | Unauthorized |
||
403 | Forbidden |
Delete
Deletes the specified entity.
Request
DELETE /api/storage/v1/resources/{id}[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Entity identifier. |
||
tenantId | query | Tenant identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
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 | Conflict resolving strategy. |
||
tenantId | query | Tenant identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
201 |
|
Success |
|
409 |
|
Conflict |
|
404 |
|
Not Found |
|
401 | Unauthorized |
||
403 | Forbidden |
GetFile
Returns an entity file from file storage.
Request
GET /api/storage/v1/resources/{id}/file[?attachment&tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Entity identifier. |
||
attachment | query | Indicates if file should be provided as an attachment with proper filename supplied (default value is 'false'). |
||
tenantId | query | Tenant identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | string | Success |
|
404 |
|
Not Found |
|
429 |
|
Client Error |
|
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 identifier. |
||
body | body |
|
Operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
409 |
|
Conflict |
|
404 |
|
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 identifier. |
||
body | body |
|
Operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
404 |
|
Not Found |
|
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 identifier. |
||
body | body |
|
Operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
404 |
|
Not Found |
|
401 | Unauthorized |
||
403 | Forbidden |
GetFileStorageInfo
Returns information about storage usage by resource files.
Request
GET /api/storage/v1/resources/file-storage-info[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
tenantId | query | Tenant identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
401 | Unauthorized |
||
403 | Forbidden |
Tenants
These endpoints are used to manage tenants.
GetAll
Returns all tenants.
Request
GET /api/storage/v1/tenants[?skip&take&sorting&search&customFields]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
skip | query | Defines page start offset from beginning of sorted result list. |
||
take | query | Defines page length (how much consequent items of sorted result list should be taken). |
||
sorting | query | Defines sorting order of result list e.g.: "Title ASC, LastModified DESC". |
||
search | query | Search string for partial match. |
||
customFields | query | Custom attributes dictionary filter. For example: |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
401 | Unauthorized |
||
403 | Forbidden |
Create
Creates a new tenant.
Request
POST /api/storage/v1/tenants
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
body | body |
|
Operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
201 |
|
Success |
|
409 |
|
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 |
|
Success |
|
404 |
|
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 |
|
Operation parameters |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
Not Found |
|
409 |
|
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 |
|
Success |
|
404 |
|
Not Found |
|
401 | Unauthorized |
||
403 | Forbidden |
CleanUp
Forcefully starts obsolete assets clean-up as background job.
Request
POST /api/storage/v1/tenants/{id}/clean-up
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Tenant identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
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&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. |
||
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: |
||
tenantId | query | Tenant identifier. |
||
ownerId | query | Private storage owner identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
401 | Unauthorized |
||
403 | Forbidden |
Create
Creates a new entity.
Request
POST /api/storage/v1/private-designs[?tenantId&ownerId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
tenantId | query | Tenant identifier. |
||
ownerId | query | Private storage owner identifier. |
||
id | formData | Desired unique design identifier for a new design. |
||
metadata.fonts | formData | Design font metadata list. |
||
metadata.surfaces | formData | Design surface metadata list. |
||
metadata.printAreas | formData | Design print area metadata list. |
||
metadata.hasDataSchema | formData | Indicates whether design has data schema. |
||
metadata.dataSchemaId | formData | Design data schema identifier. Empty string for embedded schema. |
||
metadata.dataSchemaName | formData | Design data schema name. |
||
metadata.hasToggleSet | formData | Indicates whether design has toggle set. |
||
metadata.toggleSetId | formData | Design toggle set identifier. Empty string for embedded schema. |
||
metadata.toggleSetName | formData | Design toggle set name. |
||
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 |
|
Success |
|
409 |
|
Conflict |
|
429 |
|
Client Error |
|
401 | Unauthorized |
||
403 | Forbidden |
Get
Returns an entity by ID.
Request
GET /api/storage/v1/private-designs/{id}[?tenantId&ownerId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Entity identifier. |
||
tenantId | query | Tenant identifier. |
||
ownerId | query | Private storage owner identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
Not Found |
|
401 | Unauthorized |
||
403 | Forbidden |
Update
Updates the specified entity.
Request
PUT /api/storage/v1/private-designs/{id}[?tenantId&ownerId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Entity identifier. |
||
tenantId | query | Tenant identifier. |
||
ownerId | query | Private storage owner identifier. |
||
metadata.fonts | formData | Design font metadata list. |
||
metadata.surfaces | formData | Design surface metadata list. |
||
metadata.printAreas | formData | Design print area metadata list. |
||
metadata.hasDataSchema | formData | Indicates whether design has data schema. |
||
metadata.dataSchemaId | formData | Design data schema identifier. Empty string for embedded schema. |
||
metadata.dataSchemaName | formData | Design data schema name. |
||
metadata.hasToggleSet | formData | Indicates whether design has toggle set. |
||
metadata.toggleSetId | formData | Design toggle set identifier. Empty string for embedded schema. |
||
metadata.toggleSetName | formData | Design toggle set name. |
||
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 |
|
Success |
|
404 |
|
Not Found |
|
409 |
|
Conflict |
|
429 |
|
Client Error |
|
401 | Unauthorized |
||
403 | Forbidden |
Delete
Deletes the specified entity.
Request
DELETE /api/storage/v1/private-designs/{id}[?tenantId&ownerId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Entity identifier. |
||
tenantId | query | Tenant identifier. |
||
ownerId | query | Private storage owner identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
Not Found |
|
401 | Unauthorized |
||
403 | Forbidden |
Copy
Copies the specified entity.
Request
POST /api/storage/v1/private-designs/{id}[?path&name&strategy&tenantId&ownerId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Source entity identifier. |
||
path | query | Desired path. |
||
name | query | Desired name. |
||
strategy | query | Conflict resolving strategy. |
||
tenantId | query | Tenant identifier. |
||
ownerId | query | Private storage owner identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
201 |
|
Success |
|
409 |
|
Conflict |
|
404 |
|
Not Found |
|
401 | Unauthorized |
||
403 | Forbidden |
GetFile
Returns an entity file from file storage.
Request
GET /api/storage/v1/private-designs/{id}/file[?attachment&tenantId&ownerId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Entity identifier. |
||
attachment | query | Indicates if file should be provided as an attachment with proper filename supplied (default value is 'false'). |
||
tenantId | query | Tenant identifier. |
||
ownerId | query | Private storage owner identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | string | Success |
|
404 |
|
Not Found |
|
429 |
|
Client Error |
|
401 | Unauthorized |
||
403 | Forbidden |
AddPreview
Creates a preview entity for specified source entity.
If a preview entity with specified namespace and name already exists it will be overwritten.
Request
PUT /api/storage/v1/private-designs/{id}/preview[?tenantId&ownerId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Source entity identifier. |
||
tenantId | query | Tenant identifier. |
||
ownerId | query | Private storage owner identifier. |
||
*name | formData | Preview name. |
||
*namespace | formData | Preview namespace. |
||
*width | formData | Preview image width. |
||
*height | formData | Preview image height. |
||
format | formData | Preview image format, e.g. Jpeg, Png, Bmp. |
||
file | formData | Preview file content. |
||
isCustom | formData | Indicates if the preview is custom. Custom previews preserved even if source is changed. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
Not Found |
|
429 |
|
Client Error |
|
401 | Unauthorized |
||
403 | Forbidden |
GetRetentionPolicy
Returns an entity retention policy by entity identifier.
Request
GET /api/storage/v1/private-designs/{id}/retention-policy[?tenantId&ownerId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Entity identifier. |
||
tenantId | query | Tenant identifier. |
||
ownerId | query | Private storage owner identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
Not Found |
|
401 | Unauthorized |
||
403 | Forbidden |
SetRetentionPolicy
Updates an entity retention policy by entity identifier.
Request
POST /api/storage/v1/private-designs/{id}/retention-policy[?policy&tenantId&ownerId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Entity identifier. |
||
policy | query | New entity retention policy. |
||
tenantId | query | Tenant identifier. |
||
ownerId | query | Private storage owner identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
404 |
|
Not Found |
|
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 identifier. |
||
ownerId | query | Private storage owner identifier. |
||
body | body |
|
Operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
409 |
|
Conflict |
|
404 |
|
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 identifier. |
||
ownerId | query | Private storage owner identifier. |
||
body | body |
|
Operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
404 |
|
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 identifier. |
||
ownerId | query | Private storage owner identifier. |
||
body | body |
|
Operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
404 |
|
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 identifier. |
||
ownerId | query | New private storage owner identifier. |
||
body | body |
|
Operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
409 |
|
Conflict |
|
404 |
|
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 identifier. |
||
ownerId | query | Private storage owner identifier. |
||
body | body |
|
Operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
409 |
|
Conflict |
|
404 |
|
Not Found |
|
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 identifier. |
||
ownerId | query | Private storage owner identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
401 | Unauthorized |
||
403 | Forbidden |
CreateFolder
Creates a new folder.
Request
POST /api/storage/v1/private-designs/folders[?tenantId&ownerId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
tenantId | query | Tenant identifier. |
||
ownerId | query | Private storage owner identifier. |
||
body | body |
|
Create operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
201 |
|
Success |
|
409 |
|
Conflict |
|
401 | Unauthorized |
||
403 | Forbidden |
GetFolderInfo
Returns a folder by ID.
Request
GET /api/storage/v1/private-designs/folders/{id}[?tenantId&ownerId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Folder identifier. |
||
tenantId | query | Tenant identifier. |
||
ownerId | query | Private storage owner identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
Not Found |
|
401 | Unauthorized |
||
403 | Forbidden |
UpdateFolder
Updates the specified folder.
Request
PUT /api/storage/v1/private-designs/folders/{id}[?tenantId&ownerId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Folder identifier. |
||
tenantId | query | Tenant identifier. |
||
ownerId | query | Private storage owner identifier. |
||
body | body |
|
Operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
Not Found |
|
409 |
|
Conflict |
|
401 | Unauthorized |
||
403 | Forbidden |
GetAllFolders
Returns all folders.
Request
GET /api/storage/v1/private-designs/folders/all[?tenantId&ownerId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
tenantId | query | Tenant identifier. |
||
ownerId | query | Private storage owner identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
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 identifier. |
||
ownerId | query | Private storage owner identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
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 identifier. |
||
ownerId | query | Private storage owner identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
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: |
||
tenantId | query | Tenant identifier. |
||
ownerId | query | Private storage owner identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
401 | Unauthorized |
||
403 | Forbidden |
Create
Creates a new entity.
Request
POST /api/storage/v1/private-images[?tenantId&ownerId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
tenantId | query | Tenant identifier. |
||
ownerId | query | Private storage owner identifier. |
||
metadata.isVector | formData | Indicates whether image is vector. |
||
metadata.width | formData | Image width. |
||
metadata.height | formData | Image height. |
||
metadata.format | formData | Image format, e.g. Jpeg, Png, Bmp... |
||
metadata.dpiX | formData | Image horizontal dpi. |
||
metadata.dpiY | formData | Image vertical dpi. |
||
metadata.pages | formData | Image page metadata list (for multipaged images, like pdf). |
||
*file | formData | File content. |
||
*path | formData | Parent folder full path. |
||
*name | formData | Entity name. |
||
customFields | formData | Entity custom attributes. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
201 |
|
Success |
|
409 |
|
Conflict |
|
429 |
|
Client Error |
|
401 | Unauthorized |
||
403 | Forbidden |
Get
Returns an entity by ID.
Request
GET /api/storage/v1/private-images/{id}[?tenantId&ownerId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Entity identifier. |
||
tenantId | query | Tenant identifier. |
||
ownerId | query | Private storage owner identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
Not Found |
|
401 | Unauthorized |
||
403 | Forbidden |
Update
Updates the specified entity.
Request
PUT /api/storage/v1/private-images/{id}[?tenantId&ownerId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Entity identifier. |
||
tenantId | query | Tenant identifier. |
||
ownerId | query | Private storage owner identifier. |
||
metadata.isVector | formData | Indicates whether image is vector. |
||
metadata.width | formData | Image width. |
||
metadata.height | formData | Image height. |
||
metadata.format | formData | Image format, e.g. Jpeg, Png, Bmp... |
||
metadata.dpiX | formData | Image horizontal dpi. |
||
metadata.dpiY | formData | Image vertical dpi. |
||
metadata.pages | formData | Image page metadata list (for multipaged images, like pdf). |
||
file | formData | File content. |
||
path | formData | Parent folder full path. |
||
name | formData | Entity name. |
||
customFields | formData | Entity custom attributes. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
Not Found |
|
409 |
|
Conflict |
|
429 |
|
Client Error |
|
401 | Unauthorized |
||
403 | Forbidden |
Delete
Deletes the specified entity.
Request
DELETE /api/storage/v1/private-images/{id}[?tenantId&ownerId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Entity identifier. |
||
tenantId | query | Tenant identifier. |
||
ownerId | query | Private storage owner identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
Not Found |
|
401 | Unauthorized |
||
403 | Forbidden |
Copy
Copies the specified entity.
Request
POST /api/storage/v1/private-images/{id}[?path&name&strategy&tenantId&ownerId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Source entity identifier. |
||
path | query | Desired path. |
||
name | query | Desired name. |
||
strategy | query | Conflict resolving strategy. |
||
tenantId | query | Tenant identifier. |
||
ownerId | query | Private storage owner identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
201 |
|
Success |
|
409 |
|
Conflict |
|
404 |
|
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 identifier. |
||
ownerId | query | Private storage owner identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | string | Success |
|
404 |
|
Not Found |
|
429 |
|
Client Error |
|
401 | Unauthorized |
||
403 | Forbidden |
AddPreview
Creates a preview entity for specified source entity.
If a preview entity with specified namespace and name already exists it will be overwritten.
Request
PUT /api/storage/v1/private-images/{id}/preview[?tenantId&ownerId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Source entity identifier. |
||
tenantId | query | Tenant identifier. |
||
ownerId | query | Private storage owner identifier. |
||
*name | formData | Preview name. |
||
*namespace | formData | Preview namespace. |
||
*width | formData | Preview image width. |
||
*height | formData | Preview image height. |
||
format | formData | Preview image format, e.g. Jpeg, Png, Bmp. |
||
file | formData | Preview file content. |
||
isCustom | formData | Indicates if the preview is custom. Custom previews preserved even if source is changed. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
Not Found |
|
429 |
|
Client Error |
|
401 | Unauthorized |
||
403 | Forbidden |
GetRetentionPolicy
Returns an entity retention policy by entity identifier.
Request
GET /api/storage/v1/private-images/{id}/retention-policy[?tenantId&ownerId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Entity identifier. |
||
tenantId | query | Tenant identifier. |
||
ownerId | query | Private storage owner identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
Not Found |
|
401 | Unauthorized |
||
403 | Forbidden |
SetRetentionPolicy
Updates an entity retention policy by entity identifier.
Request
POST /api/storage/v1/private-images/{id}/retention-policy[?policy&tenantId&ownerId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Entity identifier. |
||
policy | query | New entity retention policy. |
||
tenantId | query | Tenant identifier. |
||
ownerId | query | Private storage owner identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
404 |
|
Not Found |
|
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 identifier. |
||
ownerId | query | Private storage owner identifier. |
||
body | body |
|
Operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
409 |
|
Conflict |
|
404 |
|
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 identifier. |
||
ownerId | query | Private storage owner identifier. |
||
body | body |
|
Operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
404 |
|
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 identifier. |
||
ownerId | query | Private storage owner identifier. |
||
body | body |
|
Operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
404 |
|
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 identifier. |
||
ownerId | query | New private storage owner identifier. |
||
body | body |
|
Operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
409 |
|
Conflict |
|
404 |
|
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 identifier. |
||
ownerId | query | Private storage owner identifier. |
||
body | body |
|
Operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
409 |
|
Conflict |
|
404 |
|
Not Found |
|
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 identifier. |
||
ownerId | query | Private storage owner identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
401 | Unauthorized |
||
403 | Forbidden |
CreateFolder
Creates a new folder.
Request
POST /api/storage/v1/private-images/folders[?tenantId&ownerId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
tenantId | query | Tenant identifier. |
||
ownerId | query | Private storage owner identifier. |
||
body | body |
|
Create operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
201 |
|
Success |
|
409 |
|
Conflict |
|
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 identifier. |
||
ownerId | query | Private storage owner identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
Not Found |
|
401 | Unauthorized |
||
403 | Forbidden |
UpdateFolder
Updates the specified folder.
Request
PUT /api/storage/v1/private-images/folders/{id}[?tenantId&ownerId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Folder identifier. |
||
tenantId | query | Tenant identifier. |
||
ownerId | query | Private storage owner identifier. |
||
body | body |
|
Operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
Not Found |
|
409 |
|
Conflict |
|
401 | Unauthorized |
||
403 | Forbidden |
GetAllFolders
Returns all folders.
Request
GET /api/storage/v1/private-images/folders/all[?tenantId&ownerId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
tenantId | query | Tenant identifier. |
||
ownerId | query | Private storage owner identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
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 identifier. |
||
ownerId | query | Private storage owner identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
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 identifier. |
||
ownerId | query | Private storage owner identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
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: |
||
tenantId | query | Tenant identifier. |
||
ownerId | query | Private storage owner identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
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 identifier. |
||
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 |
|
Success |
|
409 |
|
Conflict |
|
429 |
|
Client Error |
|
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 identifier. |
||
ownerId | query | Private storage owner identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
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 identifier. |
||
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 |
|
Success |
|
404 |
|
Not Found |
|
409 |
|
Conflict |
|
429 |
|
Client Error |
|
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 identifier. |
||
ownerId | query | Private storage owner identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
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 | Conflict resolving strategy. |
||
tenantId | query | Tenant identifier. |
||
ownerId | query | Private storage owner identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
201 |
|
Success |
|
409 |
|
Conflict |
|
404 |
|
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 identifier. |
||
ownerId | query | Private storage owner identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | string | Success |
|
404 |
|
Not Found |
|
429 |
|
Client Error |
|
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 identifier. |
||
ownerId | query | Private storage owner identifier. |
||
*name | formData | Preview name. |
||
*namespace | formData | Preview namespace. |
||
*width | formData | Preview image width. |
||
*height | formData | Preview image height. |
||
format | formData | Preview image format, e.g. Jpeg, Png, Bmp. |
||
file | formData | Preview file content. |
||
isCustom | formData | Indicates if the preview is custom. Custom previews preserved even if source is changed. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
Not Found |
|
429 |
|
Client Error |
|
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 identifier. |
||
ownerId | query | Private storage owner identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
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 identifier. |
||
ownerId | query | Private storage owner identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
404 |
|
Not Found |
|
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 identifier. |
||
ownerId | query | Private storage owner identifier. |
||
body | body |
|
Operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
409 |
|
Conflict |
|
404 |
|
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 identifier. |
||
ownerId | query | Private storage owner identifier. |
||
body | body |
|
Operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
404 |
|
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 identifier. |
||
ownerId | query | Private storage owner identifier. |
||
body | body |
|
Operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
404 |
|
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 identifier. |
||
ownerId | query | New private storage owner identifier. |
||
body | body |
|
Operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
409 |
|
Conflict |
|
404 |
|
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 identifier. |
||
ownerId | query | Private storage owner identifier. |
||
body | body |
|
Operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
409 |
|
Conflict |
|
404 |
|
Not Found |
|
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 identifier. |
||
ownerId | query | Private storage owner identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
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 identifier. |
||
ownerId | query | Private storage owner identifier. |
||
body | body |
|
Create operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
201 |
|
Success |
|
409 |
|
Conflict |
|
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 identifier. |
||
ownerId | query | Private storage owner identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
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 identifier. |
||
ownerId | query | Private storage owner identifier. |
||
body | body |
|
Operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
Not Found |
|
409 |
|
Conflict |
|
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 identifier. |
||
ownerId | query | Private storage owner identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
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 identifier. |
||
ownerId | query | Private storage owner identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
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 identifier. |
||
ownerId | query | Private storage owner identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
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: |
||
tenantId | query | Tenant identifier. |
||
ownerId | query | Private storage owner identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
401 | Unauthorized |
||
403 | Forbidden |
Create
Creates a new entity.
Request
POST /api/storage/v1/private-resources[?tenantId&ownerId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
tenantId | query | Tenant identifier. |
||
ownerId | query | Private storage owner identifier. |
||
*file | formData | 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 |
|
Success |
|
409 |
|
Conflict |
|
401 | Unauthorized |
||
403 | Forbidden |
Get
Returns an entity by ID.
Request
GET /api/storage/v1/private-resources/{id}[?tenantId&ownerId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Entity identifier. |
||
tenantId | query | Tenant identifier. |
||
ownerId | query | Private storage owner identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
Not Found |
|
401 | Unauthorized |
||
403 | Forbidden |
Update
Updates the specified entity.
Request
PUT /api/storage/v1/private-resources/{id}[?tenantId&ownerId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Entity identifier. |
||
tenantId | query | Tenant identifier. |
||
ownerId | query | Private storage owner identifier. |
||
file | formData | 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 |
|
Success |
|
404 |
|
Not Found |
|
409 |
|
Conflict |
|
401 | Unauthorized |
||
403 | Forbidden |
Delete
Deletes the specified entity.
Request
DELETE /api/storage/v1/private-resources/{id}[?tenantId&ownerId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Entity identifier. |
||
tenantId | query | Tenant identifier. |
||
ownerId | query | Private storage owner identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
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 | Conflict resolving strategy. |
||
tenantId | query | Tenant identifier. |
||
ownerId | query | Private storage owner identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
201 |
|
Success |
|
409 |
|
Conflict |
|
404 |
|
Not Found |
|
401 | Unauthorized |
||
403 | Forbidden |
GetFile
Returns an entity file from file storage.
Request
GET /api/storage/v1/private-resources/{id}/file[?attachment&tenantId&ownerId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Entity identifier. |
||
attachment | query | Indicates if file should be provided as an attachment with proper filename supplied (default value is 'false'). |
||
tenantId | query | Tenant identifier. |
||
ownerId | query | Private storage owner identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | string | Success |
|
404 |
|
Not Found |
|
429 |
|
Client Error |
|
401 | Unauthorized |
||
403 | Forbidden |
GetRetentionPolicy
Returns an entity retention policy by entity identifier.
Request
GET /api/storage/v1/private-resources/{id}/retention-policy[?tenantId&ownerId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Entity identifier. |
||
tenantId | query | Tenant identifier. |
||
ownerId | query | Private storage owner identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
Not Found |
|
401 | Unauthorized |
||
403 | Forbidden |
SetRetentionPolicy
Updates an entity retention policy by entity identifier.
Request
POST /api/storage/v1/private-resources/{id}/retention-policy[?policy&tenantId&ownerId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Entity identifier. |
||
policy | query | New entity retention policy. |
||
tenantId | query | Tenant identifier. |
||
ownerId | query | Private storage owner identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
404 |
|
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 identifier. |
||
ownerId | query | Private storage owner identifier. |
||
body | body |
|
Operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
409 |
|
Conflict |
|
404 |
|
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 identifier. |
||
ownerId | query | Private storage owner identifier. |
||
body | body |
|
Operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
404 |
|
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 identifier. |
||
ownerId | query | Private storage owner identifier. |
||
body | body |
|
Operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
404 |
|
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 identifier. |
||
ownerId | query | New private storage owner identifier. |
||
body | body |
|
Operation parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
409 |
|
Conflict |
|
404 |
|
Not Found |
|
401 | Unauthorized |
||
403 | Forbidden |
GetFileStorageInfo
Returns information about storage usage by private resource files.
Request
GET /api/storage/v1/private-resources/file-storage-info[?tenantId&ownerId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
tenantId | query | Tenant identifier. |
||
ownerId | query | Private storage owner identifier. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
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 |
|
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 |
|
Artifact type. |
format | string | Artifact file format. |
anonymousAccess | boolean | Artifact 'anonymous access' tag. It indicates whether artifact can be accessed anonymously. |
url | string | Artifact URL. |
tenantId | integer (int32) | Entity tenant identifier. |
id | string | Entity unique identifier. |
ownerId | string | Entity owner identifier. |
name | string | Entity name. |
customFields | object | Entity custom attributes. |
lastModified | string (date-time) | Last entity modification date and time. |
ArtifactType
Artifact type.
Enum Values
Temporary Final Service
NameConflictDto
Information about operation subject which has name conflict.
Name | Type | Notes |
---|---|---|
type |
|
Coflict type. |
id | string | Operation subject identifier. |
name | string | Operation subject name. |
path | string | Operation subject folder path. |
ConflictType
Coflict type.
Enum Values
Name FolderOverwrite
ProblemDetails
Name | Type | Notes |
---|---|---|
type | string | |
title | string | |
status | integer (int32) | |
detail | string | |
instance | string |
FileStorageInfoDto
Information about the use of file storage.
Name | Type | Notes |
---|---|---|
fileSizeInBytes | integer (int64) | Size of files in bytes. |
fileCount | integer (int64) | Number of files. |
PagedOfColorProfileDto
DTO, containing results of paged query.
Name | Type | Notes |
---|---|---|
total | integer (int64) | Items count |
items |
|
Items list |
ColorProfileDto
Items list
Name | Type | Notes |
---|---|---|
metadata |
|
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 | Color profile description. |
model | string | Color profile model. |
copyright | string | Color profile copyright. |
manufacturer | string | Color profile manufacturer. |
colorSpace | Color profile colorspace. |
|
deviceClass | Color profile device class. |
BatchCopyInput
Operation parameters.
Name | Type | Notes |
---|---|---|
entityIds | array | List of entities, which are operation subjects. |
folderIds | array | List of folders, which are operation subjects. |
conflictStrategy | Conflict resolving strategy. |
|
path | string | Folder path, specifies folder which will hold copies. |
BatchConflictDto
Information about batch operation subjects(folder and entities) which have name conflicts.
Name | Type | Notes |
---|---|---|
entityConflicts |
|
List of operation subject entity descriptions. |
folderConflicts |
|
List of operation subject folder descriptions. |
type |
|
Coflict type. |
ConflictDto
List of operation subject entity descriptions.
Name | Type | Notes |
---|---|---|
id | string | Operation subject identifier. |
name | string | Operation subject name. |
path | string | Operation subject folder path. |
BatchDeleteInput
Operation parameters.
Name | Type | Notes |
---|---|---|
entityIds | array | List of entities, which are operation subjects. |
folderIds | array | List of folders, which are operation subjects. |
BatchUpdateCustomFieldsInput
Operation parameters.
Name | Type | Notes |
---|---|---|
entityIds | array | List of entities, which are operation subjects. |
customFields | object | Custom fields dictionary. |
updateStrategy | Custom fields update strategy. |
BatchUpdateParentFolderInput
Operation parameters.
Name | Type | Notes |
---|---|---|
entityIds | array | List of entities, which are operation subjects. |
folderIds | array | List of folders, which are operation subjects. |
path | string | New parent folder path. |
conflictStrategy | Conflict resolving strategy. |
CreateFolderDto
Create operation parameters.
Name | Type | Notes |
---|---|---|
name | string | Folder name. |
path | string | Parent folder path. |
FolderDto
Folder DTO.
Name | Type | Notes |
---|---|---|
id | string | Folder unique identifier. |
path | string | Parent folder full path. |
private | boolean | Folder 'private' tag, indicates whether folder is private. |
ownerId | string | Entity owner identifier. |
name | string | Entity name. |
customFields | object | Entity custom attributes. |
lastModified | string (date-time) | Last entity modification date and time. |
UpdateFolderDto
Operation parameters.
Name | Type | Notes |
---|---|---|
name | string | Folder name. |
path | string | Parent folder path. |
FolderContentOfColorProfileDto
Folder content DTO.
Name | Type | Notes |
---|---|---|
id | string | Folder unique identifier. |
folders |
|
List of contained subfolders. |
entities |
|
List of contained entities. |
entitiesCount | integer (int64) | Count of all contained entities (including all subfolder entities). |
FolderInfoDto
List of contained subfolders.
Name | Type | Notes |
---|---|---|
hasChildren | boolean | Folder 'has children' tag. |
id | string | Folder unique identifier. |
path | string | Parent folder full path. |
private | boolean | Folder 'private' tag, indicates whether folder is private. |
ownerId | string | Entity owner identifier. |
name | string | Entity name. |
customFields | object | Entity custom attributes. |
lastModified | string (date-time) | Last entity modification date and time. |
PagedOfDataSchemaDto
DTO, containing results of paged query.
Name | Type | Notes |
---|---|---|
total | integer (int64) | Items count |
items |
|
Items list |
DataSchemaDto
Items list
Name | Type | Notes |
---|---|---|
metadata |
|
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 | DataSchema fields. |
FolderContentOfDataSchemaDto
Folder content DTO.
Name | Type | Notes |
---|---|---|
id | string | Folder unique identifier. |
folders |
|
List of contained subfolders. |
entities |
|
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 |
|
Items list |
DataSetDto
Items list
Name | Type | Notes |
---|---|---|
metadata |
|
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 | DataSet data schema id. Empty string for embedded schema. |
dataSchemaName | string | DataSet data schema name. |
rowCount | integer (int32) | Row count. |
FolderContentOfDataSetDto
Folder content DTO.
Name | Type | Notes |
---|---|---|
id | string | Folder unique identifier. |
folders |
|
List of contained subfolders. |
entities |
|
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 |
|
Items list |
DesignDto
Items list
Name | Type | Notes |
---|---|---|
metadata |
|
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 |
|
Design font metadata list. |
surfaces |
|
Design surface metadata list. |
printAreas |
|
Design print area metadata list. |
hasDataSchema | boolean | Indicates whether design has data schema. |
dataSchemaId | string | Design data schema identifier. Empty string for embedded schema. |
dataSchemaName | string | Design data schema name. |
hasToggleSet | boolean | Indicates whether design has toggle set. |
toggleSetId | string | Design toggle set identifier. Empty string for embedded schema. |
toggleSetName | string | Design toggle set name. |
DesignFontMetadata
Design font metadata list.
Name | Type | Notes |
---|---|---|
postscriptName | string | Font postscript name. |
family | string | Font family name. |
style | string | Font style. |
DesignSurfaceMetadata
Design surface metadata list.
Name | Type | Notes |
---|---|---|
width | number (float) | Design surface width. |
height | number (float) | Design surface height. |
DesignPrintAreaMetadata
Design print area metadata list.
Name | Type | Notes |
---|---|---|
width | number (float) | Design print area width. |
height | number (float) | Design print area height. |
FolderContentOfDesignDto
Folder content DTO.
Name | Type | Notes |
---|---|---|
id | string | Folder unique identifier. |
folders |
|
List of contained subfolders. |
entities |
|
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 |
|
Items list |
DocumentDto
Items list
Name | Type | Notes |
---|---|---|
type |
|
Document type. |
format |
|
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 |
|
List of contained subfolders. |
entities |
|
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 |
|
Items list |
FontDto
Items list
Name | Type | Notes |
---|---|---|
metadata |
|
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 | Font postscript name. |
family | string | Font family name. |
style | string | Font style. |
FolderContentOfFontDto
Folder content DTO.
Name | Type | Notes |
---|---|---|
id | string | Folder unique identifier. |
folders |
|
List of contained subfolders. |
entities |
|
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 |
|
Items list |
ImageDto
Items list
Name | Type | Notes |
---|---|---|
metadata |
|
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 | Indicates whether image is vector. |
width | integer (int32) | Image width. |
height | integer (int32) | Image height. |
format | string | Image format, e.g. Jpeg, Png, Bmp... |
dpiX | string | Image horizontal dpi. |
dpiY | string | Image vertical dpi. |
pages |
|
Image page metadata list (for multipaged images, like pdf). |
ImagePageMetadata
Image page metadata list (for multipaged images, like pdf).
Name | Type | Notes |
---|---|---|
width | integer (int32) | Image page width. |
height | integer (int32) | Image page height. |
FolderContentOfImageDto
Folder content DTO.
Name | Type | Notes |
---|---|---|
id | string | Folder unique identifier. |
folders |
|
List of contained subfolders. |
entities |
|
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 |
|
Items list |
MockupDto
Items list
Name | Type | Notes |
---|---|---|
metadata |
|
Mockup metadata. |
private | boolean | Indicates if the mockup is private. |
type |
|
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 |
|
List of contained subfolders. |
entities |
|
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 |
|
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 |
|
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
Operation parameters.
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
Operation parameters.
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 |
|
Items list |
TenantDto
Items list
Name | Type | Notes |
---|---|---|
id | integer (int32) | Tenant unique identifier. |
settings |
|
Tenant settings. |
name | string | Entity name. |
customFields | object | Entity custom attributes. |
lastModified | string (date-time) | Last entity modification date and time. |
TenantSettingsDto
Tenant settings.
Name | Type | Notes |
---|---|---|
enableAssetsRetention | boolean | Indicates if specific assets should be removed after a retention period. |
assetsRetentionPeriodInDays | integer (int32) | Period of assets retention in days. |
CreateTenantDto
Operation parameters.
Name | Type | Notes |
---|---|---|
id | integer (int32) | Tenant entity desired identifier. |
settings | Tenant settings. |
|
name | string | Entity name. |
customFields | object | Entity custom attributes. |
UpdateTenantDto
Operation parameters
Name | Type | Notes |
---|---|---|
settings | Tenant settings. |
|
name | string | Entity name. |
customFields | object | Entity custom attributes. |
StatusCodeResult
Name | Type | Notes |
---|---|---|
statusCode | integer (int32) |
RetentionPolicy
Asset retention policy.
Enum Values
Unknown Never Default
BatchUpdateOwnerInput
Operation parameters.
Name | Type | Notes |
---|---|---|
entityIds | array | List of entities, which are operation subjects. |
folderIds | array | List of folders, which are operation subjects. |
conflictStrategy | Conflict resolving strategy. |
|
updateAll | boolean | If set to 'true', all folders and entities, which belong to specified ownerId, should be updated with new ownerId. |
BatchUpdateResourcesOwnerInput
Operation parameters.
Name | Type | Notes |
---|---|---|
entityIds | array | List of entities, which are operation subjects. |
conflictStrategy | List of folders, which are operation subjects. |
|
updateAll | boolean | If set to 'true' all folders and entities, which belong to specified ownerId should be updated with new ownerId. |