PrivateImageProcessor
Using these endpoints, you may process private images (user uploads) - for example, generate a preview, extract its metadata or import it to the storage.
PreparePreview
Creates preview image for image taken from private storage.
In case when preview is already existed returns existed preview
Request
GET /api/processor/v1/private-images/{id}/preview/{namespace}/{name}/{width}x{height}[?jpegQuality&fitMode&interpolationMode&background&force&tenantId&userId]Parameters
| Name | In | Type | Default | Notes |
|---|---|---|---|---|
| *id | path | Source image entity identifier |
||
| *namespace | path | Preview namespace |
||
| *name | path | Preview name |
||
| *width | path | Preview image width |
||
| *height | path | Preview image height |
||
| jpegQuality | query | Quality of Jpeg previews |
||
| fitMode | query | Image preview fit mode |
||
| interpolationMode | query | Image preview interpolation mode |
||
| background | query | Background color for transparent images |
||
| force | query | False | If set to 'true', new preview prepared, even if preview already existed |
|
| 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 |
PreparePreviewUrl
Creates preview image for image taken from private storage.
In case when preview is already existed returns existed preview
Request
GET /api/processor/v1/private-images/{id}/preview/{namespace}/{name}/{width}x{height}/url[?jpegQuality&fitMode&interpolationMode&background&force&tenantId&userId]Parameters
| Name | In | Type | Default | Notes |
|---|---|---|---|---|
| *id | path | Source image entity identifier |
||
| *namespace | path | Preview namespace |
||
| *name | path | Preview name |
||
| *width | path | Preview image width |
||
| *height | path | Preview image height |
||
| jpegQuality | query | Quality of Jpeg previews |
||
| fitMode | query | Image preview fit mode |
||
| interpolationMode | query | Image preview interpolation mode |
||
| background | query | Background color for transparent images |
||
| force | query | False | If set to 'true', new preview prepared, even if preview already existed |
|
| 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 |
Update
Updates image file and metadata in private storage
If file is not provided metadata will be updated using file taken from storage
Request
POST /api/processor/v1/private-images/{id}/update[?tenantId&userId]Parameters
| Name | In | Type | Default | Notes |
|---|---|---|---|---|
| *id | path | Image entity unique identifier |
||
| tenantId | query | Tenant identifier |
||
| userId | query | Private storage owner identifier |
||
| name | formData | Image name |
||
| path | formData | Image location (folder path) |
||
| customFields | formData | Image custom attributes |
||
| file | formData | Image source file |
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
Success |
|
| 404 |
|
Not Found |
|
| 401 | Unauthorized |
||
| 403 | Forbidden |
ImportImage
Imports image from source file and saves it to private storage.
Additionally makes image preview if requested.
Request
POST /api/processor/v1/private-images/import[?tenantId&userId]Parameters
| Name | In | Type | Default | Notes |
|---|---|---|---|---|
| tenantId | query | Tenant identifier |
||
| userId | query | Private storage owner identifier |
||
| name | formData | Image name |
||
| path | formData | Image location (folder path) |
||
| customFields | formData | Image custom attributes |
||
| previewSettings.makePreview | formData | Force make preview |
||
| previewSettings.namespace | formData | Preview namespace |
||
| previewSettings.name | formData | Preview name |
||
| previewSettings.width | formData | Preview image width |
||
| previewSettings.height | formData | Preview image heigth |
||
| previewSettings.jpegQuality | formData | Quality of Jpeg previews |
||
| previewSettings.fitMode | formData | Image preview fit mode |
||
| previewSettings.interpolationMode | formData | Image preview interpolation mode |
||
| previewSettings.background | formData | Background color for transparent images |
||
| *sourceFile | formData | Image source file |
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 201 |
|
Success |
|
| 409 |
|
Conflict |
|
| 401 | Unauthorized |
||
| 403 | Forbidden |
Definitions
ProblemDetails
Using these endpoints, you may process private images (user uploads) - for example, generate a preview, extract its metadata or import it to the storage.
| Name | Type | Notes |
|---|---|---|
| type | string | |
| title | string | |
| status | integer (int32) | |
| detail | string | |
| instance | string |
ImageDto
Using these endpoints, you may process private images (user uploads) - for example, generate a preview, extract its metadata or import it to the storage.
| Name | Type | Notes |
|---|---|---|
| metadata |
|
|
| private | boolean | |
| mimeType | string | |
| previews | object | |
| size | integer (int64) | |
| folderId | string | |
| tenantId | integer (int32) | |
| id | string | |
| ownerId | string | |
| name | string | |
| customFields | object | |
| lastModified | string (date-time) |
ImageMetadata
| Name | Type | Notes |
|---|---|---|
| isVector | boolean | |
| width | integer (int32) | |
| height | integer (int32) | |
| format | string | |
| dpiX | string | |
| dpiY | string | |
| pages |
|
ImagePageMetadata
| Name | Type | Notes |
|---|---|---|
| width | integer (int32) | |
| height | integer (int32) |
NameConflictDto
Using these endpoints, you may process private images (user uploads) - for example, generate a preview, extract its metadata or import it to the storage.
| Name | Type | Notes |
|---|---|---|
| type |
|
|
| id | string | |
| name | string | |
| path | string |
ConflictType
Enum Values
Name FolderOverwrite