DocumentationDynamic Media Image Serving and Rendering API

id

Last update: November 3, 2023
  • Topics:
  • Dynamic Media Classic,SDK/API

CREATED FOR:

  • Developer
  • User

Image/Metadata Version. When working with content that changes frequently, servers in caching networks such as Akamai, browser caches, and corporate proxy server caches may store Image Serving responses which may be out of date for periods of time.

id= *val*

valVersion string.

Image Serving includes a versioning mechanism which can help reduce the chance that an outdated cache entry is used by an application. This mechanism involves using req=props to obtain version identifier strings for image data and metadata (such as image map or zoom target data). The version identifier string is then added to cacheable Image Serving requests with the id= command.

When a source image or metadata changes, the corresponding version id value also changes. Including an up-to-date version id value with the id= command ensures that old cache entries can no longer be accessed.

The following table lists the version identifier strings to be used for each req= type:

req= typeversion identifier from req=props
imgimage.version
mapmetadata.version
maskimage.version
targetsmetadata.version
tmbimage.version
userdatametadata.version
xmpimage.version

req= types not listed above either have a short TTL ( attribute::NonImgExpiration) or their responses are not cacheable at all; there is no advantage to including id= with such requests.

Properties

Request attribute. Optional. Always ignored by the server.

Default

None.

Example

See the description of rect= for example usage.

See Also

req= , rect=, catalog::Expiration, attribute::NonImgExpiration

recommendation-more-help
a26166cd-f2f4-45ce-996d-96a0f0d6cf49