DocumentationDynamic Media Image Serving and Rendering API

vignette vignette

Last update: Fri Nov 03 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Developer
  • User

Vignette file. Specifies the vignette to use for the request.

vignette=[ *catId*/] *recId*|[catId/] *file*

catId
Material catalog id (matched to attribute::RootId).
recId
Vignette ID (matched to vignette::Id).
file
Relative vignette file path and name.

Can either specify a vignette map entry or a vignette file. Remote URLs are not permitted.

vignette= Can be used as an alternative to specifying the vignette in the request URL path. Used to specify vignettes by way of variables in templates.

If catId is not specified, the session catalog is used.

Properties section-f58661fc78d7496e8e3d0fb98b945c4b

May occur anywhere within the request. Overrides the vignette specified with the request URL path.

Default section-db0618d48bc84dc8abcc989550349ccc

None.

See also section-dc2668cc2cd54a74b08cff68a12d4edd

Material Catalogs, Custom Variables

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