JSON Image Parameters

Describes a list of parameters used specifically in the creation of a preview image of content for print, email or web.

This structure is used specifically by the Content Creation service when creating preview images.

Structure

The structure consists of an object with the following optional name/value pairs:

• context – the context to be used in the creation of the preview (value of either print, email or web)
  (type of string – Default value is determined by the first context in the template)

• section – the section to be used within the context specified (as either the context parameter, or else the default context of the template)
  (type of string – Default value is determined by the context specified. For the Print context this will be all enabled sections. For the Email and Web contexts this will be the default section)

• type – the image type/format to be used in the creation of the preview (value of either jpg, jpeg or png)
  (type of string – Default value of jpg)

• dpi – the target image resolution of the preview in dots per inch (DPI)
  (type of number – Default value of 96)

• archive – whether to return the resulting preview as a ZIP file/archive
  (type of boolean – Default value is determined automatically by the number of image files in the preview output)

In addition, a subset of the runtime parameters defined in the template can be passed in the following object:

• parameters – a set of runtime parameter names and their corresponding values, consisting of an object with one or more name/value pairs:

  • <name> – the name (name) and the value of the runtime parameter
    (type of either string, number, or boolean)

Specific to parameters with a type parameter specified to a value of jpg, the following optional name/value pair can be specified:

• quality – the image quality of the preview (value ranging from 0-100)
  (type of number – Default value of 100)

Specific to parameters with a context parameter specified to a value of print, the following optional name/value pair can be specified:

• bleed – whether to include the bleed area in the preview
  (type of boolean – Default value of false)

• pages – the page range to be output in the preview
  (type of string – Default value is determined by the value of the archive parameter. If the archive parameter is specified to false, then the default value will be 1. If the archive parameter is either omitted or specified to a value of true, then the default value will be * (all pages) )

Specific to parameters with a context parameter specified to a value of either email, or web the following optional name/value pair can be specified:

• viewPortWidth – the image width of the preview in pixels
  (type of number – Default value of 1024)

Example

The following is an example of this structure:

{
    "context": "print",
    "type": "png",
    "dpi": 150,
    "archive": true,
    "bleed": true,
    "pages": "1-2"
}

{
    "context": "web",
    "section": "Section 1",
    "type": "jpeg",
    "viewPortWidth": 1024
}

{
    "context": "email",
    "section": "Section 2",
    "type": "jpg",
    "quality": 90
}

{
    "context": "email",
    "section": "Section 2",
    "type": "jpg",
    "quality": 90,
    "parameters": {
	    "country": "Canada",
	    "InvoiceOverdue": true
    }
}