Overview

Documentation of the Open-Xchange Image Server API. _

Version information

Version : 7.10

Contact information

Contact : Open-Xchange GmbH
Contact Email : info@open-xchange.com

URI scheme

Host : example.com:8006
BasePath : /imageserver
Schemes : HTTP, HTTPS

Tags

  • ImageServer : The ImageServer module

Paths

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.

POST /cacheAndGetImage/{imageKey}/{requestFormat}

Parameters

Type Name Description Schema Default

Path

imageKey
required

The key of the image group.

string

Path

requestFormat
required

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

string

Query

context
optional

The context of the image group, if specified.

string

""

FormData

sourceImage
required

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

file

Responses

HTTP Code Description Schema

200

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

file

500

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

responseGeneral

Consumes

  • multipart/form-data

Produces

  • multipart/form-data

Tags

  • ImageServer

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

POST /cacheAndGetImageAndMetadata/{imageKey}/{requestFormat}

Parameters

Type Name Description Schema Default

Path

imageKey
required

The key of the image group.

string

Path

requestFormat
required

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

string

Query

context
optional

The context of the image group, if specified.

string

""

FormData

sourceImage
required

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

file

Responses

HTTP Code Description Schema

200

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

file

500

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

responseGeneral

Consumes

  • multipart/form-data

Produces

  • multipart/form-data

Tags

  • ImageServer

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

PUT /cacheImage/{imageKey}

Parameters

Type Name Description Schema Default

Path

imageKey
required

The key of the image group.

string

Query

context
optional

The context of the image group, if specified.

string

""

FormData

sourceImage
required

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

file

Responses

HTTP Code Description Schema

200

Image Server response in case of success.

responseGeneral

500

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

responseGeneral

Consumes

  • multipart/form-data

Produces

  • application/json

Tags

  • ImageServer

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

DELETE /clearImages

Parameters

Type Name Description Schema Default

Query

context
optional

The context of the image group, if specified.

string

""

Responses

HTTP Code Description Schema

200

ImageServer response in case of success.

responseGeneral

500

Image Server response in case of an Image Server error

responseGeneral

Produces

  • application/json

Tags

  • ImageServer

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

DELETE /clearImagesByKey/{imageKey}

Parameters

Type Name Description Schema Default

Path

imageKey
required

The key of the image group.

string

Responses

HTTP Code Description Schema

200

Image Server response in case of success.

responseGeneral

500

Image Server response in case of an Image Server error

responseGeneral

Produces

  • application/json

Tags

  • ImageServer

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

GET /getImage/{imageKey}/{requestFormat}

Parameters

Type Name Description Schema Default

Path

imageKey
required

The key of the image group.

string

Path

requestFormat
required

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

string

Query

context
optional

The context of the image group, if specified.

string

""

Responses

HTTP Code Description Schema

200

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

file

500

Image Server response in case of an Image Server error

responseGeneral

Produces

  • multipart/form-data

Tags

  • ImageServer

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

GET /getImageAndMetadata/{imageKey}/{requestFormat}

Parameters

Type Name Description Schema Default

Path

imageKey
required

The key of the image group.

string

Path

requestFormat
required

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

string

Query

context
optional

The context of the image group, if specified.

string

""

Responses

HTTP Code Description Schema

200

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

file

500

Image Server response in case of an Image Server error

responseGeneral

Produces

  • multipart/form-data

Tags

  • ImageServer

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

GET /getKeyCount

Parameters

Type Name Description Schema Default

Query

context
optional

The context of the image group, if specified.

string

""

Responses

HTTP Code Description Schema

200

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

keyCount

500

Image Server response in case of an Image Server error

responseGeneral

Produces

  • application/json

Tags

  • ImageServer

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

GET /getKeys

Parameters

Type Name Description Schema Default

Query

context
optional

The context of the image group, if specified.

string

""

Responses

HTTP Code Description Schema

200

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

keys

500

Image Server response in case of an Image Server error

responseGeneral

Produces

  • application/json

Tags

  • ImageServer

Retrieving the image metadata with the given image key.

GET /getMetadata/{imageKey}

Parameters

Type Name Description Schema Default

Path

imageKey
required

The key of the image group.

string

Query

context
optional

The context of the image group, if specified.

string

""

Responses

HTTP Code Description Schema

200

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

file

500

Image Server response in case of an Image Server error

responseGeneral

Produces

  • multipart/form-data

Tags

  • ImageServer

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

GET /status

Responses

HTTP Code Description Schema

200

ImageServer status message when successfull.

string

Produces

  • text/html

Tags

  • ImageServer

Definitions

keyCount

Name Description Schema

count
optional

The number of keys.

integer(int64)

keys

Name Description Schema

keys
optional

< string > array

metadata

Name Description Schema

Exif
optional

The name of the Metadata group key.

string

File
optional

The name of the Metadata group key.

string

GPS
optional

The name of the Metadata group key.

string

Thumbnail
optional

The name of the Metadata group key.

string

responseGeneral

Name Description Schema

code
optional

The error code after performing the requested operation. The value will be 0 in case of sucess.

integer(int32)

message
optional

The error message after performing the requested operation. The value will be empty in case of success.

string