Documentation Powered by ReDoc

ImageConverter HTTP API (7.10)

Download OpenAPI specification:Download

Open-Xchange 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 Open-Xchange ImageConverter HTTP API.

ImageConverter

The ImageConverter module

cacheAndGetImage

post /cacheAndGetImage/{imageKey}/{requestFormat}
http://example.com:8005/imageconverter/cacheAndGetImage/{imageKey}/{requestFormat}
https://example.com:8005/imageconverter/cacheAndGetImage/{imageKey}/{requestFormat}

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
sourceImage
required
string <binary>

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

Responses

200

Image Server status 'ok', returning the result image, that is directly written into the output stream.

500

Image Server response in case of an error, returning the 'error' object

cacheAndGetImageAndMetadata

post /cacheAndGetImageAndMetadata/{imageKey}/{requestFormat}
http://example.com:8005/imageconverter/cacheAndGetImageAndMetadata/{imageKey}/{requestFormat}
https://example.com:8005/imageconverter/cacheAndGetImageAndMetadata/{imageKey}/{requestFormat}

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
sourceImage
required
string <binary>

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

Responses

200

Image Server status 'ok', returning the result image and the source image metadata as multipart/form-data response.

500

Image Server response in case of an error, returning the 'error' object

cacheImage

put /cacheImage/{imageKey}
http://example.com:8005/imageconverter/cacheImage/{imageKey}
https://example.com:8005/imageconverter/cacheImage/{imageKey}

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
sourceImage
required
string <binary>

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

Responses

200

Image Server response in case of success.

500

Image Server response in case of an error, returning the 'error' object

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": 0,
  • "message": "string"
}

getImage

get /getImage/{imageKey}/{requestFormat}
http://example.com:8005/imageconverter/getImage/{imageKey}/{requestFormat}
https://example.com:8005/imageconverter/getImage/{imageKey}/{requestFormat}

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

200

Image Server status 'ok', returning the result image, that is directly written into the output stream.

500

Image Server response in case of an Image Server error

getImageAndMetadata

get /getImageAndMetadata/{imageKey}/{requestFormat}
http://example.com:8005/imageconverter/getImageAndMetadata/{imageKey}/{requestFormat}
https://example.com:8005/imageconverter/getImageAndMetadata/{imageKey}/{requestFormat}

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

200

Image Server status 'ok', returning the result image and the source image metadata as multipart/form-data response.

500

Image Server response in case of an Image Server error

getMetadata

get /getMetadata/{imageKey}
http://example.com:8005/imageconverter/getMetadata/{imageKey}
https://example.com:8005/imageconverter/getMetadata/{imageKey}

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

200

Image Server status 'ok', returning the metadata object as multipart/form-data response

500

Image Server response in case of an Image Server error

clearImages

delete /clearImages
http://example.com:8005/imageconverter/clearImages
https://example.com:8005/imageconverter/clearImages

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

query Parameters
context
string
Default: ""

The context of the image group, if specified.

Responses

200

ImageConverter response in case of success.

500

Image Server response in case of an Image Server error

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": 0,
  • "message": "string"
}

clearImagesByKey

delete /clearImagesByKey/{imageKey}
http://example.com:8005/imageconverter/clearImagesByKey/{imageKey}
https://example.com:8005/imageconverter/clearImagesByKey/{imageKey}

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

path Parameters
imageKey
required
string

The key of the image group.

Responses

200

Image Server response in case of success.

500

Image Server response in case of an Image Server error

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": 0,
  • "message": "string"
}

getKeyCount

get /getKeyCount
http://example.com:8005/imageconverter/getKeyCount
https://example.com:8005/imageconverter/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

200

Image Server status 'ok', returning the keyCount object as response

500

Image Server response in case of an Image Server error

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "count": 0
}

getKeys

get /getKeys
http://example.com:8005/imageconverter/getKeys
https://example.com:8005/imageconverter/getKeys

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

query Parameters
context
string
Default: ""

The context of the image group, if specified.

Responses

200

Image Server status 'ok', returning the 'keys' array object as response

500

Image Server response in case of an Image Server error

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "keys":
    [
    ]
}

status

get /status
http://example.com:8005/imageconverter/status
https://example.com:8005/imageconverter/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

200

ImageConverter status message when successfull.