Show Menu
TOPICS×

req

Request type. Specifies the type of data requested.
req=debug|contents|img|imageprops|map|object|props|userdata|validate
debug
Run commands in debug mode.
contents
Return information about the objects in the vignette.
img
Run commands and return the rendered image.
imageprops
Return properties of the specified vignette.
map
Returns image map data embedded in the vignette.
object
Run commands and return the rendered image masked to the current object selection.
props
Run commands and return properties of the reply image.
userdata
Returns 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 is 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:
Property
Type
Description
image.expiration
Double
attribute::Expiration or the default time to live.
image.height
Integer
Full resolution height in pixels.
image.iccProfile
String
name/description of the profile associated with this vignette.
image.embeddedIccProfile
Boolean
1 if the associated profile is embedded in the vignette.
image.embedded PhotoshopPaths
Boolean
1 if the vignette embeds path data.
image.modifier
String
attribute::Modifier or empty if not a catalog entry.
image.pixTyp
Enum
Pixel type of the response image; may be 'CMYK', 'RGB' or 'BW' (for grayscale images).
image.printRes
Real
Default print resolution in dpi.
image.timeStamp
String
Modification date/time (from catalog::TimeStamp or the vignette file).
image.width
Integer
Full resolution width in pixels.
vignette.name
String
Vignette name (name string of the root vignette object).
vignette.res
Real
Maximum object resolution in material resolution units (typically pixels/inch).
vignette.res.avg
Real
Average object resolution in material resolution units (typically pixels/inc material resolution h).
vignette.res.min
Real
Minimum object resolution in material resolution units (typically pixels/inch).
vignette.version
Integer
Vignette 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, as well as a name= attribute, specifying the vignette group name or name path. Multiple <area> elements with the same name will be present if the masks of the corresponding object group has 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 will include 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 in conjunction 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:
Property
Type
Description
image.bgc
String
Reply image background color.
image.height
Integer
Reply image height in pixels.
image.iccEmbed
Boolean
True if the ICC profile will be embedded in the reply image (see iccEmbed= ).
image.iccProfile
String
Shortcut name of the profile associated with the reply image (see icc= ).
image.mask
Boolean
True if the reply image includes alpha.
image.pathEmbed
Boolean
True if the reply image includes path data (see pathEmbed= ).
image.pixTyp
String
Reply image type, may be 'CMYK', 'RGB' or 'BW' (for grayscale images)
image.printRes
Real
Print resolution (dpi)
image.quality
Integer, boolean
JPEG quality and chroma flag (see qlt= )
image.type
String
Mime type for the reply image (see fmt= ).
image.width
Integer
Reply image width in pixels.
selection.attributes
String
Attributes string for the current selection.
selection.count
Integer
Number of objects in the current selection.
selection.ident
Integer
Indent value of the current selection.
select selection.attributes ion.name
String
Full name path of the current object selection.
selection.overlapping
Integer
number of overlap objects in the current selection.
selection.renderable
Integer
Number of renderable objects in the current selection.
selection.texturable
Integer
Number of texturable objects in the current selection.
selection.visible
Integer
Current show/hide status of the current selection.
selection.zorder
Integer
Z-order value of the first overlap object in the current selection.
userdata
Returns the contents of vignette::UserData . The server will replace 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 will only contain 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