listLayoutRevisions

GET

/api/v1/layouts/{id}/revisions

curl --request GET \
  --url https://example.com/api/v1/layouts/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/revisions \
  --cookie tilecast_session=<tilecast_session>

List layout revisions. Requires an authenticated dashboard user.

Authorizations

• sessionCookie
• userBearer

Parameters

Path Parameters

id

required

string format: uuid

Query Parameters

page

integer

>= 1

pageSize

integer

>= 1 <= 100

Responses

200

Paginated immutable revision history

Media typeapplication/json

object

data

required

object

items

required

Array<object>

object

id

required

string format: uuid

layoutId

required

string format: uuid

revision

required

integer format: int64

>= 1

document

required

object

schemaVersion

required

Only schema version 2 is accepted.

integer

Allowed values: 2

canvas

required

object

width

required

integer

>= 320 <= 7680

height

required

integer

>= 320 <= 7680

orientation

required

string

Allowed values: landscape portrait custom

backgroundColor

required

string

backgroundAssetId

string format: uuid

backgroundVariantId

string format: uuid

safeAreaPercent

required

number

<= 20

placements

required

Array<object>

<= 200 items

object

id

required

string format: uuid

type

required

string

Allowed values: widget asset playlistZone primitive

name

required

string

x

required

number

y

required

number

width

required

number

height

required

number

layer

required

integer

<= 999

opacity

required

number

<= 1

visible

required

boolean

locked

required

boolean

groupId

string format: uuid

widgetId

string format: uuid

assetId

string format: uuid

variantId

string format: uuid

playlistId

string format: uuid

overrides

Legacy Widget placement override bag. The listed values are accepted for saved-document compatibility but are ignored by Studio and Player.

object

fit

string

Allowed values: contain cover stretch

alignment

string

Allowed values: left center right

foregroundColor

string

backgroundColor

string

fallbackVisibility

string

Allowed values: show hide

muted

boolean

primitive

object

kind

required

string

Allowed values: text rectangle circle line group

text

string

<= 4000 characters

fontFamily

Only bundled fonts are accepted for text primitives

string

Allowed values: Inter Roboto Source Sans 3 Noto Sans

fontId

A family from the organization font library. fontFamily stays the bundled fallback

string format: uuid

fontSize

number

>= 8 <= 600

fontWeight

integer

Allowed values: 400 500 600 700 800

textAlign

string

Allowed values: left center right

verticalAlign

string

Allowed values: top center bottom

color

string

backgroundColor

string

lineHeight

number

letterSpacing

number

padding

number

borderWidth

number

borderColor

string

cornerRadius

number

maximumLines

integer

>= 1

overflow

string

Allowed values: clip ellipsis

autoFit

boolean

minimumFontSize

number

fillColor

string

strokeColor

string

strokeWidth

number

binding

object

dataSourceId

required

string format: uuid

field

required

string

>= 1 characters

prefix

string

<= 500 characters

suffix

string

<= 500 characters

fallbackText

string

<= 500 characters

hideWhenEmpty

boolean

format

string

Allowed values: text date-short date-long number integer currency

playback

object

fit

string

Allowed values: contain cover stretch

muted

boolean

loop

boolean

fallback

string

Allowed values: hide background previous

cornerRadius

number

<= 1000

documentSha256

required

string

publishedBy

string format: uuid

publishedAt

required

string format: date-time

total

required

integer

page

required

integer

>= 1

pageSize

required

integer

>= 1

Example

{
  "data": {
    "items": [
      {
        "document": {
          "schemaVersion": 2,
          "canvas": {
            "orientation": "landscape"
          },
          "placements": [
            {
              "type": "widget",
              "overrides": {
                "fit": "contain",
                "alignment": "left",
                "fallbackVisibility": "show"
              },
              "primitive": {
                "kind": "text",
                "fontFamily": "Inter",
                "fontWeight": 400,
                "textAlign": "left",
                "verticalAlign": "top",
                "overflow": "clip",
                "binding": {
                  "format": "text"
                }
              },
              "playback": {
                "fit": "contain",
                "fallback": "hide"
              }
            }
          ]
        }
      }
    ]
  }
}

401

Dashboard authentication required