Versions Compared

Old Version 68

changes.mady.by.user BrightSign TechDocs

Saved on

compared with

New Version 69

changes.mady.by.user BrightSign TechDocs

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: minor fix

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

Base URL for these endpoints:  https://api.bsn.cloud/2020/10/REST/Feeds/Text/

_________________________________________________________________________

GET

Returns a list of live text feeds on a network

Query String Parameters

filter string optional 

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


sort string 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 text feed instances exceeds the pageSize.

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


pageSize int optional 

The maximum number of text feed 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 Live Text 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 text feed on a network

Request Body

The Live Text 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 Text Feed Entity.

DELETE

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

Query String Parameters

filter string required 

An expression for filtering search results

______________________________________________________________

Response Body

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

Endpoints:

Table of Contents
maxLevel2
indent20px
excludeEndpoints:



Count/GET

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

Query String Parameters

filter string 

An expression for filtering search results

______________________________________________________________

Response Body

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

{id:int}/GET

Returns the live text feeds instance with the specified id.

Segment

id int

A unique identifier for the live text feed instance

______________________________________________________________

Response Body

Returns the Live Text Feed Entity

{id:int}/PUT

Modifies the specified live text feed instance.

Segment

id int

A unique identifier for the live text feed instance

______________________________________________________________

Request Body

The Live Text Feed 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 live text feed instance from the network. 

Segment

id int

A unique identifier for the live text feed instance

______________________________________________________________

Response Body

On success this method returns a status code 2XX, code 404 if the live media feed instance could not be found, or code of 5XX on failure.

{name}/GET

Returns the live text feeds instance for the specified name.

Segment

name string 

The name of the live text feed instance

______________________________________________________________

Response Body

Returns the Live Text Feed Entity

{name}/PUT

Modifies the specified live text feed instance.

Segment

name string 

The name of the live text feed instance

______________________________________________________________

Request Body

The Live Text Feed 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 live text feed instance from the network. 

Segment

name string 

The name of the live text feed instance

______________________________________________________________

Response Body

On success this method returns a status code 2XX, code 404 if the live media feed instance could not be found, or code of 5XX on failure.

Operations/GET

Returns operational permissions granted to roles for specific business operations.

Response Body

Returns the Business Operations Entity

{id:int}/Permissions/GET

Returns object permissions for a given live text feed instance.

Segment

id int

A unique identifier for the live text feed instance

______________________________________________________________

Response Body

Success

200: Returns the permissions property value of the Live Text Feed Entity as a paged list of live text feed entities.

{id:int}/Permissions/POST

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

Segment

id int

A unique identifier for the live text feed instance

______________________________________________________________

Request Body

The Permission EntityAn array of Permission entities

______________________________________________________________

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 from the specified live text feed instance. 

Segment

id int

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

{name}/Permissions/GET

Returns object permissions for a given live text feed instance.

Segment

name string 

The name of the live text feed instance

______________________________________________________________

Response Body

Success

200: Returns the permissions property value of the Live Text Feed Entity as a paged list of live text feed entities.


{name}/Permissions/POST

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

Segment

name string 

The name of the live text feed instance

______________________________________________________________

Request Body

The Permission EntityAn array of Permission entities

______________________________________________________________

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 from the specified live text feed instance. 

Segment

name string 

The name of the live text 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.