Schema Reference Table
The Schema Reference Table defines the allowable object structures and the examples provide further illustration. The Documents, Layouts and Content referenced in the Assembly Template must be defined by Configuration and be Associated to the Assembly Template’s Package Version.
Note:
Property values in the following table are case-sensitive.| Object | Property | Type | Description | Required |
|---|---|---|---|---|
| Assembly Template |
Object |
The top-level object representing the Assembly Template |
||
|
$$Id |
String |
The name of the Package configuration |
Y |
|
|
Documents |
Array | An array of Document objects | N | |
|
Fields |
Array | An array of Field objects. Fields identify how values from instance data will be merged into the output. | N | |
| Document | Object | An object representing a Document | ||
| $$Id | String | The name of the Document configuration | Y | |
| Condition | String | A Json Path expression that identifies an object or objects in the instance data. If no such object or objects are found, the Document will not be included in the output. Default is "true". | N | |
| Iteration | Object | Used when multiple instances of the Document are possible based on occurrences of instance data. | N | |
| Fields | Array | An array of Field objects. Fields identify how values from instance data will be merged into the output. | N | |
| Layouts | Array | An array of Layout objects. Layouts describe the sections of the Document and their relative positioning. Every Document must have at least one Layout. | N | |
| Field | Object | An object representing data values to be substituted into Content | ||
| Name | String | The name of the Field as it is known to its container. It becomes the property name in the output. | Y | |
| Path | String | The Json path used to identify the instance data which will become a property value in the output. | Y | |
| Mandatory | Boolean | Indicates if the field is mandatory. By default, it is set to true. | N | |
| Layout | Object | Describes a Layout | Y | |
| $$Id | String | The name of the Layout configuration | Y | |
| Condition | String | A Json Path expression that identifies an object or objects in the instance data. If no such object or objects are found, the Layout will not be included in the output. Default is "true". | N | |
| Contents | Array | An array of Content objects. | N | |
| Iteration | Object | Used when multiple instances of the Layout are possible based on occurrences of instance data | N | |
| Iteration | Object | Describes the containing object (Document, Layout, Content) may be repeated based on multiple occurrences of some object/property in the instance data. | ||
| $$Id | String | The name of the Iteration | Y | |
| Type | String | The type of the iteration can be the following:
|
Y | |
| Path | String | The Json path value that will potentially return multiple values, each of which is used to substitute values into an instance of the Iteration's container. | Y | |
| Fields | An array of Field objects. Fields identify how values from instance data will be merged into the output. | N | ||
| Content | Object | An object representing a block of Content (text, image, video, etc) | ||
| $$Id | Object | An object representing a block of Content (text, image, video, etc) | ||
| Condition | String | The name of the Content Configuration | Y | |
| Iteration | String | A Json Path expression that identifies an object or objects in the instance data. If no such object or objects are found, the Content will not be included in the output. Default is "true". | N | |
| Object | Used when multiple instances of the Content may be produced for multiple occurrences of some specified instance data | N |