Previews
These endpoints are used to access preview (file or metadata).
Get
Gets preview entity by id
Request
GET /api/storage/v1/previews/{id}[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Entity unique identifier |
||
tenantId | query | Tenant identifier |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
Not Found |
|
401 | Unauthorized |
||
403 | Forbidden |
GetFile
Gets 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 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 |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | string | Success |
|
404 |
|
Not Found |
Definitions
PreviewDto
Preview dto class
Name | Type | Notes |
---|---|---|
size | integer (int64) | Preview image file size |
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 |
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 |
ProblemDetails
These endpoints are used to access preview (file or metadata).
Name | Type | Notes |
---|---|---|
type | string | |
title | string | |
status | integer (int32) | |
detail | string | |
instance | string |