Versions Compared

Old Version 9

changes.mady.by.user BrightSign TechDocs

Saved on

compared with

New Version 10

changes.mady.by.user BrightSign TechDocs

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: updated format

Use these endpoints to manage live media feeds on the network. 

Base URL for these endpoints:  https://api.brightsignnetwork.com/2017/01/REST/Feeds/Media

GET  /

Returns a list of live media feeds on a network

Parameters

[

filter string

]

 

filter:  An

An expression for filtering search results

.

[string] sort: An


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: A


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 media feed instances exceeds the pageSize.


[int] pageSize

: The

The maximum number of media feed instances that can be contained in the response body

______________________________________________________________

Response Body

Returns a paged list of Live Media Feed 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  /

Creates a live media feed on a network

Request Body

The live media feed entity. See Live Media Feed 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 Live Media Feed Entity.

DELETE  /

Removes live media feed instances, specified by a filter, from a network. This allows multiple live media feed instances to be deleted at once.

Parameters

[string] filter:  An 

filter string

An expression for filtering search results

.

______________________________________________________________

Response Body

Returns the number of affected live media feeds as an integer value.

Endpoints:

Table of Contents
maxLevel2
indent20px
excludeEndpoints:



GET  /Count/ 

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

Parameters

[string] filter:  An

filter string

An expression for filtering search results

.

______________________________________________________________

Response Body

The number of live media feeds is returned as an integer value.

GET  /{id:int}/ 

Returns the live media feeds instance with the specified id.

Parameters

[int] id:  A

id int

A unique identifier for the live media feed instance

______________________________________________________________

Response Body

Returns the Live Media Feed Entity

PUT  /{id:int}/ 

Modifies the specified live media feed instance.

Parameters

[int] id:  A

id int

A unique identifier for the live media feed instance

______________________________________________________________

Request Body

The Live Media Feed Entity

______________________________________________________________

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 live media feed instance from the network. 

Parameters

[int] id:  A

id int

A unique identifier for the live media feed instance

______________________________________________________________

Response Body

On success this method returns a status code 2XX, or code 404 if the Live Media Feed instance could not be found.

GET  /{name}/ 

Returns the live media feeds instance for the specified name.

Parameters

[string] name:  A

name string

A unique identifier for the plugin instance

______________________________________________________________

Response Body

Returns the Live Media Feed Entity

PUT  /{name}/ 

Modifies the specified live media feed instance.

Parameters

[

name string

]

The name

:  The name

of the live media feed instance

______________________________________________________________

Request Body

The Live Media Feed Entity

______________________________________________________________

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 live media feed instance from the network. 

Parameters

[

name string

]

The name

:  The name

of the live media feed instance

______________________________________________________________

Response Body

On success this method returns a status code 2XX, or code 404 if the Live Media Feed instance could not be found.

GET  /Operations/ 

Returns operational permissions granted to roles for specific business operations

Response Body

Returns the Business Operations Entity

GET  /{id:int}/Permissions/ 

Includes object permissions for a given live media feed instance.

Parameters

[int] id:  A

id int

A unique identifier for the live media feed instance

______________________________________________________________

Response Body

Returns the Permission Entity

POST  /{id:int}/Permissions/ 

Adds permissions to live media feeds instance(s) with the specified id.

Parameters

[int] id:  A

id int

A unique identifier for the live media feed 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.

DELETE  /{id:int}/Permissions/ 

Removes permissions from the specified live media feed instance. 

Parameters

[int] id:  A

id int

A unique identifier for the live media feed 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.

GET  /{name}/Permissions/ 

Includes object permissions for a given live media feed instance.

Parameters

[

name string

]

The name

:  The name

of the live media feed instance

______________________________________________________________

Response Body

Returns the Permission Entity

POST  /{name}/Permissions/ 

Adds permissions to live media feeds instance(s) with the specified name.

Parameters

[

name string

]

The name

:  The name

of the live media feed 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.

DELETE  /{name}/Permissions/ 

Removes permissions from the specified live media feed instance. 

Parameters

[

name string

]

The name

:  The name

of the live media feed 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.