API docs by Redocly

ImageConverter HTTP API (8.32.0)

Download OpenAPI specification:Download

OX Software GmbH: info@open-xchange.com URL: https://www.gnu.org/licenses/gpl-2.0.htmlhttps://www.gnu.org/licenses/gpl-2.0.html

Documentation of the OX Software ImageConverter HTTP API.

ImageConverter

The ImageConverter module

cacheAndGetImage

Creating a new sequence of preview images for a source image under a certain image key, if not available, and/or retrieving the image with the given image key and best matching request format.

path Parameters
imageKey
required
string

The key of the image group.

requestFormat
required
string

The image format for which a best matching image is to be returned.

query Parameters
context
string
Default: ""

The context of the image group, if specified.

Request Body schema: multipart/form-data
required
sourceImage
required
string <binary>

The source image file for which the preview images are to be created.

Responses

cacheAndGetImageAndMetadata

Creating a new sequence of preview images for a source image under a certain image key, if not available, and/or retrieving the image with the given image key and best matching request format as image/* MultipartEntity as well as the image metadata as application/json Multipart entity within the Multipart/form-data response

path Parameters
imageKey
required
string

The key of the image group.

requestFormat
required
string

The image format for which a best matching image is to be returned.

query Parameters
context
string
Default: ""

The context of the image group, if specified.

Request Body schema: multipart/form-data
required
sourceImage
required
string <binary>

The source image file for which the preview images are to be created.

Responses

cacheImage

Creating a new sequence of preview images for a source image under a certain image key.

path Parameters
imageKey
required
string

The key of the image group.

query Parameters
context
string
Default: ""

The context of the image group, if specified.

Request Body schema: multipart/form-data
required
sourceImage
required
string <binary>

The source image file for which the preview images are to be created.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

getImage

Retrieving the image with the given image key and best matching request format.

path Parameters
imageKey
required
string

The key of the image group.

requestFormat
required
string

The image format for which a best matching image is to be returned.

query Parameters
context
string
Default: ""

The context of the image group, if specified.

Responses

getImageAndMetadata

Retrieving the image with the given image key and best matching request format as image/* MultipartEntity as well as the image metadata as application/json Multipart entity within the mMultipart/form-data response

path Parameters
imageKey
required
string

The key of the image group.

requestFormat
required
string

The image format for which a best matching image is to be returned.

query Parameters
context
string
Default: ""

The context of the image group, if specified.

Responses

getMetadata

Retrieving the image metadata with the given image key.

path Parameters
imageKey
required
string

The key of the image group.

query Parameters
context
string
Default: ""

The context of the image group, if specified.

Responses

clearImages

Removing all images from the Image Server. This call leaves an Image Server with no images left after a succesful request!

Authorizations:
basicAuth
query Parameters
context
string
Default: ""

The context of the image group, if specified.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

clearImagesByKey

Removing all images matching the specified key from the Image Server.

Authorizations:
basicAuth
path Parameters
imageKey
required
string

The key of the image group.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

getKeyCount

Retrieving either the number of all keys or the number of keys that match the given context from the Image Server.

query Parameters
context
string
Default: ""

The context of the image group, if specified.

Responses

Response samples

Content type
application/json
{
  • "count": 0
}

getKeys

Retrieving either all keys or the keys that match the given context from the Image Server.

Authorizations:
basicAuth
query Parameters
context
string
Default: ""

The context of the image group, if specified.

Responses

Response samples

Content type
application/json
{
  • "keys": [
    ]
}

status

Getting the current status of the Image Server as text/html response.

query Parameters
metrics
string
Default: "false"

Set to "yes", if a metrics summary should be returned.

Responses

Response samples

Content type
No sample