DocumentationDynamic Media Image Serving and Rendering API

Introduction introduction

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

CREATED FOR:

  • Developer
  • User

This document describes the material catalog for Dynamic Media Image Rendering.

Intended audience

This documented is intended for experienced programmers and website developers who want to leverage Dynamic Media Image Rendering for a website or a custom application.

It is assumed that the reader is familiar with Dynamic Media Image Authoring and Image Rendering, general HTTP protocol standards and conventions, and basic imaging terminology.

Document conventions

Literal
In syntax sections, non-italic text is literal; this does not apply to white space and the symbols [ ] { } | *.
'literal'
In descriptive sections, non-italic text in single quotes is literal.
parameter
Italics indicate a variable or parameter, to be substituted with an actual value.
attribute::Item
A name prefixed with 'attribute::' refers to an image catalog attribute.
catalog::Item
A name prefixed with 'catalog::' refers to a material catalog data field.
icc::Item
A name prefixed with 'icc::' refers to a field in the ICC color profile map.
macro::Item
A name prefixed with 'macro::' refers to a field in the macro definition table.
ruleset::Item
A name prefixed with 'ruleset::' refers to an element in a URL pre-processing rule set.
default::Item
A name prefixed with 'default::' refers to an attribute of the default image catalog.
vignette::Item
A name prefixed with 'vignette::' refers to a field in the vignette map.
[ optional ]
Optional syntax elements are enclosed by square brackets.
*[ optional ]
The optional syntax element may be repeated none or more times.
item1 | item2
A vertical bar indicates that either the single syntax item to the left or the item to right may be used. Exactly one item must be selected.
{ group }
Curly braces are used to group syntax elements.
*{ group }
The syntax elements within the group may be repeated one or more times.
White space.
White space (spaces or tabs) is not allowed in HTTP requests. This document occasionally uses white space between syntactic elements for clarity only.
recommendation-more-help
a26166cd-f2f4-45ce-996d-96a0f0d6cf49