PrivateImages
These endpoints are used to manage end user private images. They cover obvious set of CRUD operations with file, including folder and collection manipulations
GetAll
Gets all entities relevant to specified query parameters
Request
GET /api/storage/v1/private-images[?path&includeSubfolders&skip&take&sorting&search&customFields&tenantId&userId]
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 |
||
userId | query | Private storage owner identifier |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
401 | Unauthorized |
||
403 | Forbidden |
Create
Creates new entity
Request
POST /api/storage/v1/private-images[?tenantId&userId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
tenantId | query | Tenant identifier |
||
userId | query | Private storage owner identifier |
||
metadata.isVector | formData | Indicates whether image is vector |
||
metadata.width | formData | Image width |
||
metadata.height | formData | Image height |
||
metadata.format | formData | Image format, e.g. Jpeg, Png, Bmp.. |
||
metadata.dpiX | formData | Image horizontal dpi |
||
metadata.dpiY | formData | Image vertical dpi |
||
metadata.pages | formData | Image page metadata list (for multipaged images, like pdf) |
||
file | formData | Entity file content |
||
*path | formData | Parent folder full path |
||
*name | formData | Entity name |
||
customFields | formData | Entity custom attributes |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
201 |
|
Success |
|
409 |
|
Conflict |
|
401 | Unauthorized |
||
403 | Forbidden |
Get
Gets entity by id
Request
GET /api/storage/v1/private-images/{id}[?tenantId&userId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Entity unique identifier |
||
tenantId | query | Tenant identifier |
||
userId | query | Private storage owner identifier |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
Not Found |
|
401 | Unauthorized |
||
403 | Forbidden |
Copy
Copies specified entity
Request
POST /api/storage/v1/private-images/{id}[?path&name&strategy&tenantId&userId]
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 |
||
userId | query | Private storage owner identifier |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
201 |
|
Success |
|
404 |
|
Not Found |
|
401 | Unauthorized |
||
403 | Forbidden |
Update
Updates specified entity
Request
PUT /api/storage/v1/private-images/{id}[?tenantId&userId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Entity unique identifier |
||
tenantId | query | Tenant identifier |
||
userId | query | Private storage owner identifier |
||
metadata.isVector | formData | Indicates whether image is vector |
||
metadata.width | formData | Image width |
||
metadata.height | formData | Image height |
||
metadata.format | formData | Image format, e.g. Jpeg, Png, Bmp.. |
||
metadata.dpiX | formData | Image horizontal dpi |
||
metadata.dpiY | formData | Image vertical dpi |
||
metadata.pages | formData | Image page metadata list (for multipaged images, like pdf) |
||
file | formData | Entity file content |
||
path | formData | Parent folder full path |
||
name | formData | Entity name |
||
customFields | formData | Entity custom attributes |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
Not Found |
|
409 |
|
Conflict |
|
401 | Unauthorized |
||
403 | Forbidden |
Delete
Deletes specified entity
Request
DELETE /api/storage/v1/private-images/{id}[?tenantId&userId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Entity unique identifier |
||
tenantId | query | Tenant identifier |
||
userId | query | Private storage owner identifier |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
Not Found |
|
401 | Unauthorized |
||
403 | Forbidden |
GetFile
Gets entity file from file storage
Request
GET /api/storage/v1/private-images/{id}/file[?attachment&tenantId&userId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Entity unique identifier |
||
attachment | query | Indicates that file should be provided as an attachment with proper filename supplied (default value is 'false') |
||
tenantId | query | Tenant identifier |
||
userId | query | Private storage owner identifier |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | string | Success |
|
404 |
|
Not Found |
|
401 | Unauthorized |
||
403 | Forbidden |
AddPreview
Creates preview entity for specified source entity
If preview entity with specified namespace and name already exists it will be overwritten
Request
PUT /api/storage/v1/private-images/{id}/preview[?tenantId&userId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Source entity unique identifier |
||
tenantId | query | Tenant identifier |
||
userId | query | Source entity private storage owner identifier |
||
*name | formData | Preview name |
||
*namespace | formData | Preview namespace |
||
*width | formData | Preview image width |
||
*height | formData | Preview image height |
||
format | formData | Preview image format, e.g. Jpeg, Png, Bmp ... |
||
file | formData | Preview file content |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
Not Found |
|
401 | Unauthorized |
||
403 | Forbidden |
BatchCopy
Copies selected entities and folders to another folder specified by path
Request
POST /api/storage/v1/private-images/batchCopy[?tenantId&userId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
tenantId | query | Tenant identifier |
||
userId | 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 selected entities and folders
Request
POST /api/storage/v1/private-images/batchDelete[?tenantId&userId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
tenantId | query | Tenant identifier |
||
userId | 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 selected entities and folders
Request
POST /api/storage/v1/private-images/batchUpdateOwner[?oldUserId&tenantId&userId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
oldUserId | query | Source private storage owner identifier |
||
tenantId | query | Tenant identifier |
||
userId | 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 selected entities and folders
Request
POST /api/storage/v1/private-images/batchUpdateParentFolder[?tenantId&userId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
tenantId | query | Tenant identifier |
||
userId | 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 |
GetAllCollections
Gets all collections
Request
GET /api/storage/v1/private-images/collections[?tenantId&userId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
tenantId | query | Tenant identifier |
||
userId | query | Private storage owner identifier |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
401 | Unauthorized |
||
403 | Forbidden |
CreateCollection
Creates new collection
Request
POST /api/storage/v1/private-images/collections[?tenantId&userId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
tenantId | query | Tenant identifier |
||
userId | query | Private storage owner identifier |
||
body | body |
|
Create operation parameters |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
201 |
|
Success |
|
409 |
|
Conflict |
|
401 | Unauthorized |
||
403 | Forbidden |
GetCollection
Gets collection content by collection id
Request
GET /api/storage/v1/private-images/collections/{id}[?tenantId&userId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Collection unique identifier |
||
tenantId | query | Tenant identifier |
||
userId | query | Private storage owner identifier |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
Not Found |
|
401 | Unauthorized |
||
403 | Forbidden |
UpdateCollection
Updates specified collection
Request
PUT /api/storage/v1/private-images/collections/{id}[?tenantId&userId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Collection unique identifier |
||
tenantId | query | Tenant identifier |
||
userId | query | Private storage owner identifier |
||
body | body |
|
Update operation parameters |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
Not Found |
|
409 |
|
Conflict |
|
401 | Unauthorized |
||
403 | Forbidden |
DeleteCollection
Deletes specified collection
Request
DELETE /api/storage/v1/private-images/collections/{id}[?tenantId&userId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Collection unique identifier |
||
tenantId | query | Tenant identifier |
||
userId | query | Private storage owner identifier |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
Not Found |
|
401 | Unauthorized |
||
403 | Forbidden |
GetFolder
Gets folder content by folder path
Request
GET /api/storage/v1/private-images/folders[?fullPath&tenantId&userId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
fullPath | query | Full folder path, if not set then root folder path is used |
||
tenantId | query | Tenant identifier |
||
userId | query | Private storage owner identifier |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
Not Found |
|
401 | Unauthorized |
||
403 | Forbidden |
CreateFolder
Creates new folder
Request
POST /api/storage/v1/private-images/folders[?tenantId&userId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
tenantId | query | Tenant identifier |
||
userId | query | Private storage owner identifier |
||
body | body |
|
Create operation parameters |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
201 |
|
Success |
|
409 |
|
Conflict |
|
401 | Unauthorized |
||
403 | Forbidden |
DeleteFolder
Deletes specified folder
Request
DELETE /api/storage/v1/private-images/folders[?fullPath&tenantId&userId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
fullPath | query | Folder full path |
||
tenantId | query | Tenant identifier |
||
userId | query | Private storage owner identifier |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
Not Found |
|
401 | Unauthorized |
||
403 | Forbidden |
UpdateFolder
Updates specified folder
Request
PUT /api/storage/v1/private-images/folders/{id}[?tenantId&userId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Folder unique identifier |
||
tenantId | query | Tenant identifier |
||
userId | query | Private storage owner identifier |
||
body | body |
|
Update operation parameters |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
Not Found |
|
409 |
|
Conflict |
|
401 | Unauthorized |
||
403 | Forbidden |
GetFolderInfo
Gets folder by id
Request
GET /api/storage/v1/private-images/folders/{id}[?tenantId&userId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Folder unique identifier |
||
tenantId | query | Tenant identifier |
||
userId | query | Private storage owner identifier |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
Not Found |
|
401 | Unauthorized |
||
403 | Forbidden |
GetAllFolders
Gets all folders
Request
GET /api/storage/v1/private-images/folders/all[?tenantId&userId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
tenantId | query | Tenant identifier |
||
userId | query | Private storage owner identifier |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
401 | Unauthorized |
||
403 | Forbidden |
Definitions
PagedOfImageDto
Paged list of items
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: "previewMetadata.namespace-previewMetadata.name" Value: "previewMetadata" |
size | integer (int64) | Entity file size |
folderId | string | Parent folder id |
tenantId | integer (int32) | Entity tenant identifier |
id | string | Entity unique identifier |
ownerId | string | Entity owner identifier |
name | string | Entity name |
customFields | object | Entity custom attributes |
lastModified | string (date-time) | Last entity modification date and time |
ImageMetadata
Image metadata
Name | Type | Notes |
---|---|---|
isVector | boolean | Indicates whether image is vector |
width | integer (int32) | Image width |
height | integer (int32) | Image height |
format | string | Image format, e.g. Jpeg, Png, Bmp.. |
dpiX | string | Image horizontal dpi |
dpiY | string | Image vertical dpi |
pages |
|
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 |
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
These endpoints are used to manage end user private images. They cover obvious set of CRUD operations with file, including folder and collection manipulations
Name | Type | Notes |
---|---|---|
type | string | |
title | string | |
status | integer (int32) | |
detail | string | |
instance | string |
BatchCopyInput
Operation parameters
Name | Type | Notes |
---|---|---|
path | string | Folder path, describing folder to hold copies |
entityIds | array | List of entities, which are operation subjects |
folderIds | array | List of folders, which are operation subjects |
conflictStrategy | Conflict resolving strategy, which should be applied if operation faces any conflict |
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 |
BatchUpdateOwnerInput
Operation parameters
Name | Type | Notes |
---|---|---|
updateAll | boolean | If set to 'true' all folders and entities, which belong to specified ownerId should be updated with new ownerId |
entityIds | array | List of entities, which are operation subjects |
folderIds | array | List of folders, which are operation subjects |
conflictStrategy | Conflict resolving strategy |
BatchUpdateParentFolderInput
Operation parameters
Name | Type | Notes |
---|---|---|
path | string | New parent folder path |
entityIds | array | List of entities, which are operation subjects |
folderIds | array | List of folders, which are operation subjects |
conflictStrategy | Conflict resolving strategy |
CollectionDto
These endpoints are used to manage end user private images. They cover obvious set of CRUD operations with file, including folder and collection manipulations
Name | Type | Notes |
---|---|---|
id | string | Collection unique identifier |
ownerId | string | Entity owner identifier |
name | string | Entity name |
customFields | object | Entity custom attributes |
lastModified | string (date-time) | Last entity modification date and time |
CreateCollectionDto
Create operation parameters
Name | Type | Notes |
---|---|---|
name | string | Collection name |
CollectionContentOfImageDto
Collection content information
Name | Type | Notes |
---|---|---|
id | string | Collection unique identifier |
name | string | Collection name |
collections |
|
List of contained collections |
folders |
|
List of contained folders |
entities |
|
List of contained entities |
FolderDto
List of contained folders
Name | Type | Notes |
---|---|---|
id | string | Folder unique identifier |
path | string | Parent folder full path |
private | boolean | Folder 'private' tag indicates whether folder is private |
ownerId | string | Entity owner identifier |
name | string | Entity name |
customFields | object | Entity custom attributes |
lastModified | string (date-time) | Last entity modification date and time |
UpdateCollectionDto
Update operation parameters
Name | Type | Notes |
---|---|---|
name | string | Collection name |
entities | array | Entity identifier list specifing entities, which are part of specified collection |
folders | array | Folder identifier list specifying folders, which are part of specified collection |
collections | array | Collection identifier list specifying collections, which are part of specified collection |
FolderContentOfImageDto
Folder content information
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 |
CreateFolderDto
Create operation parameters
Name | Type | Notes |
---|---|---|
name | string | Folder name |
path | string | Parent folder path |
UpdateFolderDto
Update operation parameters
Name | Type | Notes |
---|---|---|
name | string | Folder name |
path | string | Parent folder path |