ImageProcessor
Using these endpoints, you may process public images(clipart, backgrounds, etc) - for example, generate a preview, extract its metadata or import it to the storage.
PreparePreview
Creates preview image for image taken from storage.
In case when preview is already existed returns existed preview
Request
GET /api/processor/v1/images/{id}/preview/{namespace}/{name}/{width}x{height}[?jpegQuality&fitMode&interpolationMode&background&force&tenantId]
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 |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | string | Success |
|
404 |
|
Not Found |
|
401 | Unauthorized |
||
403 | Forbidden |
UpdateMetadata
Updates metadata for image taken from storage.
Request
POST /api/processor/v1/images/{id}/update[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Image entity unique identifier |
||
tenantId | query | Tenant identifier |
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 storage.
Additionally makes image preview if requested.
Request
POST /api/processor/v1/images/import[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
tenantId | query | Tenant identifier |
||
name | formData | Image name |
||
path | formData | Image location (folder path) |
||
previewSettings.makePreview | formData | Additionally makes image preview if requested. |
||
previewSettings.namespace | formData | Additionally makes image preview if requested. |
||
previewSettings.name | formData | Additionally makes image preview if requested. |
||
previewSettings.width | formData | Additionally makes image preview if requested. |
||
previewSettings.height | formData | Additionally makes image preview if requested. |
||
previewSettings.jpegQuality | formData | Additionally makes image preview if requested. |
||
previewSettings.fitMode | formData | Additionally makes image preview if requested. |
||
previewSettings.interpolationMode | formData | Additionally makes image preview if requested. |
||
previewSettings.background | formData | Additionally makes image preview if requested. |
||
*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 public images(clipart, backgrounds, etc) - 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 public images(clipart, backgrounds, etc) - 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 | |
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 public images(clipart, backgrounds, etc) - 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
NameFolderOverwrite