Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Use these endpoints to manage dynamic playlists on the network.
Base URL for these endpoints: https://api.brightsignnetwork.com/2017/01/REST/Playlists/Dynamic
GET /
Retrieves a list of dynamic playlists on the network.
Parameters
[string] filter
string
An expression for filtering search results
.[string] sort string
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 string
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 int
The maximum number of dynamic playlist instances that can be contained in the response body
______________________________________________________________
Response Body
Returns apaged listof 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
______________________________________________________________
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 theDynamic 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
string
An expression for filtering search results
.______________________________________________________________
Response Body
Returns the number of affected dynamic playlists as an integer value.
Endpoints:
GET /Count/
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 string
An expression for filtering search results
______________________________________________________________
Response Body
The number of dynamic playlists is returned as an integer value.
GET /Operations/
Returns the operational permissions granted to roles for specific business operations
Response Body
Returns the Business Operations Entity
GET /{id:int}/
Returns the dynamic playlist instance with the specified id.
Parameters
[int] id: id int
A unique identifier for the dynamic playlist instance
______________________________________________________________
Response Body
Returns the Dynamic Playlists Entity
PUT /{id:int}/
Modifies the specified dynamic playlist instance.
Parameters
[int] id: id int
A unique identifier for the dynamic playlist instance
______________________________________________________________
Request Body
______________________________________________________________
Response Body
On success this method returns a status code 2XX, on failure it returns a status code of 5XX.
DELETE /{id:int}/
Removes the specified dynamic playlist from the network.
Parameters
[int] 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.
GET /{name}/
Returns the dynamic playlist instance with the specified name.
Parameters
[string] name: name string
The name of the dynamic playlist instance
______________________________________________________________
Response Body
Returns the Dynamic Playlists Entity
PUT /{name}/
Modifies the specified dynamic playlist instance.
Parameters
[string] name: name string
The name of the dynamic playlist instance
______________________________________________________________
Request Body
______________________________________________________________
Response Body
On success this method returns a status code 2XX, on failure it returns a status code of 5XX.
DELETE /{name}/
Removes the specified dynamic playlist from the network.
Parameters
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.
GET /{id:int}/Permissions/
Includes object permissions for a given dynamic playlist instance.
Parameters
[int] id int
A unique identifier for the dynamic playlist instance
______________________________________________________________
Response Body
Returns the Permission Entity
POST /{id:int}/Permissions/
Adds permissions to the specified dynamic playlist instance.
Parameters
[int] id int
A unique identifier for the dynamic playlist instance
______________________________________________________________
Request Body
______________________________________________________________
Response Body
On success this method returns a status code 2XX, on failure it returns a status code of 5XX.
DELETE /{id:int}/Permissions/
Removes permissions for the specified dynamic playlist.
Parameters
[int] id int
A unique identifier for the dynamic playlist instance
______________________________________________________________
Request Body
______________________________________________________________
Response Body
On success this method returns a status code 2XX, on failure it returns a status code of 5XX.
GET /{name}/Permissions/
Includes object permissions for a given dynamic playlist instance.
Parameters
[string] namename string
The name of the dynamic playlist instance
______________________________________________________________
Response Body
Returns the Permission Entity
POST /{name}/Permissions/
Adds permissions to the specified dynamic playlist instance.
Parameters
name string
The name of the dynamic playlist instance
______________________________________________________________
Request Body
______________________________________________________________
Response Body
On success this method returns a status code 2XX, on failure it returns a status code of 5XX.
DELETE /{name}/Permissions/
Removes permissions for the specified dynamic playlist.
Parameters
name
string
The name of the dynamic playlist instance
______________________________________________________________
Request Body
______________________________________________________________
Response Body
On success this method returns a status code 2XX, on failure it returns a status code of 5XX.
Endpoints:
| Table of Contents | ||||||
|---|---|---|---|---|---|---|
|