props

Response data properties. Evaluates the current request as if it were an image request (req=img), but instead of returning the image, the server returns selected properties of the reply image.

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

reqId

Unique request identifier.

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.

See Properties for a description of the reply syntax and the response MIME type. The HTTP response is cacheable with a TTL based on attribute::NonImgExpiration.

The following properties are returned for /is/image requests:

Property Type Description

image.bgc

hex

Background color (See bgc= .)

image.height

integer

Reply image height in pixels

image.iccEmbed

boolean

True if the ICC profile is embedded in the reply image. (See IccEmbed= .)

image.iccProfile

string

Name/description of the profile associated with the reply image.

image.length

integer

Reply size in pixels not including the HTTP header; 0 if the reply image data has not been cached previously by the server. (See req=loadcache .)

image.mask

enum

1 if the reply image includes an alpha channel, 0 otherwise.

image.pixTyp

string

Reply image type, may be CMYK , RGB or BW (for gray-scale images).

image.pathEmbed

boolean

1 if the response image embeds any paths, 0 otherwise. (See pathEmbed= .)

image.printRes

real

Print resolution (dpi)

image.quality

integer

JPEG quality. (See qlt= .)

image.type

string

Mime type for the reply image. (See fmt= .)

image.width

integer

Reply image width in pixels.

image.xmpEmbed

boolean

1 if the response image embeds xmp data, 0 otherwise. (See xmpEmbed= .)

image.version

string

Image version identifier. (See id= .)

metadata.version

string

Metadata version identifier. (See id= .)

The following properties are returned for /is/content requests:

Property Type Description

path

string

Partially resolved file path. (See static::Path .)

length

int

Object file size in bytes

expiration

double

static::Expiration or the default time to live

lastModified

string

Modification date/time (from static::TimeStamp or the object file)

userType

string

static::UserType

On this page