req req
Request type. Specifies the type of data requested.
req=debug|contents|img|imageprops|map|object|props|userdata|validate
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:
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:
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 section-e44092e190ff4f6380583e8ed6ea5b0b
Request command. May occur anywhere in the request string.
Default section-00c593cbf1af4364b6b78812e6b93c64
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 section-f7a955525fb44ef2ae7cd7ede25a96c3
fmt= , attribute::ErrorImagePath, vignette::UserData, Properties