DocumentationDynamic Media Image Serving and Rendering API

req

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

CREATED FOR:

  • Developer
  • User

Request type. Specifies the type of data requested.

req=debug|contents|img|imageprops|map|object|props|userdata|validate

debugRun commands in debug mode.
contentsReturn information about the objects in the vignette.
imgRun commands and return the rendered image.
imagepropsReturn properties of the specified vignette.
mapReturns image map data embedded in the vignette.
objectRun commands and return the rendered image masked to the current object selection.
propsRun commands and return properties of the reply image.
userdataReturns the contents of vignette::UserData .

Unless otherwise noted in the detailed descriptions, the server returns text responses with MIME type <text/plain>.

debug

Executes the specified commands and returns the rendered image. If an error occurs, error and debug information is returned instead of the error image ( attribute::ErrorImagePath).

contents

Returns an XML representation of the object hierarchy in the vignette, including selected object attributes. Other commands in the request are ignored.

img

Executes the specified commands and returns the rendered image. The reply data format and response type are determined by fmt=.

imageprops

Returns selected properties of the vignette file or catalog entry specified in the URL path. See Properties for a description of the reply syntax and response MIME type. Other commands in the request are ignored. The following properties are returned:

PropertyTypeDescription
image.expirationDoubleattribute::Expiration or the default time to live.
image.heightIntegerFull resolution height in pixels.
image.iccProfileStringname/description of the profile associated with this vignette.
image.embeddedIccProfileBoolean1 if the associated profile is embedded in the vignette.
image.embedded PhotoshopPathsBoolean1 if the vignette embeds path data.
image.modifierStringattribute::Modifier or empty if not a catalog entry.
image.pixTypEnumPixel type of the response image; may be 'CMYK', 'RGB' or 'BW' (for grayscale images).
image.printResRealDefault print resolution in dpi.
image.timeStampStringModification date/time (from catalog::TimeStamp or the vignette file).
image.widthIntegerFull resolution width in pixels.
vignette.nameStringVignette name (name string of the root vignette object).
vignette.resRealMaximum object resolution in material resolutionunits (typically pixels/inch).
vignette.res.avgRealAverage object resolution in material resolutionunits (typically pixels/inc material resolutionh).
vignette.res.minRealMinimum object resolution in material resolutionunits (typically pixels/inch).
vignette.versionIntegerVignette file version number.

map

Returns image map data included in the vignette. By default, the map data for all outermost groups is returned. The map data for all innermost groups can be obtained with

req=map&groupLevel=-1

The map data is not scaled to wid= or hei= or otherwise modified. The response MIME type is <text/xml>.

The response data consists of a <map> element containing a set of <area> elements, similar to the HTML <AREA> tag.

Each <area> element includes the standard type= and coord= attributes, and a name= attribute, specifying the vignette group name or name path. Multiple <area> elements with the same name are present if the masks of the corresponding object group have discontinuous regions.

In addition to the default attributes, vignettes can define additional attributes if so authored. Such custom attributes are defined as object group attributes. The names of custom attributes must begin with map to be included in the <area> elements. For example, if the group attributes include map.href=http://www.scene7.com, the corresponding <area> element includes href="http://www.scene7.com".

An XML document with an empty <map> element is returned if the vignette does not include map data.

object

Executes the specified commands and returns the rendered image masked by the residual object selection (the group or object selected with the last sel= or obj= command in the request). Typically used with an image format which supports alpha (see fmt=). If an image format is used which does not support alpha, the areas outside the mask are black.

props

Executes the specified commands and returns vignette properties and group or object properties, rather than the rendered image. See Properties for a description of the reply syntax and the response MIME type. The default selection applies unless obj= or sel= is specified as well (see obj=).

The following properties may be included in the response:

PropertyTypeDescription
image.bgcStringReply image background color.
image.heightIntegerReply image height in pixels.
image.iccEmbedBooleanTrue if the ICC profile is embedded in the reply image (see iccEmbed=).
image.iccProfileStringShortcut name of the profile associated with the reply image (see icc=).
image.maskBooleanTrue if the reply image includes alpha.
image.pathEmbedBooleanTrue if the reply image includes path data (see pathEmbed=).
image.pixTypStringReply image type, may be 'CMYK', 'RGB' or 'BW' (for grayscale images)
image.printResRealPrint resolution (dpi)
image.qualityInteger, booleanJPEG quality and chroma flag (see qlt=)
image.typeStringMime type for the reply image (see fmt=).
image.widthIntegerReply image width in pixels.
selection.attributesStringAttributes string for the current selection.
selection.countIntegerNumber of objects in the current selection.
selection.identIntegerIndent value of the current selection.
select selection.attributes ion.nameStringFull name path of the current object selection.
selection.overlappingIntegernumber of overlap objects in the current selection.
selection.renderableIntegerNumber of renderable objects in the current selection.
selection.texturableIntegerNumber of texturable objects in the current selection.
selection.visibleIntegerCurrent show/hide status of the current selection.
selection.zorderIntegerZ-order value of the first overlap object in the current selection.

userdata

Returns the contents of vignette::UserData. The server replaces all occurrences of '??' in vignette::UserData with line terminators ( <cr><lf>). The reply is formatted as text data with the response MIME type set to <text/plain>.

If the object specified in the URL path does not resolve to a valid vignette map entry, or if the vignette::UserData is empty, the reply only contains a line terminator ( CR/LF).

Any other commands in the request string are ignored.

Properties

Request command. May occur anywhere in the request string.

Default

If the URL does not include an image path or modifiers, then:

#S7Z OK
#Mon Aug 18 17:28:32 PDT 2014
copyright=Copyright (c) 1995-2014 Adobe Systems Incorporated. All rights reserved.

Otherwise, req=img

See also

fmt= , attribute::ErrorImagePath, vignette::UserData, Properties

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