template

Template Search

Changed on

Search templates this user has access to

get/template

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/template
  • Auth
    none declared

Query parameters

embedstring

Embed related data such as regions, playlists, widgets, tags, campaigns, permissions

sortBy'layout' | 'owner' | 'publishedStatus' | 'modifiedDt' | 'orientation' | 'groupsWithPermissions'

Specifies which field the results are sorted by. Used together with sortDir

sortDir'asc' | 'desc'

Sort direction

Response

successful operation

layoutIdinteger

The layoutId

ownerIdinteger

The userId of the Layout Owner

campaignIdinteger

The id of the Layout's dedicated Campaign

parentIdinteger

The parentId, if this Layout has a draft

publishedStatusIdinteger

The Status Id

publishedStatusstring

The Published Status (Published, Draft or Pending Approval

publishedDatestring

The Published Date

backgroundImageIdinteger

The id of the image media set as the background

schemaVersioninteger

The XLF schema version

layoutstring

The name of the Layout

descriptionstring

The description of the Layout

backgroundColorstring

A HEX string representing the Layout background color

createdDtstring

The datetime the Layout was created

modifiedDtstring

The datetime the Layout was last modified

statusinteger

Flag indicating the Layout status. 1 = valid, 2 = valid with items only assessed by the Display, 3 = build required, 4 = invalid, 5 = built and valid, displays pending notification

retiredinteger

Flag indicating whether the Layout is retired

backgroundzIndexinteger

The Layer that the background should occupy

widthnumber double

The Layout Width

heightnumber double

The Layout Height

orientationstring

The Layout Orientation

displayOrderinteger

If this Layout has been requested by Campaign, then this is the display order of the Layout within the Campaign

durationinteger

A read-only estimate of this Layout's total duration in seconds. This is equal to the longest region duration and is valid when the layout status is 1, 2 or 5.

statusMessagestring

A status message detailing any errors with the layout

enableStatinteger

Flag indicating whether the Layout stat is enabled

autoApplyTransitionsinteger

Flag indicating whether the default transitions should be applied to this Layout

codestring

Code identifier for this Layout

isLockedboolean

Is this layout locked by another user?

folderIdinteger

The id of the Folder this Layout belongs to

permissionsFolderIdinteger

The id of the Folder responsible for providing permissions for this Layout

Changes

  • fe497e811c7fRevision changes
    • info

      added the new optional query request parameter embed

    • info

      added the new optional query request parameter sortBy

    • info

      added the new optional query request parameter sortDir

  • 41c04de98ec5Revision changes
    • info

      added the media type application/json for the response with the status