Versions Compared

Old Version 58

changes.mady.by.user BrightSign TechDocs

Saved on

compared with

New Version 59

changes.mady.by.user BrightSign TechDocs

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Use these endpoints to manage dynamic playlists on the network. For constraints on headers, see REST API#Headers.

/Playlists/Dynamic/

GET

Retrieves a list of dynamic playlists on the network.

Parameters

  • [string] filter:  An expression for filtering search results.
  • [string] sort: An expression for sorting the search results. The sort expression specifies the entry used for sorting and the ascending/descending (ASC/DESC) sorting order (e.g. "[device].[serial] ASC")
  • [string] marker: A value specifying which page to retrieve. This value is useful if the isTruncated entry in the response body of the previous GET call indicates that the number of dynamic playlist instances exceeds the pageSize.
  • [int] pageSize: The maximum number of dynamic playlist instances that can be contained in the response body

Response Body

Returns a paged list of Dynamic Playlists Entity instances on a network. This will return not more than 100 entities along with the information necessary to return any other remaining pages.

POST

Create a new dynamic playlist on the network.

Request Body

The Dynamic Playlists Entity

Response Body

Returns a 201 status code and the new resource created and referenced by the Uri (given by the Location header field) in the response. The response includes the Dynamic Playlists Entity.

DELETE

Removes dynamic playlists, specified by a filter, from a network. This allows multiple dynamic playlists to be deleted at once.

Parameters

  • [string] filter:  An expression for filtering search results.

Response Body

Returns the number of affected dynamic playlists as an integer value.


Panel
borderColor#3D3D3D
bgColor#F4F4F4
titleColor#3D3D3D
borderWidth0
titleBGColor#3D3D3D
borderStylesolid

ON THIS PAGE

Table of Contents
maxLevel3
indent20px



/Playlists/Dynamic/Count/

GET

Returns the number of dynamic playlists on the network that match the specified filter criteria. If no filter is included, this call returns the total number of dynamic playlists on the network. 

Parameters

  • [string] filter:  An expression for filtering search results.

Response Body

The number of dynamic playlists is returned as an integer value.

/Playlists/Dynamic/Operations/

GET

Returns the operational permissions granted to roles for specific business operations

Response Body

Returns the Business Operations Entity

/Playlists/Dynamic/{id:int}/

GET

Returns the dynamic playlist instance with the specified id.

Parameters

  • [int] id: A unique identifier for the dynamic playlist instance

Response Body

Returns the Dynamic Playlists Entity

PUT

Modifies the specified dynamic playlist instance.

Parameters

  • [int] id: A unique identifier for the dynamic playlist instance

Request Body

The Dynamic Playlists Entity

Response Body

On success this method returns a status code 2XX, on failure it returns a status code of 5XX.

DELETE

Removes the specified dynamic playlist from the network.

Parameters

  • [int] id:  A unique identifier for the dynamic playlist instance

Response Body

On success this method returns a status code 2XX, on failure it returns a status code of 5XX.

/Playlists/Dynamic/{name}/

GET

Returns the dynamic playlist instance with the specified name.

Parameters

  • [string] name: The name of the dynamic playlist instance

Response Body

Returns the Dynamic Playlists Entity

PUT

Modifies the specified dynamic playlist instance.

Parameters

  • [string] name: The name of the dynamic playlist instance

Request Body

The Dynamic Playlists Entity

Response Body

On success this method returns a status code 2XX, on failure it returns a status code of 5XX.

DELETE

Removes the specified dynamic playlist from the network.

Parameters

  • [string] name:  The name of the dynamic playlist instance

Response Body

On success this method returns a status code 2XX, on failure it returns a status code of 5XX.

/Playlists/Dynamic/{id:int}/Permissions/

GET

Includes object permissions for a given dynamic playlist instance.

Parameters

  • [int] id:  A unique identifier for the dynamic playlist instance

Response Body

Returns the Permission Entity (2020/10)

POST

Adds permissions to the specified dynamic playlist instance.

Parameters

  • [int] id:  A unique identifier for the dynamic playlist instance

Request Body

The The Permission Entity (2020/10)

Response Body

On success this method returns a status code 2XX, on failure it returns a status code of 5XX.

DELETE

Removes permissions for the specified dynamic playlist.

Parameters

  • [int] id:  A unique identifier for the dynamic playlist instance

Request Body

The The Permission Entity (2020/10)

Response Body

On success this method returns a status code 2XX, on failure it returns a status code of 5XX.

/Playlists/Dynamic/{name}/Permissions/

GET

Includes object permissions for a given dynamic playlist instance.

Parameters

  • [string] name:  The name of the dynamic playlist instance


Response Body

Returns the the Permission Entity (2020/10)

POST

Adds permissions to the specified dynamic playlist instance.

Parameters

  • [string] name:  The name the dynamic playlist instance

Request Body

The Permission Entity (2020/10)

Response Body

On success this method returns a status code 2XX, on failure it returns a status code of 5XX.

DELETE

Removes permissions for the specified dynamic playlist.

Parameters

  • [string] name:   The name of the dynamic playlist instance

Request Body

The The Permission Entity (2020/10)

Response Body

On success this method returns a status code 2XX, on failure it returns a status code of 5XX.