ImagesApi
All URIs are relative to http://localhost
| Method | HTTP request | Description |
|---|---|---|
| downloadImageInfoBulkByOperation | GET /admin/images/operation/download | Download specified image's data from the specified operation's ids |
| downloadImageInfoBulkBySubject | GET /admin/images/subjects/download | Download specified image's data from the specified subjects ids |
| downloadImageInfoByOperationId | GET /admin/images/operation/{id}/download | Download specified image's data from the specified operation's id |
| downloadImageInfoBySubjectId | GET /admin/images/subject/{id}/download | Download specified image's data from the specified subject's id |
| getImageById | GET /admin/images/id/ | Get image's information by image and operation id |
| getImageByUUID | GET /admin/images/uuid/ | Get image's information by UUID |
downloadImageInfoBulkByOperation
Object downloadImageInfoBulkByOperation(ids, downloadOptions)
Download specified image's data from the specified operation's ids
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ids | List | List of operations id's to be downloaded | [default to null] |
| downloadOptions | List | Set of images data to be downloaded | [default to null] [enum: IMAGE, TOKEN_IMAGE, TEMPLATE] |
Return type
Object
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json, application/octet-stream, /
downloadImageInfoBulkBySubject
Object downloadImageInfoBulkBySubject(ids, downloadOptions)
Download specified image's data from the specified subjects ids
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ids | List | List of subjects id's to be downloaded | [default to null] |
| downloadOptions | List | Set of images data to be downloaded | [default to null] [enum: IMAGE, TOKEN_IMAGE, TEMPLATE] |
Return type
Object
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json, application/octet-stream, /
downloadImageInfoByOperationId
Object downloadImageInfoByOperationId(id, downloadOptions)
Download specified image's data from the specified operation's id
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | Integer | Operation's id | [default to null] |
| downloadOptions | List | Set of image's data to be downloaded | [default to null] [enum: IMAGE, TOKEN_IMAGE, TEMPLATE] |
Return type
Object
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json, application/octet-stream, /
downloadImageInfoBySubjectId
Object downloadImageInfoBySubjectId(id, downloadOptions)
Download specified image's data from the specified subject's id
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | Integer | Subject's id | [default to null] |
| downloadOptions | List | Set of image's data to be downloaded | [default to null] [enum: IMAGE, TOKEN_IMAGE, TEMPLATE] |
Return type
Object
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json, application/octet-stream, /
getImageById
Image getImageById(id, width, height, max-bytes)
Get image's information by image and operation id
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | Integer | Image ID to search with. (ID is unique number generated by the DB) | [default to null] |
| width | Integer | Adjust image width | [optional] [default to 0] |
| height | Integer | Adjust image height | [optional] [default to 0] |
| max-bytes | Integer | Adjust jpeg quality to fit into the maximum bytes | [optional] [default to 0] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json, /
getImageByUUID
Image getImageByUUID(uuid, width, height, max-bytes)
Get image's information by UUID
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| uuid | String | UUID to search image by. (UUID is unique generated by the DB) | [default to null] |
| width | Integer | Adjust image width | [optional] [default to 0] |
| height | Integer | Adjust image height | [optional] [default to 0] |
| max-bytes | Integer | Adjust jpeg quality to fit into the maximum bytes | [optional] [default to 0] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json, /