XIxibosignage
playlist

Search Playlists

Changed on

Search for Playlists viewable by this user

get/playlist

Request

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

Query parameters

playlistIdinteger

Filter by Playlist Id

namestring

Filter by partial Playlist name

userIdinteger

Filter by user Id

tagsstring

Filter by tags

exactTagsinteger

A flag indicating whether to treat the tags filter as an exact match

logicalOperatorstring

When filtering by multiple Tags, which logical operator should be used? AND|OR

ownerUserGroupIdinteger

Filter by users in this UserGroupId

embedstring

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

folderIdinteger

Filter by Folder ID

modifiedDateFromstring

Filter by modified date, greater than or equal

modifiedDateTostring

Filter by modified date, less than or equal

sortBy'playlistId' | 'name' | 'duration' | 'owner' | 'isDynamic' | 'enableStat' | 'createdDt' | 'modifiedDt' | 'groupsWithPermissions'

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

sortDir'asc' | 'desc'

Sort direction

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

  • fe497e811c7fRevision changes
    • info

      added the new optional query request parameter modifiedDateFrom

    • info

      added the new optional query request parameter modifiedDateTo

    • 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