layout

Add Region

Changed on

Add a Region to a Layout

post/region/{id}

Request

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

Path parameters

idinteger required

The Layout ID to add the Region to

Request body application/x-www-form-urlencoded

typestring

The type of region this should be, zone, frame, playlist or canvas. Default = frame.

widthinteger

The Width, default 250

heightinteger

The Height

topinteger

The Top Coordinate

leftinteger

The Left Coordinate

Response

successful operation

regionIdinteger

The ID of this region

layoutIdinteger

The Layout ID this region belongs to

ownerIdinteger

The userId of the User that owns this Region

typestring

Region Type, zone, playlist, frame or canvas

namestring

The name of this Region

widthnumber double

Width of the region

heightnumber double

Height of the Region

topnumber double

The top coordinate of the Region

leftnumber double

The left coordinate of the Region

zIndexinteger

The z-index of the Region to control Layering

syncKeystring

The syncKey of this Region

durationinteger

A read-only estimate of this Regions's total duration in seconds. This is valid when the parent layout status is 1, 2 or 5.

isDrawerinteger

Flag, whether this region is used as an interactive drawer attached to a layout.

Changes

  • 41c04de98ec5Revision changes
    • breaking

      added required request body

    • info

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

  • 8e1275395104Revision changes
    • breaking

      removed the request body

    • breaking

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