Versions Compared

Old Version 71

changes.mady.by.user BrightSign TechDocs

Saved on

compared with

New Version 72

changes.mady.by.user BrightSign TechDocs

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: updated parameter/segment info

Use these endpoints to manage dynamic playlists on the network. 

Base URL for these endpoints:  https://api.bsn.cloud/2020/10/REST/Playlists/Dynamic/

_________________________________________________________________________

GET

Retrieves a list of dynamic playlists on the network.

Query String Parameters

filter stringstring optional

An expression for filtering search results. The default value is null.


sort stringstring optional

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"). The default value is null.


marker string optional

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 pageSizeof the previous GET call indicates that the number of dynamic playlist instances exceeds the pageSize.

This parameter is only required if you need more elements in the paged list than the pageSize (100).


pageSize intint optional

The maximum number of dynamic playlist instances that can be contained in the response body. This defaults to the maximum allowed page size (100).

______________________________________________________________

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.

Query String Parameters

filter stringstring required

An expression for filtering search results

______________________________________________________________

Response Body

Success

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

Endpoints:

Table of Contents
maxLevel2
indent20px
excludeEndpoints:



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

Query String Parameter

filter string optional 

An expression for filtering search results. 

______________________________________________________________

Response Body

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

Operations/GET

Returns the operational permissions granted to roles for specific business operations

Response Body

Returns the Business Operations Entity

{id:int}/GET

Returns the dynamic playlist instance with the specified id.

Parameters

Segment

id int  

A unique identifier for the dynamic playlist instance

______________________________________________________________

Response Body

Returns the Dynamic Playlists Entity

{id:int}/PUT

Modifies the specified dynamic playlist instance.

Parameters

Segment

id int  

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.

{id:int}/DELETE

Removes the specified dynamic playlist from the network.

Parameters

Segment

id int  

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.

{name}/GET

Returns the dynamic playlist instance with the specified name.

Parameters

Segment

name string 

The name of the dynamic playlist instance

______________________________________________________________

Response Body

Returns the Dynamic Playlists Entity

{name}/PUT

Modifies the specified dynamic playlist instance.

Parameters

Segment

name string 

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.

{name}/DELETE

Removes the specified dynamic playlist from the network.

Parameters

Segment

name string 

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.

{id:int}/Permissions/GET

Returns object permissions for a given dynamic playlist instance.

Parameters

Segment

id int 

A unique identifier for the dynamic playlist instance

______________________________________________________________

Response Body

Returns the Permission Entity

{id:int}/Permissions/POST

Adds permissions to the specified dynamic playlist instance.

Parameters

Segment

id int 

A unique identifier for the dynamic playlist instance

______________________________________________________________

Request Body

The Permission Entity

______________________________________________________________

Response Body

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

{id:int}/Permissions/DELETE

Removes permissions for the specified dynamic playlist.

Parameters

Segment

id int 

A unique identifier for the dynamic playlist instance

______________________________________________________________

Request Body

The Permission Entity

______________________________________________________________

Response Body

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

{name}/Permissions/GET

Returns object permissions for a given dynamic playlist instance.

Parameters

Segment

name string 

The name of the dynamic playlist instance

______________________________________________________________


Response Body

Returns the Permission Entity

{name}/Permissions/POST

Adds permissions to the specified dynamic playlist instance.

Parameters

Segment

name string 

The name of the dynamic playlist instance

______________________________________________________________

Request Body

The Permission Entity

______________________________________________________________

Response Body

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

{name}/Permissions/DELETE

Removes permissions for the specified dynamic playlist.

Parameters

Segment

name string 

The name of the dynamic playlist instance

______________________________________________________________

Request Body

The Permission Entity

______________________________________________________________

Response Body

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