Images

GET Image

This endpoint returns a list of assets available for the account that is identified by the given security token.

    http://<publish-url>/public/api/images/{imageId}/raw
Table 1. Parameters
Parameter Parameter Type Data Type Mandatory Description
height query long no The expected image height where height >= 1
heightScale query float no Scaling factor to be applied to the height of the image where heightscale > 0
imageFormat query enum no Image format to be retrieves, following formats: PNG, JPG or BMP.
imageId path long yes The ID of the image resource to retrieve
resizeMode query enum no  
width query long no The expected image width where width >= 1
widthScale query float no Scaling factor to be applied to the width of the image where widthscale > 0
Table 2. Resize Model Supported
Mode Behaviour
SCALE Ignore specified target width and target height and scale source image width by specified scale x and source image height by specified scale y
FIXED_WIDTH Ignore target height, use target width and scale source image height to maintain source aspect ratio.
FIXED_HEIGHT Ignore target width, use target height and scale source image width to maintain source aspect ratio.
DISTORT Use specified target width and target height and distort image if required
CROP Use specified target width and target height and crop image if required to maintain source aspect ratio - crops equally from centre point.

Example of an API call:

http://10.13.1.39:18106/public/api/10103images/raw

Was this article helpful?