Layout
Layouts
Search for Layouts viewable by this user
Filter by Layout Id
Filter by parent Id
Flag indicating whether to show drafts
Filter by partial Layout name
Filter by user Id
Filter by retired flag
Filter by Tags
A flag indicating whether to treat the tags filter as an exact match
When filtering by multiple Tags, which logical operator should be used? AND|OR
Filter by users in this UserGroupId
Filter by published status id, 1 - Published, 2 - Draft
Embed related data such as regions, playlists, widgets, tags, campaigns, permissions
Get all Layouts for a given campaignId
Filter by Folder ID
Specifies which field the results are sorted by. Used together with sortDir
Sort direction
successful operation
Class Layout
The layoutId
The userId of the Layout Owner
The id of the Layout's dedicated Campaign
The parentId, if this Layout has a draft
The Status Id
The Published Status (Published, Draft or Pending Approval
The Published Date
The id of the image media set as the background
The XLF schema version
The name of the Layout
The description of the Layout
A HEX string representing the Layout background color
The datetime the Layout was created
The datetime the Layout was last modified
Flag indicating the Layout status
Flag indicating whether the Layout is retired
The Layer that the background should occupy
The Layout Width
The Layout Height
The Layout Orientation
If this Layout has been requested by Campaign, then this is the display order of the Layout within the Campaign
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 or 2.
A status message detailing any errors with the layout
Flag indicating whether the Layout stat is enabled
Flag indicating whether the default transitions should be applied to this Layout
Code identifier for this Layout
Is this layout locked by another user?
The id of the Folder this Layout belongs to
The id of the Folder responsible for providing permissions for this Layout
GET /api/layout HTTP/1.1
Accept: */*
successful operation
[
{
"layoutId": 1,
"ownerId": 1,
"campaignId": 1,
"parentId": 1,
"publishedStatusId": 1,
"publishedStatus": "text",
"publishedDate": "text",
"backgroundImageId": 1,
"schemaVersion": 1,
"layout": "text",
"description": "text",
"backgroundColor": "text",
"createdDt": "text",
"modifiedDt": "text",
"status": 1,
"retired": 1,
"backgroundzIndex": 1,
"width": 1,
"height": 1,
"orientation": "text",
"displayOrder": 1,
"duration": 1,
"statusMessage": "text",
"enableStat": 1,
"autoApplyTransitions": 1,
"code": "text",
"isLocked": true,
"regions": [
{
"regionId": 1,
"layoutId": 1,
"ownerId": 1,
"type": "text",
"name": "text",
"width": 1,
"height": 1,
"top": 1,
"left": 1,
"zIndex": 1,
"syncKey": "text",
"regionOptions": [
{
"regionId": 1,
"option": "text",
"value": "text"
}
],
"permissions": [
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
],
"duration": 1,
"isDrawer": 1,
"regionPlaylist": {
"playlistId": 1,
"ownerId": 1,
"name": "text",
"regionId": 1,
"isDynamic": 1,
"filterMediaName": "text",
"filterMediaNameLogicalOperator": "text",
"filterMediaTags": "text",
"filterExactTags": 1,
"filterMediaTagsLogicalOperator": "text",
"filterFolderId": 1,
"maxNumberOfItems": 1,
"createdDt": "text",
"modifiedDt": "text",
"duration": 1,
"requiresDurationUpdate": 1,
"enableStat": "text",
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"widgets": [
{
"widgetId": 1,
"playlistId": 1,
"ownerId": 1,
"type": "text",
"duration": 1,
"displayOrder": 1,
"useDuration": 1,
"calculatedDuration": 1,
"createdDt": "text",
"modifiedDt": "text",
"fromDt": 1,
"toDt": 1,
"schemaVersion": 1,
"transitionIn": 1,
"transitionOut": 1,
"transitionDurationIn": 1,
"transitionDurationOut": 1,
"widgetOptions": [
{
"widgetId": 1,
"type": "text",
"option": "text",
"value": "text"
}
],
"mediaIds": [
1
],
"audio": [
{
"widgetId": 1,
"mediaId": 1,
"volume": 1,
"loop": 1
}
],
"permissions": [
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
],
"playlist": "text"
}
],
"permissions": [
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
],
"folderId": 1,
"permissionsFolderId": 1
}
}
],
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"folderId": 1,
"permissionsFolderId": 1
}
]Add a new Layout to the CMS
The layout name
The layout description
If the Layout should be created with a Template, provide the ID, otherwise don't provide
If a Template is not provided, provide the resolutionId for this Layout.
Should we return the Draft Layout or the Published Layout on Success?
Code identifier for this Layout
Folder ID to which this object should be assigned to
successful operation
POST /api/layout HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 112
"name='text'&description='text'&layoutId=1&resolutionId=1&returnDraft=true&code='text'&folderId=1"successful operation
{
"layoutId": 1,
"ownerId": 1,
"campaignId": 1,
"parentId": 1,
"publishedStatusId": 1,
"publishedStatus": "text",
"publishedDate": "text",
"backgroundImageId": 1,
"schemaVersion": 1,
"layout": "text",
"description": "text",
"backgroundColor": "text",
"createdDt": "text",
"modifiedDt": "text",
"status": 1,
"retired": 1,
"backgroundzIndex": 1,
"width": 1,
"height": 1,
"orientation": "text",
"displayOrder": 1,
"duration": 1,
"statusMessage": "text",
"enableStat": 1,
"autoApplyTransitions": 1,
"code": "text",
"isLocked": true,
"regions": [
{
"regionId": 1,
"layoutId": 1,
"ownerId": 1,
"type": "text",
"name": "text",
"width": 1,
"height": 1,
"top": 1,
"left": 1,
"zIndex": 1,
"syncKey": "text",
"regionOptions": [
{
"regionId": 1,
"option": "text",
"value": "text"
}
],
"permissions": [
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
],
"duration": 1,
"isDrawer": 1,
"regionPlaylist": {
"playlistId": 1,
"ownerId": 1,
"name": "text",
"regionId": 1,
"isDynamic": 1,
"filterMediaName": "text",
"filterMediaNameLogicalOperator": "text",
"filterMediaTags": "text",
"filterExactTags": 1,
"filterMediaTagsLogicalOperator": "text",
"filterFolderId": 1,
"maxNumberOfItems": 1,
"createdDt": "text",
"modifiedDt": "text",
"duration": 1,
"requiresDurationUpdate": 1,
"enableStat": "text",
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"widgets": [
{
"widgetId": 1,
"playlistId": 1,
"ownerId": 1,
"type": "text",
"duration": 1,
"displayOrder": 1,
"useDuration": 1,
"calculatedDuration": 1,
"createdDt": "text",
"modifiedDt": "text",
"fromDt": 1,
"toDt": 1,
"schemaVersion": 1,
"transitionIn": 1,
"transitionOut": 1,
"transitionDurationIn": 1,
"transitionDurationOut": 1,
"widgetOptions": [
{
"widgetId": 1,
"type": "text",
"option": "text",
"value": "text"
}
],
"mediaIds": [
1
],
"audio": [
{
"widgetId": 1,
"mediaId": 1,
"volume": 1,
"loop": 1
}
],
"permissions": [
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
],
"playlist": "text"
}
],
"permissions": [
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
],
"folderId": 1,
"permissionsFolderId": 1
}
}
],
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"folderId": 1,
"permissionsFolderId": 1
}Clear a draft layouts canvas of all widgets and elements, leaving it blank.
The Layout ID to Clear, must be a draft.
successful operation
POST /api/layout/{layoutId} HTTP/1.1
Accept: */*
successful operation
{
"layoutId": 1,
"ownerId": 1,
"campaignId": 1,
"parentId": 1,
"publishedStatusId": 1,
"publishedStatus": "text",
"publishedDate": "text",
"backgroundImageId": 1,
"schemaVersion": 1,
"layout": "text",
"description": "text",
"backgroundColor": "text",
"createdDt": "text",
"modifiedDt": "text",
"status": 1,
"retired": 1,
"backgroundzIndex": 1,
"width": 1,
"height": 1,
"orientation": "text",
"displayOrder": 1,
"duration": 1,
"statusMessage": "text",
"enableStat": 1,
"autoApplyTransitions": 1,
"code": "text",
"isLocked": true,
"regions": [
{
"regionId": 1,
"layoutId": 1,
"ownerId": 1,
"type": "text",
"name": "text",
"width": 1,
"height": 1,
"top": 1,
"left": 1,
"zIndex": 1,
"syncKey": "text",
"regionOptions": [
{
"regionId": 1,
"option": "text",
"value": "text"
}
],
"permissions": [
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
],
"duration": 1,
"isDrawer": 1,
"regionPlaylist": {
"playlistId": 1,
"ownerId": 1,
"name": "text",
"regionId": 1,
"isDynamic": 1,
"filterMediaName": "text",
"filterMediaNameLogicalOperator": "text",
"filterMediaTags": "text",
"filterExactTags": 1,
"filterMediaTagsLogicalOperator": "text",
"filterFolderId": 1,
"maxNumberOfItems": 1,
"createdDt": "text",
"modifiedDt": "text",
"duration": 1,
"requiresDurationUpdate": 1,
"enableStat": "text",
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"widgets": [
{
"widgetId": 1,
"playlistId": 1,
"ownerId": 1,
"type": "text",
"duration": 1,
"displayOrder": 1,
"useDuration": 1,
"calculatedDuration": 1,
"createdDt": "text",
"modifiedDt": "text",
"fromDt": 1,
"toDt": 1,
"schemaVersion": 1,
"transitionIn": 1,
"transitionOut": 1,
"transitionDurationIn": 1,
"transitionDurationOut": 1,
"widgetOptions": [
{
"widgetId": 1,
"type": "text",
"option": "text",
"value": "text"
}
],
"mediaIds": [
1
],
"audio": [
{
"widgetId": 1,
"mediaId": 1,
"volume": 1,
"loop": 1
}
],
"permissions": [
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
],
"playlist": "text"
}
],
"permissions": [
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
],
"folderId": 1,
"permissionsFolderId": 1
}
}
],
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"folderId": 1,
"permissionsFolderId": 1
}Edit a Layout
The Layout Name
The Layout Description
A comma separated list of Tags
A flag indicating whether this Layout is retired.
Flag indicating whether the Layout stat is enabled
Code identifier for this Layout
Folder ID to which this object should be assigned to
successful operation
Class Layout
The layoutId
The userId of the Layout Owner
The id of the Layout's dedicated Campaign
The parentId, if this Layout has a draft
The Status Id
The Published Status (Published, Draft or Pending Approval
The Published Date
The id of the image media set as the background
The XLF schema version
The name of the Layout
The description of the Layout
A HEX string representing the Layout background color
The datetime the Layout was created
The datetime the Layout was last modified
Flag indicating the Layout status
Flag indicating whether the Layout is retired
The Layer that the background should occupy
The Layout Width
The Layout Height
The Layout Orientation
If this Layout has been requested by Campaign, then this is the display order of the Layout within the Campaign
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 or 2.
A status message detailing any errors with the layout
Flag indicating whether the Layout stat is enabled
Flag indicating whether the default transitions should be applied to this Layout
Code identifier for this Layout
Is this layout locked by another user?
The id of the Folder this Layout belongs to
The id of the Folder responsible for providing permissions for this Layout
PUT /api/layout/{layoutId} HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 104
"name='text'&description='text'&tags='text'&retired=1&enableStat=1&code='text'&folderId=1"successful operation
{
"layoutId": 1,
"ownerId": 1,
"campaignId": 1,
"parentId": 1,
"publishedStatusId": 1,
"publishedStatus": "text",
"publishedDate": "text",
"backgroundImageId": 1,
"schemaVersion": 1,
"layout": "text",
"description": "text",
"backgroundColor": "text",
"createdDt": "text",
"modifiedDt": "text",
"status": 1,
"retired": 1,
"backgroundzIndex": 1,
"width": 1,
"height": 1,
"orientation": "text",
"displayOrder": 1,
"duration": 1,
"statusMessage": "text",
"enableStat": 1,
"autoApplyTransitions": 1,
"code": "text",
"isLocked": true,
"regions": [
{
"regionId": 1,
"layoutId": 1,
"ownerId": 1,
"type": "text",
"name": "text",
"width": 1,
"height": 1,
"top": 1,
"left": 1,
"zIndex": 1,
"syncKey": "text",
"regionOptions": [
{
"regionId": 1,
"option": "text",
"value": "text"
}
],
"permissions": [
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
],
"duration": 1,
"isDrawer": 1,
"regionPlaylist": {
"playlistId": 1,
"ownerId": 1,
"name": "text",
"regionId": 1,
"isDynamic": 1,
"filterMediaName": "text",
"filterMediaNameLogicalOperator": "text",
"filterMediaTags": "text",
"filterExactTags": 1,
"filterMediaTagsLogicalOperator": "text",
"filterFolderId": 1,
"maxNumberOfItems": 1,
"createdDt": "text",
"modifiedDt": "text",
"duration": 1,
"requiresDurationUpdate": 1,
"enableStat": "text",
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"widgets": [
{
"widgetId": 1,
"playlistId": 1,
"ownerId": 1,
"type": "text",
"duration": 1,
"displayOrder": 1,
"useDuration": 1,
"calculatedDuration": 1,
"createdDt": "text",
"modifiedDt": "text",
"fromDt": 1,
"toDt": 1,
"schemaVersion": 1,
"transitionIn": 1,
"transitionOut": 1,
"transitionDurationIn": 1,
"transitionDurationOut": 1,
"widgetOptions": [
{
"widgetId": 1,
"type": "text",
"option": "text",
"value": "text"
}
],
"mediaIds": [
1
],
"audio": [
{
"widgetId": 1,
"mediaId": 1,
"volume": 1,
"loop": 1
}
],
"permissions": [
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
],
"playlist": "text"
}
],
"permissions": [
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
],
"folderId": 1,
"permissionsFolderId": 1
}
}
],
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"folderId": 1,
"permissionsFolderId": 1
}Edit a Layout Background
A HEX color to use as the background color of this Layout.
A media ID to use as the background image for this Layout.
The Layer Number to use for the background.
The Resolution ID to use on this Layout.
successful operation
Class Layout
The layoutId
The userId of the Layout Owner
The id of the Layout's dedicated Campaign
The parentId, if this Layout has a draft
The Status Id
The Published Status (Published, Draft or Pending Approval
The Published Date
The id of the image media set as the background
The XLF schema version
The name of the Layout
The description of the Layout
A HEX string representing the Layout background color
The datetime the Layout was created
The datetime the Layout was last modified
Flag indicating the Layout status
Flag indicating whether the Layout is retired
The Layer that the background should occupy
The Layout Width
The Layout Height
The Layout Orientation
If this Layout has been requested by Campaign, then this is the display order of the Layout within the Campaign
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 or 2.
A status message detailing any errors with the layout
Flag indicating whether the Layout stat is enabled
Flag indicating whether the default transitions should be applied to this Layout
Code identifier for this Layout
Is this layout locked by another user?
The id of the Folder this Layout belongs to
The id of the Folder responsible for providing permissions for this Layout
PUT /api/layout/background/{layoutId} HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 86
"backgroundColor='text'&backgroundImageId=1&backgroundzIndex=1&resolutionId=1"successful operation
{
"layoutId": 1,
"ownerId": 1,
"campaignId": 1,
"parentId": 1,
"publishedStatusId": 1,
"publishedStatus": "text",
"publishedDate": "text",
"backgroundImageId": 1,
"schemaVersion": 1,
"layout": "text",
"description": "text",
"backgroundColor": "text",
"createdDt": "text",
"modifiedDt": "text",
"status": 1,
"retired": 1,
"backgroundzIndex": 1,
"width": 1,
"height": 1,
"orientation": "text",
"displayOrder": 1,
"duration": 1,
"statusMessage": "text",
"enableStat": 1,
"autoApplyTransitions": 1,
"code": "text",
"isLocked": true,
"regions": [
{
"regionId": 1,
"layoutId": 1,
"ownerId": 1,
"type": "text",
"name": "text",
"width": 1,
"height": 1,
"top": 1,
"left": 1,
"zIndex": 1,
"syncKey": "text",
"regionOptions": [
{
"regionId": 1,
"option": "text",
"value": "text"
}
],
"permissions": [
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
],
"duration": 1,
"isDrawer": 1,
"regionPlaylist": {
"playlistId": 1,
"ownerId": 1,
"name": "text",
"regionId": 1,
"isDynamic": 1,
"filterMediaName": "text",
"filterMediaNameLogicalOperator": "text",
"filterMediaTags": "text",
"filterExactTags": 1,
"filterMediaTagsLogicalOperator": "text",
"filterFolderId": 1,
"maxNumberOfItems": 1,
"createdDt": "text",
"modifiedDt": "text",
"duration": 1,
"requiresDurationUpdate": 1,
"enableStat": "text",
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"widgets": [
{
"widgetId": 1,
"playlistId": 1,
"ownerId": 1,
"type": "text",
"duration": 1,
"displayOrder": 1,
"useDuration": 1,
"calculatedDuration": 1,
"createdDt": "text",
"modifiedDt": "text",
"fromDt": 1,
"toDt": 1,
"schemaVersion": 1,
"transitionIn": 1,
"transitionOut": 1,
"transitionDurationIn": 1,
"transitionDurationOut": 1,
"widgetOptions": [
{
"widgetId": 1,
"type": "text",
"option": "text",
"value": "text"
}
],
"mediaIds": [
1
],
"audio": [
{
"widgetId": 1,
"mediaId": 1,
"volume": 1,
"loop": 1
}
],
"permissions": [
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
],
"playlist": "text"
}
],
"permissions": [
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
],
"folderId": 1,
"permissionsFolderId": 1
}
}
],
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"folderId": 1,
"permissionsFolderId": 1
}Apply a new Template to an existing Layout, replacing it.
If the Layout should be created with a Template, provide the ID, otherwise don't provide
successful operation
No content
PUT /api/layout/applyTemplate/{layoutId} HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 16
"templateId=1"successful operation
No content
Retire a Layout so that it isn't available to Schedule. Existing Layouts will still be played
successful operation
No content
PUT /api/layout/retire/{layoutId} HTTP/1.1
Accept: */*
successful operation
No content
Retire a Layout so that it isn't available to Schedule. Existing Layouts will still be played
successful operation
No content
PUT /api/layout/unretire/{layoutId} HTTP/1.1
Accept: */*
successful operation
No content
Set Enable Stats Collection? to use for the collection of Proof of Play statistics for a Layout.
Flag indicating whether the Layout stat is enabled
successful operation
No content
PUT /api/layout/setenablestat/{layoutId} HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 16
"enableStat=1"successful operation
No content
Copy a Layout, providing a new name if applicable
The Layout ID to Copy
The name for the new Layout
The Description for the new Layout
Flag indicating whether to make new Copies of all Media Files assigned to the Layout being Copied
successful operation
POST /api/layout/copy/{layoutId} HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 55
"name='text'&description='text'©MediaFiles=1"successful operation
{
"layoutId": 1,
"ownerId": 1,
"campaignId": 1,
"parentId": 1,
"publishedStatusId": 1,
"publishedStatus": "text",
"publishedDate": "text",
"backgroundImageId": 1,
"schemaVersion": 1,
"layout": "text",
"description": "text",
"backgroundColor": "text",
"createdDt": "text",
"modifiedDt": "text",
"status": 1,
"retired": 1,
"backgroundzIndex": 1,
"width": 1,
"height": 1,
"orientation": "text",
"displayOrder": 1,
"duration": 1,
"statusMessage": "text",
"enableStat": 1,
"autoApplyTransitions": 1,
"code": "text",
"isLocked": true,
"regions": [
{
"regionId": 1,
"layoutId": 1,
"ownerId": 1,
"type": "text",
"name": "text",
"width": 1,
"height": 1,
"top": 1,
"left": 1,
"zIndex": 1,
"syncKey": "text",
"regionOptions": [
{
"regionId": 1,
"option": "text",
"value": "text"
}
],
"permissions": [
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
],
"duration": 1,
"isDrawer": 1,
"regionPlaylist": {
"playlistId": 1,
"ownerId": 1,
"name": "text",
"regionId": 1,
"isDynamic": 1,
"filterMediaName": "text",
"filterMediaNameLogicalOperator": "text",
"filterMediaTags": "text",
"filterExactTags": 1,
"filterMediaTagsLogicalOperator": "text",
"filterFolderId": 1,
"maxNumberOfItems": 1,
"createdDt": "text",
"modifiedDt": "text",
"duration": 1,
"requiresDurationUpdate": 1,
"enableStat": "text",
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"widgets": [
{
"widgetId": 1,
"playlistId": 1,
"ownerId": 1,
"type": "text",
"duration": 1,
"displayOrder": 1,
"useDuration": 1,
"calculatedDuration": 1,
"createdDt": "text",
"modifiedDt": "text",
"fromDt": 1,
"toDt": 1,
"schemaVersion": 1,
"transitionIn": 1,
"transitionOut": 1,
"transitionDurationIn": 1,
"transitionDurationOut": 1,
"widgetOptions": [
{
"widgetId": 1,
"type": "text",
"option": "text",
"value": "text"
}
],
"mediaIds": [
1
],
"audio": [
{
"widgetId": 1,
"mediaId": 1,
"volume": 1,
"loop": 1
}
],
"permissions": [
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
],
"playlist": "text"
}
],
"permissions": [
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
],
"folderId": 1,
"permissionsFolderId": 1
}
}
],
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"folderId": 1,
"permissionsFolderId": 1
}Tag a Layout with one or more tags
The Layout Id to Tag
An array of tags
successful operation
Class Layout
The layoutId
The userId of the Layout Owner
The id of the Layout's dedicated Campaign
The parentId, if this Layout has a draft
The Status Id
The Published Status (Published, Draft or Pending Approval
The Published Date
The id of the image media set as the background
The XLF schema version
The name of the Layout
The description of the Layout
A HEX string representing the Layout background color
The datetime the Layout was created
The datetime the Layout was last modified
Flag indicating the Layout status
Flag indicating whether the Layout is retired
The Layer that the background should occupy
The Layout Width
The Layout Height
The Layout Orientation
If this Layout has been requested by Campaign, then this is the display order of the Layout within the Campaign
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 or 2.
A status message detailing any errors with the layout
Flag indicating whether the Layout stat is enabled
Flag indicating whether the default transitions should be applied to this Layout
Code identifier for this Layout
Is this layout locked by another user?
The id of the Folder this Layout belongs to
The id of the Folder responsible for providing permissions for this Layout
POST /api/layout/{layoutId}/tag HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 16
"tag=['text']"successful operation
{
"layoutId": 1,
"ownerId": 1,
"campaignId": 1,
"parentId": 1,
"publishedStatusId": 1,
"publishedStatus": "text",
"publishedDate": "text",
"backgroundImageId": 1,
"schemaVersion": 1,
"layout": "text",
"description": "text",
"backgroundColor": "text",
"createdDt": "text",
"modifiedDt": "text",
"status": 1,
"retired": 1,
"backgroundzIndex": 1,
"width": 1,
"height": 1,
"orientation": "text",
"displayOrder": 1,
"duration": 1,
"statusMessage": "text",
"enableStat": 1,
"autoApplyTransitions": 1,
"code": "text",
"isLocked": true,
"regions": [
{
"regionId": 1,
"layoutId": 1,
"ownerId": 1,
"type": "text",
"name": "text",
"width": 1,
"height": 1,
"top": 1,
"left": 1,
"zIndex": 1,
"syncKey": "text",
"regionOptions": [
{
"regionId": 1,
"option": "text",
"value": "text"
}
],
"permissions": [
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
],
"duration": 1,
"isDrawer": 1,
"regionPlaylist": {
"playlistId": 1,
"ownerId": 1,
"name": "text",
"regionId": 1,
"isDynamic": 1,
"filterMediaName": "text",
"filterMediaNameLogicalOperator": "text",
"filterMediaTags": "text",
"filterExactTags": 1,
"filterMediaTagsLogicalOperator": "text",
"filterFolderId": 1,
"maxNumberOfItems": 1,
"createdDt": "text",
"modifiedDt": "text",
"duration": 1,
"requiresDurationUpdate": 1,
"enableStat": "text",
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"widgets": [
{
"widgetId": 1,
"playlistId": 1,
"ownerId": 1,
"type": "text",
"duration": 1,
"displayOrder": 1,
"useDuration": 1,
"calculatedDuration": 1,
"createdDt": "text",
"modifiedDt": "text",
"fromDt": 1,
"toDt": 1,
"schemaVersion": 1,
"transitionIn": 1,
"transitionOut": 1,
"transitionDurationIn": 1,
"transitionDurationOut": 1,
"widgetOptions": [
{
"widgetId": 1,
"type": "text",
"option": "text",
"value": "text"
}
],
"mediaIds": [
1
],
"audio": [
{
"widgetId": 1,
"mediaId": 1,
"volume": 1,
"loop": 1
}
],
"permissions": [
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
],
"playlist": "text"
}
],
"permissions": [
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
],
"folderId": 1,
"permissionsFolderId": 1
}
}
],
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"folderId": 1,
"permissionsFolderId": 1
}Untag a Layout with one or more tags
The Layout Id to Untag
An array of tags
successful operation
Class Layout
The layoutId
The userId of the Layout Owner
The id of the Layout's dedicated Campaign
The parentId, if this Layout has a draft
The Status Id
The Published Status (Published, Draft or Pending Approval
The Published Date
The id of the image media set as the background
The XLF schema version
The name of the Layout
The description of the Layout
A HEX string representing the Layout background color
The datetime the Layout was created
The datetime the Layout was last modified
Flag indicating the Layout status
Flag indicating whether the Layout is retired
The Layer that the background should occupy
The Layout Width
The Layout Height
The Layout Orientation
If this Layout has been requested by Campaign, then this is the display order of the Layout within the Campaign
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 or 2.
A status message detailing any errors with the layout
Flag indicating whether the Layout stat is enabled
Flag indicating whether the default transitions should be applied to this Layout
Code identifier for this Layout
Is this layout locked by another user?
The id of the Folder this Layout belongs to
The id of the Folder responsible for providing permissions for this Layout
POST /api/layout/{layoutId}/untag HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 16
"tag=['text']"successful operation
{
"layoutId": 1,
"ownerId": 1,
"campaignId": 1,
"parentId": 1,
"publishedStatusId": 1,
"publishedStatus": "text",
"publishedDate": "text",
"backgroundImageId": 1,
"schemaVersion": 1,
"layout": "text",
"description": "text",
"backgroundColor": "text",
"createdDt": "text",
"modifiedDt": "text",
"status": 1,
"retired": 1,
"backgroundzIndex": 1,
"width": 1,
"height": 1,
"orientation": "text",
"displayOrder": 1,
"duration": 1,
"statusMessage": "text",
"enableStat": 1,
"autoApplyTransitions": 1,
"code": "text",
"isLocked": true,
"regions": [
{
"regionId": 1,
"layoutId": 1,
"ownerId": 1,
"type": "text",
"name": "text",
"width": 1,
"height": 1,
"top": 1,
"left": 1,
"zIndex": 1,
"syncKey": "text",
"regionOptions": [
{
"regionId": 1,
"option": "text",
"value": "text"
}
],
"permissions": [
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
],
"duration": 1,
"isDrawer": 1,
"regionPlaylist": {
"playlistId": 1,
"ownerId": 1,
"name": "text",
"regionId": 1,
"isDynamic": 1,
"filterMediaName": "text",
"filterMediaNameLogicalOperator": "text",
"filterMediaTags": "text",
"filterExactTags": 1,
"filterMediaTagsLogicalOperator": "text",
"filterFolderId": 1,
"maxNumberOfItems": 1,
"createdDt": "text",
"modifiedDt": "text",
"duration": 1,
"requiresDurationUpdate": 1,
"enableStat": "text",
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"widgets": [
{
"widgetId": 1,
"playlistId": 1,
"ownerId": 1,
"type": "text",
"duration": 1,
"displayOrder": 1,
"useDuration": 1,
"calculatedDuration": 1,
"createdDt": "text",
"modifiedDt": "text",
"fromDt": 1,
"toDt": 1,
"schemaVersion": 1,
"transitionIn": 1,
"transitionOut": 1,
"transitionDurationIn": 1,
"transitionDurationOut": 1,
"widgetOptions": [
{
"widgetId": 1,
"type": "text",
"option": "text",
"value": "text"
}
],
"mediaIds": [
1
],
"audio": [
{
"widgetId": 1,
"mediaId": 1,
"volume": 1,
"loop": 1
}
],
"permissions": [
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
],
"playlist": "text"
}
],
"permissions": [
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
],
"folderId": 1,
"permissionsFolderId": 1
}
}
],
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"folderId": 1,
"permissionsFolderId": 1
}Calculate the Layout status and return a Layout
The Layout Id to get the status
successful operation
Class Layout
The layoutId
The userId of the Layout Owner
The id of the Layout's dedicated Campaign
The parentId, if this Layout has a draft
The Status Id
The Published Status (Published, Draft or Pending Approval
The Published Date
The id of the image media set as the background
The XLF schema version
The name of the Layout
The description of the Layout
A HEX string representing the Layout background color
The datetime the Layout was created
The datetime the Layout was last modified
Flag indicating the Layout status
Flag indicating whether the Layout is retired
The Layer that the background should occupy
The Layout Width
The Layout Height
The Layout Orientation
If this Layout has been requested by Campaign, then this is the display order of the Layout within the Campaign
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 or 2.
A status message detailing any errors with the layout
Flag indicating whether the Layout stat is enabled
Flag indicating whether the default transitions should be applied to this Layout
Code identifier for this Layout
Is this layout locked by another user?
The id of the Folder this Layout belongs to
The id of the Folder responsible for providing permissions for this Layout
GET /api/layout/status/{layoutId} HTTP/1.1
Accept: */*
successful operation
{
"layoutId": 1,
"ownerId": 1,
"campaignId": 1,
"parentId": 1,
"publishedStatusId": 1,
"publishedStatus": "text",
"publishedDate": "text",
"backgroundImageId": 1,
"schemaVersion": 1,
"layout": "text",
"description": "text",
"backgroundColor": "text",
"createdDt": "text",
"modifiedDt": "text",
"status": 1,
"retired": 1,
"backgroundzIndex": 1,
"width": 1,
"height": 1,
"orientation": "text",
"displayOrder": 1,
"duration": 1,
"statusMessage": "text",
"enableStat": 1,
"autoApplyTransitions": 1,
"code": "text",
"isLocked": true,
"regions": [
{
"regionId": 1,
"layoutId": 1,
"ownerId": 1,
"type": "text",
"name": "text",
"width": 1,
"height": 1,
"top": 1,
"left": 1,
"zIndex": 1,
"syncKey": "text",
"regionOptions": [
{
"regionId": 1,
"option": "text",
"value": "text"
}
],
"permissions": [
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
],
"duration": 1,
"isDrawer": 1,
"regionPlaylist": {
"playlistId": 1,
"ownerId": 1,
"name": "text",
"regionId": 1,
"isDynamic": 1,
"filterMediaName": "text",
"filterMediaNameLogicalOperator": "text",
"filterMediaTags": "text",
"filterExactTags": 1,
"filterMediaTagsLogicalOperator": "text",
"filterFolderId": 1,
"maxNumberOfItems": 1,
"createdDt": "text",
"modifiedDt": "text",
"duration": 1,
"requiresDurationUpdate": 1,
"enableStat": "text",
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"widgets": [
{
"widgetId": 1,
"playlistId": 1,
"ownerId": 1,
"type": "text",
"duration": 1,
"displayOrder": 1,
"useDuration": 1,
"calculatedDuration": 1,
"createdDt": "text",
"modifiedDt": "text",
"fromDt": 1,
"toDt": 1,
"schemaVersion": 1,
"transitionIn": 1,
"transitionOut": 1,
"transitionDurationIn": 1,
"transitionDurationOut": 1,
"widgetOptions": [
{
"widgetId": 1,
"type": "text",
"option": "text",
"value": "text"
}
],
"mediaIds": [
1
],
"audio": [
{
"widgetId": 1,
"mediaId": 1,
"volume": 1,
"loop": 1
}
],
"permissions": [
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
],
"playlist": "text"
}
],
"permissions": [
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
],
"folderId": 1,
"permissionsFolderId": 1
}
}
],
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"folderId": 1,
"permissionsFolderId": 1
}Checkout a Layout so that it can be edited. The original Layout will still be played
The Layout ID
successful operation
Class Layout
The layoutId
The userId of the Layout Owner
The id of the Layout's dedicated Campaign
The parentId, if this Layout has a draft
The Status Id
The Published Status (Published, Draft or Pending Approval
The Published Date
The id of the image media set as the background
The XLF schema version
The name of the Layout
The description of the Layout
A HEX string representing the Layout background color
The datetime the Layout was created
The datetime the Layout was last modified
Flag indicating the Layout status
Flag indicating whether the Layout is retired
The Layer that the background should occupy
The Layout Width
The Layout Height
The Layout Orientation
If this Layout has been requested by Campaign, then this is the display order of the Layout within the Campaign
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 or 2.
A status message detailing any errors with the layout
Flag indicating whether the Layout stat is enabled
Flag indicating whether the default transitions should be applied to this Layout
Code identifier for this Layout
Is this layout locked by another user?
The id of the Folder this Layout belongs to
The id of the Folder responsible for providing permissions for this Layout
PUT /api/layout/checkout/{layoutId} HTTP/1.1
Accept: */*
successful operation
{
"layoutId": 1,
"ownerId": 1,
"campaignId": 1,
"parentId": 1,
"publishedStatusId": 1,
"publishedStatus": "text",
"publishedDate": "text",
"backgroundImageId": 1,
"schemaVersion": 1,
"layout": "text",
"description": "text",
"backgroundColor": "text",
"createdDt": "text",
"modifiedDt": "text",
"status": 1,
"retired": 1,
"backgroundzIndex": 1,
"width": 1,
"height": 1,
"orientation": "text",
"displayOrder": 1,
"duration": 1,
"statusMessage": "text",
"enableStat": 1,
"autoApplyTransitions": 1,
"code": "text",
"isLocked": true,
"regions": [
{
"regionId": 1,
"layoutId": 1,
"ownerId": 1,
"type": "text",
"name": "text",
"width": 1,
"height": 1,
"top": 1,
"left": 1,
"zIndex": 1,
"syncKey": "text",
"regionOptions": [
{
"regionId": 1,
"option": "text",
"value": "text"
}
],
"permissions": [
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
],
"duration": 1,
"isDrawer": 1,
"regionPlaylist": {
"playlistId": 1,
"ownerId": 1,
"name": "text",
"regionId": 1,
"isDynamic": 1,
"filterMediaName": "text",
"filterMediaNameLogicalOperator": "text",
"filterMediaTags": "text",
"filterExactTags": 1,
"filterMediaTagsLogicalOperator": "text",
"filterFolderId": 1,
"maxNumberOfItems": 1,
"createdDt": "text",
"modifiedDt": "text",
"duration": 1,
"requiresDurationUpdate": 1,
"enableStat": "text",
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"widgets": [
{
"widgetId": 1,
"playlistId": 1,
"ownerId": 1,
"type": "text",
"duration": 1,
"displayOrder": 1,
"useDuration": 1,
"calculatedDuration": 1,
"createdDt": "text",
"modifiedDt": "text",
"fromDt": 1,
"toDt": 1,
"schemaVersion": 1,
"transitionIn": 1,
"transitionOut": 1,
"transitionDurationIn": 1,
"transitionDurationOut": 1,
"widgetOptions": [
{
"widgetId": 1,
"type": "text",
"option": "text",
"value": "text"
}
],
"mediaIds": [
1
],
"audio": [
{
"widgetId": 1,
"mediaId": 1,
"volume": 1,
"loop": 1
}
],
"permissions": [
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
],
"playlist": "text"
}
],
"permissions": [
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
],
"folderId": 1,
"permissionsFolderId": 1
}
}
],
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"folderId": 1,
"permissionsFolderId": 1
}Publish a Layout, discarding the original
The Layout ID
Flag, indicating whether to publish layout now
The date/time at which layout should be published
successful operation
Class Layout
The layoutId
The userId of the Layout Owner
The id of the Layout's dedicated Campaign
The parentId, if this Layout has a draft
The Status Id
The Published Status (Published, Draft or Pending Approval
The Published Date
The id of the image media set as the background
The XLF schema version
The name of the Layout
The description of the Layout
A HEX string representing the Layout background color
The datetime the Layout was created
The datetime the Layout was last modified
Flag indicating the Layout status
Flag indicating whether the Layout is retired
The Layer that the background should occupy
The Layout Width
The Layout Height
The Layout Orientation
If this Layout has been requested by Campaign, then this is the display order of the Layout within the Campaign
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 or 2.
A status message detailing any errors with the layout
Flag indicating whether the Layout stat is enabled
Flag indicating whether the default transitions should be applied to this Layout
Code identifier for this Layout
Is this layout locked by another user?
The id of the Folder this Layout belongs to
The id of the Folder responsible for providing permissions for this Layout
PUT /api/layout/publish/{layoutId} HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 37
"publishNow=1&publishDate='text'"successful operation
{
"layoutId": 1,
"ownerId": 1,
"campaignId": 1,
"parentId": 1,
"publishedStatusId": 1,
"publishedStatus": "text",
"publishedDate": "text",
"backgroundImageId": 1,
"schemaVersion": 1,
"layout": "text",
"description": "text",
"backgroundColor": "text",
"createdDt": "text",
"modifiedDt": "text",
"status": 1,
"retired": 1,
"backgroundzIndex": 1,
"width": 1,
"height": 1,
"orientation": "text",
"displayOrder": 1,
"duration": 1,
"statusMessage": "text",
"enableStat": 1,
"autoApplyTransitions": 1,
"code": "text",
"isLocked": true,
"regions": [
{
"regionId": 1,
"layoutId": 1,
"ownerId": 1,
"type": "text",
"name": "text",
"width": 1,
"height": 1,
"top": 1,
"left": 1,
"zIndex": 1,
"syncKey": "text",
"regionOptions": [
{
"regionId": 1,
"option": "text",
"value": "text"
}
],
"permissions": [
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
],
"duration": 1,
"isDrawer": 1,
"regionPlaylist": {
"playlistId": 1,
"ownerId": 1,
"name": "text",
"regionId": 1,
"isDynamic": 1,
"filterMediaName": "text",
"filterMediaNameLogicalOperator": "text",
"filterMediaTags": "text",
"filterExactTags": 1,
"filterMediaTagsLogicalOperator": "text",
"filterFolderId": 1,
"maxNumberOfItems": 1,
"createdDt": "text",
"modifiedDt": "text",
"duration": 1,
"requiresDurationUpdate": 1,
"enableStat": "text",
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"widgets": [
{
"widgetId": 1,
"playlistId": 1,
"ownerId": 1,
"type": "text",
"duration": 1,
"displayOrder": 1,
"useDuration": 1,
"calculatedDuration": 1,
"createdDt": "text",
"modifiedDt": "text",
"fromDt": 1,
"toDt": 1,
"schemaVersion": 1,
"transitionIn": 1,
"transitionOut": 1,
"transitionDurationIn": 1,
"transitionDurationOut": 1,
"widgetOptions": [
{
"widgetId": 1,
"type": "text",
"option": "text",
"value": "text"
}
],
"mediaIds": [
1
],
"audio": [
{
"widgetId": 1,
"mediaId": 1,
"volume": 1,
"loop": 1
}
],
"permissions": [
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
],
"playlist": "text"
}
],
"permissions": [
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
],
"folderId": 1,
"permissionsFolderId": 1
}
}
],
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"folderId": 1,
"permissionsFolderId": 1
}Discard a Layout restoring the original
The Layout ID
successful operation
Class Layout
The layoutId
The userId of the Layout Owner
The id of the Layout's dedicated Campaign
The parentId, if this Layout has a draft
The Status Id
The Published Status (Published, Draft or Pending Approval
The Published Date
The id of the image media set as the background
The XLF schema version
The name of the Layout
The description of the Layout
A HEX string representing the Layout background color
The datetime the Layout was created
The datetime the Layout was last modified
Flag indicating the Layout status
Flag indicating whether the Layout is retired
The Layer that the background should occupy
The Layout Width
The Layout Height
The Layout Orientation
If this Layout has been requested by Campaign, then this is the display order of the Layout within the Campaign
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 or 2.
A status message detailing any errors with the layout
Flag indicating whether the Layout stat is enabled
Flag indicating whether the default transitions should be applied to this Layout
Code identifier for this Layout
Is this layout locked by another user?
The id of the Folder this Layout belongs to
The id of the Folder responsible for providing permissions for this Layout
PUT /api/layout/discard/{layoutId} HTTP/1.1
Accept: */*
successful operation
{
"layoutId": 1,
"ownerId": 1,
"campaignId": 1,
"parentId": 1,
"publishedStatusId": 1,
"publishedStatus": "text",
"publishedDate": "text",
"backgroundImageId": 1,
"schemaVersion": 1,
"layout": "text",
"description": "text",
"backgroundColor": "text",
"createdDt": "text",
"modifiedDt": "text",
"status": 1,
"retired": 1,
"backgroundzIndex": 1,
"width": 1,
"height": 1,
"orientation": "text",
"displayOrder": 1,
"duration": 1,
"statusMessage": "text",
"enableStat": 1,
"autoApplyTransitions": 1,
"code": "text",
"isLocked": true,
"regions": [
{
"regionId": 1,
"layoutId": 1,
"ownerId": 1,
"type": "text",
"name": "text",
"width": 1,
"height": 1,
"top": 1,
"left": 1,
"zIndex": 1,
"syncKey": "text",
"regionOptions": [
{
"regionId": 1,
"option": "text",
"value": "text"
}
],
"permissions": [
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
],
"duration": 1,
"isDrawer": 1,
"regionPlaylist": {
"playlistId": 1,
"ownerId": 1,
"name": "text",
"regionId": 1,
"isDynamic": 1,
"filterMediaName": "text",
"filterMediaNameLogicalOperator": "text",
"filterMediaTags": "text",
"filterExactTags": 1,
"filterMediaTagsLogicalOperator": "text",
"filterFolderId": 1,
"maxNumberOfItems": 1,
"createdDt": "text",
"modifiedDt": "text",
"duration": 1,
"requiresDurationUpdate": 1,
"enableStat": "text",
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"widgets": [
{
"widgetId": 1,
"playlistId": 1,
"ownerId": 1,
"type": "text",
"duration": 1,
"displayOrder": 1,
"useDuration": 1,
"calculatedDuration": 1,
"createdDt": "text",
"modifiedDt": "text",
"fromDt": 1,
"toDt": 1,
"schemaVersion": 1,
"transitionIn": 1,
"transitionOut": 1,
"transitionDurationIn": 1,
"transitionDurationOut": 1,
"widgetOptions": [
{
"widgetId": 1,
"type": "text",
"option": "text",
"value": "text"
}
],
"mediaIds": [
1
],
"audio": [
{
"widgetId": 1,
"mediaId": 1,
"volume": 1,
"loop": 1
}
],
"permissions": [
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
],
"playlist": "text"
}
],
"permissions": [
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
],
"folderId": 1,
"permissionsFolderId": 1
}
}
],
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"folderId": 1,
"permissionsFolderId": 1
}Add a new full screen Layout with specified Media/Playlist
The Media or Playlist ID that should be added to this Layout
The type of Layout to be created = media or playlist
The Id of the resolution for this Layout, defaults to 1080p for playlist and closest resolution match for Media
A HEX color to use as the background color of this Layout. Default is black #000
Use with media type, to specify the duration this Media should play in one loop
successful operation
POST /api/layout/fullscreen HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 86
"id=1&type='text'&resolutionId=1&backgroundColor='text'&layoutDuration=true"successful operation
{
"layoutId": 1,
"ownerId": 1,
"campaignId": 1,
"parentId": 1,
"publishedStatusId": 1,
"publishedStatus": "text",
"publishedDate": "text",
"backgroundImageId": 1,
"schemaVersion": 1,
"layout": "text",
"description": "text",
"backgroundColor": "text",
"createdDt": "text",
"modifiedDt": "text",
"status": 1,
"retired": 1,
"backgroundzIndex": 1,
"width": 1,
"height": 1,
"orientation": "text",
"displayOrder": 1,
"duration": 1,
"statusMessage": "text",
"enableStat": 1,
"autoApplyTransitions": 1,
"code": "text",
"isLocked": true,
"regions": [
{
"regionId": 1,
"layoutId": 1,
"ownerId": 1,
"type": "text",
"name": "text",
"width": 1,
"height": 1,
"top": 1,
"left": 1,
"zIndex": 1,
"syncKey": "text",
"regionOptions": [
{
"regionId": 1,
"option": "text",
"value": "text"
}
],
"permissions": [
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
],
"duration": 1,
"isDrawer": 1,
"regionPlaylist": {
"playlistId": 1,
"ownerId": 1,
"name": "text",
"regionId": 1,
"isDynamic": 1,
"filterMediaName": "text",
"filterMediaNameLogicalOperator": "text",
"filterMediaTags": "text",
"filterExactTags": 1,
"filterMediaTagsLogicalOperator": "text",
"filterFolderId": 1,
"maxNumberOfItems": 1,
"createdDt": "text",
"modifiedDt": "text",
"duration": 1,
"requiresDurationUpdate": 1,
"enableStat": "text",
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"widgets": [
{
"widgetId": 1,
"playlistId": 1,
"ownerId": 1,
"type": "text",
"duration": 1,
"displayOrder": 1,
"useDuration": 1,
"calculatedDuration": 1,
"createdDt": "text",
"modifiedDt": "text",
"fromDt": 1,
"toDt": 1,
"schemaVersion": 1,
"transitionIn": 1,
"transitionOut": 1,
"transitionDurationIn": 1,
"transitionDurationOut": 1,
"widgetOptions": [
{
"widgetId": 1,
"type": "text",
"option": "text",
"value": "text"
}
],
"mediaIds": [
1
],
"audio": [
{
"widgetId": 1,
"mediaId": 1,
"volume": 1,
"loop": 1
}
],
"permissions": [
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
],
"playlist": "text"
}
],
"permissions": [
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
],
"folderId": 1,
"permissionsFolderId": 1
}
}
],
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"folderId": 1,
"permissionsFolderId": 1
}Add a Region to a Layout
The Layout ID to add the Region to
The type of region this should be, zone, frame, playlist or canvas. Default = frame.
The Width, default 250
The Height
The Top Coordinate
The Left Coordinate
successful operation
POST /api/region/{id} HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 53
"type='text'&width=1&height=1&top=1&left=1"successful operation
{
"regionId": 1,
"layoutId": 1,
"ownerId": 1,
"type": "text",
"name": "text",
"width": 1,
"height": 1,
"top": 1,
"left": 1,
"zIndex": 1,
"syncKey": "text",
"regionOptions": [
{
"regionId": 1,
"option": "text",
"value": "text"
}
],
"permissions": [
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
],
"duration": 1,
"isDrawer": 1,
"regionPlaylist": {
"playlistId": 1,
"ownerId": 1,
"name": "text",
"regionId": 1,
"isDynamic": 1,
"filterMediaName": "text",
"filterMediaNameLogicalOperator": "text",
"filterMediaTags": "text",
"filterExactTags": 1,
"filterMediaTagsLogicalOperator": "text",
"filterFolderId": 1,
"maxNumberOfItems": 1,
"createdDt": "text",
"modifiedDt": "text",
"duration": 1,
"requiresDurationUpdate": 1,
"enableStat": "text",
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"widgets": [
{
"widgetId": 1,
"playlistId": 1,
"ownerId": 1,
"type": "text",
"duration": 1,
"displayOrder": 1,
"useDuration": 1,
"calculatedDuration": 1,
"createdDt": "text",
"modifiedDt": "text",
"fromDt": 1,
"toDt": 1,
"schemaVersion": 1,
"transitionIn": 1,
"transitionOut": 1,
"transitionDurationIn": 1,
"transitionDurationOut": 1,
"widgetOptions": [
{
"widgetId": 1,
"type": "text",
"option": "text",
"value": "text"
}
],
"mediaIds": [
1
],
"audio": [
{
"widgetId": 1,
"mediaId": 1,
"volume": 1,
"loop": 1
}
],
"permissions": [
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
],
"playlist": "text"
}
],
"permissions": [
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
],
"folderId": 1,
"permissionsFolderId": 1
}
}Edit Region
The Region ID to Edit
The Width, default 250
The Height
The Top Coordinate
The Left Coordinate
The Layer for this Region
The Transition Type. Must be a valid transition code as returned by /transition
The transition duration in milliseconds if required by the transition type
The transition direction if required by the transition type.
Flag indicating whether this region should loop if there is only 1 media item in the timeline
successful operation
Class Region
The ID of this region
The Layout ID this region belongs to
The userId of the User that owns this Region
Region Type, zone, playlist, frame or canvas
The name of this Region
Width of the region
Height of the Region
The top coordinate of the Region
The left coordinate of the Region
The z-index of the Region to control Layering
The syncKey of this Region
A read-only estimate of this Regions's total duration in seconds. This is valid when the parent layout status is 1 or 2.
Flag, whether this region is used as an interactive drawer attached to a layout.
PUT /api/region/{id} HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 135
"width=1&height=1&top=1&left=1&zIndex=1&transitionType='text'&transitionDuration=1&transitionDirection='text'&loop=1"successful operation
{
"regionId": 1,
"layoutId": 1,
"ownerId": 1,
"type": "text",
"name": "text",
"width": 1,
"height": 1,
"top": 1,
"left": 1,
"zIndex": 1,
"syncKey": "text",
"regionOptions": [
{
"regionId": 1,
"option": "text",
"value": "text"
}
],
"permissions": [
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
],
"duration": 1,
"isDrawer": 1,
"regionPlaylist": {
"playlistId": 1,
"ownerId": 1,
"name": "text",
"regionId": 1,
"isDynamic": 1,
"filterMediaName": "text",
"filterMediaNameLogicalOperator": "text",
"filterMediaTags": "text",
"filterExactTags": 1,
"filterMediaTagsLogicalOperator": "text",
"filterFolderId": 1,
"maxNumberOfItems": 1,
"createdDt": "text",
"modifiedDt": "text",
"duration": 1,
"requiresDurationUpdate": 1,
"enableStat": "text",
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"widgets": [
{
"widgetId": 1,
"playlistId": 1,
"ownerId": 1,
"type": "text",
"duration": 1,
"displayOrder": 1,
"useDuration": 1,
"calculatedDuration": 1,
"createdDt": "text",
"modifiedDt": "text",
"fromDt": 1,
"toDt": 1,
"schemaVersion": 1,
"transitionIn": 1,
"transitionOut": 1,
"transitionDurationIn": 1,
"transitionDurationOut": 1,
"widgetOptions": [
{
"widgetId": 1,
"type": "text",
"option": "text",
"value": "text"
}
],
"mediaIds": [
1
],
"audio": [
{
"widgetId": 1,
"mediaId": 1,
"volume": 1,
"loop": 1
}
],
"permissions": [
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
],
"playlist": "text"
}
],
"permissions": [
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
],
"folderId": 1,
"permissionsFolderId": 1
}
}Position all regions for a Layout
The Layout ID
Array of regions and their new positions. Each array element should be json encoded and have regionId, top, left, width and height.
successful operation
Class Layout
The layoutId
The userId of the Layout Owner
The id of the Layout's dedicated Campaign
The parentId, if this Layout has a draft
The Status Id
The Published Status (Published, Draft or Pending Approval
The Published Date
The id of the image media set as the background
The XLF schema version
The name of the Layout
The description of the Layout
A HEX string representing the Layout background color
The datetime the Layout was created
The datetime the Layout was last modified
Flag indicating the Layout status
Flag indicating whether the Layout is retired
The Layer that the background should occupy
The Layout Width
The Layout Height
The Layout Orientation
If this Layout has been requested by Campaign, then this is the display order of the Layout within the Campaign
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 or 2.
A status message detailing any errors with the layout
Flag indicating whether the Layout stat is enabled
Flag indicating whether the default transitions should be applied to this Layout
Code identifier for this Layout
Is this layout locked by another user?
The id of the Folder this Layout belongs to
The id of the Folder responsible for providing permissions for this Layout
PUT /api/region/position/all/{layoutId} HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 20
"regions=['text']"successful operation
{
"layoutId": 1,
"ownerId": 1,
"campaignId": 1,
"parentId": 1,
"publishedStatusId": 1,
"publishedStatus": "text",
"publishedDate": "text",
"backgroundImageId": 1,
"schemaVersion": 1,
"layout": "text",
"description": "text",
"backgroundColor": "text",
"createdDt": "text",
"modifiedDt": "text",
"status": 1,
"retired": 1,
"backgroundzIndex": 1,
"width": 1,
"height": 1,
"orientation": "text",
"displayOrder": 1,
"duration": 1,
"statusMessage": "text",
"enableStat": 1,
"autoApplyTransitions": 1,
"code": "text",
"isLocked": true,
"regions": [
{
"regionId": 1,
"layoutId": 1,
"ownerId": 1,
"type": "text",
"name": "text",
"width": 1,
"height": 1,
"top": 1,
"left": 1,
"zIndex": 1,
"syncKey": "text",
"regionOptions": [
{
"regionId": 1,
"option": "text",
"value": "text"
}
],
"permissions": [
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
],
"duration": 1,
"isDrawer": 1,
"regionPlaylist": {
"playlistId": 1,
"ownerId": 1,
"name": "text",
"regionId": 1,
"isDynamic": 1,
"filterMediaName": "text",
"filterMediaNameLogicalOperator": "text",
"filterMediaTags": "text",
"filterExactTags": 1,
"filterMediaTagsLogicalOperator": "text",
"filterFolderId": 1,
"maxNumberOfItems": 1,
"createdDt": "text",
"modifiedDt": "text",
"duration": 1,
"requiresDurationUpdate": 1,
"enableStat": "text",
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"widgets": [
{
"widgetId": 1,
"playlistId": 1,
"ownerId": 1,
"type": "text",
"duration": 1,
"displayOrder": 1,
"useDuration": 1,
"calculatedDuration": 1,
"createdDt": "text",
"modifiedDt": "text",
"fromDt": 1,
"toDt": 1,
"schemaVersion": 1,
"transitionIn": 1,
"transitionOut": 1,
"transitionDurationIn": 1,
"transitionDurationOut": 1,
"widgetOptions": [
{
"widgetId": 1,
"type": "text",
"option": "text",
"value": "text"
}
],
"mediaIds": [
1
],
"audio": [
{
"widgetId": 1,
"mediaId": 1,
"volume": 1,
"loop": 1
}
],
"permissions": [
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
],
"playlist": "text"
}
],
"permissions": [
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
],
"folderId": 1,
"permissionsFolderId": 1
}
}
],
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"folderId": 1,
"permissionsFolderId": 1
}Add a drawer Region to a Layout
The Layout ID to add the Region to
successful operation
POST /api/region/drawer/{id} HTTP/1.1
Accept: */*
successful operation
{
"regionId": 1,
"layoutId": 1,
"ownerId": 1,
"type": "text",
"name": "text",
"width": 1,
"height": 1,
"top": 1,
"left": 1,
"zIndex": 1,
"syncKey": "text",
"regionOptions": [
{
"regionId": 1,
"option": "text",
"value": "text"
}
],
"permissions": [
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
],
"duration": 1,
"isDrawer": 1,
"regionPlaylist": {
"playlistId": 1,
"ownerId": 1,
"name": "text",
"regionId": 1,
"isDynamic": 1,
"filterMediaName": "text",
"filterMediaNameLogicalOperator": "text",
"filterMediaTags": "text",
"filterExactTags": 1,
"filterMediaTagsLogicalOperator": "text",
"filterFolderId": 1,
"maxNumberOfItems": 1,
"createdDt": "text",
"modifiedDt": "text",
"duration": 1,
"requiresDurationUpdate": 1,
"enableStat": "text",
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"widgets": [
{
"widgetId": 1,
"playlistId": 1,
"ownerId": 1,
"type": "text",
"duration": 1,
"displayOrder": 1,
"useDuration": 1,
"calculatedDuration": 1,
"createdDt": "text",
"modifiedDt": "text",
"fromDt": 1,
"toDt": 1,
"schemaVersion": 1,
"transitionIn": 1,
"transitionOut": 1,
"transitionDurationIn": 1,
"transitionDurationOut": 1,
"widgetOptions": [
{
"widgetId": 1,
"type": "text",
"option": "text",
"value": "text"
}
],
"mediaIds": [
1
],
"audio": [
{
"widgetId": 1,
"mediaId": 1,
"volume": 1,
"loop": 1
}
],
"permissions": [
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
],
"playlist": "text"
}
],
"permissions": [
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
],
"folderId": 1,
"permissionsFolderId": 1
}
}Save Drawer
The Drawer ID to Save
The Width, default 250
The Height
successful operation
Class Region
The ID of this region
The Layout ID this region belongs to
The userId of the User that owns this Region
Region Type, zone, playlist, frame or canvas
The name of this Region
Width of the region
Height of the Region
The top coordinate of the Region
The left coordinate of the Region
The z-index of the Region to control Layering
The syncKey of this Region
A read-only estimate of this Regions's total duration in seconds. This is valid when the parent layout status is 1 or 2.
Flag, whether this region is used as an interactive drawer attached to a layout.
PUT /api/region/drawer/{id} HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 22
"width=1&height=1"successful operation
{
"regionId": 1,
"layoutId": 1,
"ownerId": 1,
"type": "text",
"name": "text",
"width": 1,
"height": 1,
"top": 1,
"left": 1,
"zIndex": 1,
"syncKey": "text",
"regionOptions": [
{
"regionId": 1,
"option": "text",
"value": "text"
}
],
"permissions": [
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
],
"duration": 1,
"isDrawer": 1,
"regionPlaylist": {
"playlistId": 1,
"ownerId": 1,
"name": "text",
"regionId": 1,
"isDynamic": 1,
"filterMediaName": "text",
"filterMediaNameLogicalOperator": "text",
"filterMediaTags": "text",
"filterExactTags": 1,
"filterMediaTagsLogicalOperator": "text",
"filterFolderId": 1,
"maxNumberOfItems": 1,
"createdDt": "text",
"modifiedDt": "text",
"duration": 1,
"requiresDurationUpdate": 1,
"enableStat": "text",
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"widgets": [
{
"widgetId": 1,
"playlistId": 1,
"ownerId": 1,
"type": "text",
"duration": 1,
"displayOrder": 1,
"useDuration": 1,
"calculatedDuration": 1,
"createdDt": "text",
"modifiedDt": "text",
"fromDt": 1,
"toDt": 1,
"schemaVersion": 1,
"transitionIn": 1,
"transitionOut": 1,
"transitionDurationIn": 1,
"transitionDurationOut": 1,
"widgetOptions": [
{
"widgetId": 1,
"type": "text",
"option": "text",
"value": "text"
}
],
"mediaIds": [
1
],
"audio": [
{
"widgetId": 1,
"mediaId": 1,
"volume": 1,
"loop": 1
}
],
"permissions": [
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
],
"playlist": "text"
}
],
"permissions": [
{
"permissionId": 1,
"entityId": 1,
"groupId": 1,
"objectId": 1,
"isUser": 1,
"entity": "text",
"objectIdString": "text",
"group": "text",
"view": 1,
"edit": 1,
"delete": 1,
"modifyPermissions": 1
}
],
"folderId": 1,
"permissionsFolderId": 1
}
}Last updated
Was this helpful?