getImages
get
/ccstore/v1/images
Get Images. Gets an image and optionally resizes and converts it to a different format. Image resizing and conversion is not available for GIF source images. Endpoint responds with a content type of 'application/json' in error conditions, otherwise one of 'image/jpeg', 'image/png', or 'image/gif' depending on the source image and specified parameters.
Request
Supported Media Types
- application/json
Query Parameters
-
alphaChannelColor(optional): string
The hex color code used to replace the transparency layer when converting images to JPEG. Default is FFFFFF.
-
height(optional): integer
The maximum height of the resized image. Required along with the 'width' parameter for the image to be resized.
-
outputFormat(optional): string
Output format of the converted image. JPEG is the only supported output format. When specified, the source image is converted to a JPEG except for GIF images which are not converted.
-
quality(optional): number
Quality of the image transformation: 0.0 (worst/fast) - 1.0 (best/slow). Default is 1.0.
-
source: string
The source location of the original image.
-
width(optional): integer
The maximum width of the resized image. Required along with the 'height' parameter for the image to be resized.
Response
Supported Media Types
- image/jpeg
- image/png
- image/gif
200 Response
Following model is returned when operation succeeds.
Default Response
The error response
Root Schema : errorModel
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code