playlist

Assign Library Items

Changed on

Assign Media from the Library to this Playlist

post/playlist/library/assign/{playlistId}

Request

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

Path parameters

playlistIdinteger required

The Playlist ID to assign to

Request body application/x-www-form-urlencoded

mediainteger[] required

Array of Media IDs to assign

durationinteger

Optional duration for all Media in this assignment to use on the Widget

useDurationinteger

Optional flag indicating whether to enable the useDuration field

displayOrderinteger

Optional integer to say which position this assignment should occupy in the list. If more than one media item is being added, this will be the position of the first one.

Response

successful operation

playlistIdinteger

The ID of this Playlist

ownerIdinteger

The userId of the User that owns this Playlist

namestring

The Name of the Playlist

regionIdinteger

The RegionId if this Playlist is specific to a Region

isDynamicinteger

Flag indicating if this is a dynamic Playlist

filterMediaNamestring

Filter Name for a Dynamic Playlist

filterMediaNameLogicalOperatorstring

Which logical operator should be used when filtering by multiple Plalust names? OR|AND

filterMediaTagsstring

Filter Tags for a Dynamic Playlist

filterExactTagsinteger

Flag indicating whether to filter by exact Tag match

filterMediaTagsLogicalOperatorstring

Which logical operator should be used when filtering by multiple Tags? OR|AND

filterFolderIdinteger

The ID of the folder to filter media items by

maxNumberOfItemsinteger

Maximum number of Media items matching dynamic Playlist filters

createdDtstring

The datetime this entity was created

modifiedDtstring

The datetime this entity was last modified

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.

requiresDurationUpdateinteger

Flag indicating whether this Playlists requires a duration update

enableStatstring

The option to enable the collection of Playlist Proof of Play statistics

folderIdinteger

The id of the Folder this Playlist belongs to

permissionsFolderIdinteger

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

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