Download OpenAPI specification:Download
Documentation of the Open-Xchange ImageConverter HTTP API.
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.
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. |
context | string Default: "" The context of the image group, if specified. |
sourceImage required | string <binary> The source image file for which the preview images are to be created. |
Image Server status 'ok', returning the result image, that is directly written into the output stream.
Image Server response in case of an error, returning the 'error' object
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
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. |
context | string Default: "" The context of the image group, if specified. |
sourceImage required | string <binary> The source image file for which the preview images are to be created. |
Image Server status 'ok', returning the result image and the source image metadata as multipart/form-data response.
Image Server response in case of an error, returning the 'error' object
Creating a new sequence of preview images for a source image under a certain image key.
imageKey required | string The key of the image group. |
context | string Default: "" The context of the image group, if specified. |
sourceImage required | string <binary> The source image file for which the preview images are to be created. |
Image Server response in case of success.
Image Server response in case of an error, returning the 'error' object
{- "code": 0,
- "message": "string"
}
Retrieving the image with the given image key and best matching request format.
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. |
context | string Default: "" The context of the image group, if specified. |
Image Server status 'ok', returning the result image, that is directly written into the output stream.
Image Server response in case of an Image Server error
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
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. |
context | string Default: "" The context of the image group, if specified. |
Image Server status 'ok', returning the result image and the source image metadata as multipart/form-data response.
Image Server response in case of an Image Server error
Retrieving the image metadata with the given image key.
imageKey required | string The key of the image group. |
context | string Default: "" The context of the image group, if specified. |
Image Server status 'ok', returning the metadata object as multipart/form-data response
Image Server response in case of an Image Server error
Removing all images from the Image Server. This call leaves an Image Server with no images left after a succesful request!
context | string Default: "" The context of the image group, if specified. |
ImageConverter response in case of success.
Image Server response in case of an Image Server error
{- "code": 0,
- "message": "string"
}
Removing all images matching the specified key from the Image Server.
imageKey required | string The key of the image group. |
Image Server response in case of success.
Image Server response in case of an Image Server error
{- "code": 0,
- "message": "string"
}
Retrieving either the number of all keys or the number of keys that match the given context from the Image Server.
context | string Default: "" The context of the image group, if specified. |
Image Server status 'ok', returning the keyCount object as response
Image Server response in case of an Image Server error
{- "count": 0
}
Retrieving either all keys or the keys that match the given context from the Image Server.
context | string Default: "" The context of the image group, if specified. |
Image Server status 'ok', returning the 'keys' array object as response
Image Server response in case of an Image Server error
{- "keys": [
- "string"
]
}
Getting the current status of the Image Server as text/html response.
metrics | string Default: "false" Set to "yes", if a metrics summary should be returned. |
ImageConverter status message when successfull.