DocumentationDynamic Media Image Serving and Rendering API

imageprops imageprops

Last update: Mon Jul 12 2021 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Developer
  • User

Source image properties. Returns selected properties of the image file or catalog entry specified in the URL path.

req=imageprops[,text|javascript|xml|{json[&id= *reqId*]}]

reqId
Unique request identifier.

The HTTP response is cacheable with the TTL based on attribute::NonImgExpiration.

Other commands in the request string are ignored.

Requests that support JSONP response format lets you specify the name of the JS callback handler using the extended syntax of req= parameter:

req=...,json [&handler = reqHandler ]

<reqHandler> is the name of the JS handler that is present in the JSONP response. Only a-z, A-Z, and 0-9 characters are allowed. Optional. Default is s7jsonResponse.

The following properties are returned:

Property
Type
Description
image.anchor
int,int
catalog::Anchor or the default anchor point
image.expiration
double
catalog::Expiration or the default time to live
image.height
integer
Full resolution image height in pixels
image.iccProfile
string
Name/description of the profile associated with this image
image. embeddedIccProfile
boolean
1 if the associated profile is embedded in the image
image.embedded PhotoshopPaths
boolean
1 if the image includes Photoshop path data
image. embeddedXmpData
boolean
1 if the image includes XMP data
image.mask
enum
0 for no mask, 1 for premultiplied alpha, 2 for non-premultiplied alpha, and 3 for a separate mask image
image.modifier
string
catalog::Modifier or empty if not a catalog entry
image. photoshopPathNames
string
Comma-separated list of the names of all Photoshop paths associated with this image
image.pixTyp
string
Image type, may be 'CMYK', 'RGB' or 'BW' (for gray-scale images)
image.postModifier
string
attribute::PostModifier or empty if not a catalog entry
image.printRes
real
default print resolution in pixels/inch
image.resolution
real
catalog::Resolution or the default object resolution
image.timeStamp
string
Modification date/time (from catalog::TimeStamp or the image file)
image.thumbRes
real
catalog::ThumbRes or the default thumbnail resolution
image.thumbType
enum
catalog::ThumbType or the default thumbnail type
image.width
integer
Full resolution image width in pixels
image.translatedId
string
Catalog ID to which the object specified in the path is resolved (see Object Id Translation).
recommendation-more-help
a26166cd-f2f4-45ce-996d-96a0f0d6cf49