Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 42 Next »

These endpoints allow for creation, modification, and retrieval of presentation objects.

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

GET  /

Retrieves a list of presentations on the network.

Parameters

filter  string

An expression for filtering search results


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")


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 presentations exceeds the pageSize.


pageSize int

The maximum number of presentations that can be contained in the response body

______________________________________________________________

Response Body

Returns a paged list of Presentation 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 new presentation on the network.

Request Body

The Presentation 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 Presentation Entity .

DELETE  /

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

Parameters

filter  string

An expression for filtering search results

______________________________________________________________

Response Body

Returns the number of affected presentations as an integer value.

Endpoints:


GET  /Count/ 

Retrieves the number of presentations on the network matching the specified filter criteria. If no filter is included, this call returns the total number of presentations on the network. 

Parameters

filter  string

An expression for filtering search results

______________________________________________________________

Response Body

The presentation count 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 presentation instance with the specified id.

Parameters

id int

A unique identifier for the presentation instance

______________________________________________________________

Response Body

Returns the Presentation Entity 

PUT  /{id:int}/ 

Modifies the specified presentation instance. 

Parameters

id int

A unique identifier for the presentation instance

______________________________________________________________

Request Body

The Presentation 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 presentation from the network.

Parameters

id int

A unique identifier for the presentation instance

______________________________________________________________

Response Body

On success this method returns a status code 2XX, on failure it returns code 400 with an error message.

GET  /{name}/ 

Returns the presentation instance with the specified name.

Parameters

name string

The name of the presentation instance

______________________________________________________________

Response Body

Returns the Presentation Entity 

PUT /{name}/ 

Modifies the specified presentation instance. 

Parameters

name string

The name of the presentation instance

______________________________________________________________

Request Body

The Presentation 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 presentation from the network.

Parameters

name string

The name of the presentation instance

______________________________________________________________

Response Body

On success this method returns a status code 2XX, on failure it returns code 400 with an error message.

GET /{id:int}/Permissions/ 

Includes object permissions for a given presentation instance.

Parameters

id int

A unique identifier for the presentation instance

______________________________________________________________

Response Body

Returns the Permission Entity

POST  /{id:int}/Permissions/ 

Adds permissions for the specified presentation instance.

Parameters

id int

A unique identifier for the presentation 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 for the specified presentation instance.

Parameters

id int

A unique identifier for the presentation 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 presentation instance.

Parameters

name string

The name of the presentation instance

______________________________________________________________

Response Body

Returns the Permission Entity

POST  /{name}/Permissions/ 

Adds permissions for the specified presentation instance.

Parameters

name string

The name of the presentation 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 for the specified presentation instance.

Parameters

name string

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





  • No labels