Versions Compared

Old Version 38

changes.mady.by.user BrightSign TechDocs

Saved on

compared with

New Version 39

changes.mady.by.user BrightSign TechDocs

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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  /

GET


Retrieves a list of presentations on the network.

Parameters

  • [string] filter:  An expression for filtering search results.
  • [string] sort: 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 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.
  • [int] pageSize: 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

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

DELETE  /

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

Parameters

  • [string] filter:  An expression for filtering search results.

Response Body

Returns the number of affected presentations as an integer value.

Endpoints:

Table of Contents
maxLevel2
indent20px
excludeEndpoints:



GET  /Count/ 

GET

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

  • [string] filter:  An expression for filtering search results.

Response Body

The presentation count is returned as an integer value.

GET  /Operations/ 

GET

Returns the operational permissions granted to roles for specific business operations

Response Body

Returns the Business Operations Entity

GET  /{id:int}/ 

GET

Returns the presentation instance with the specified id.

Parameters

  • [int] id: A unique identifier for the presentation instance

Response Body

Returns the Presentation Entity 

PUT  /{id:int}/ 

PUT

Modifies the specified presentation instance. 

Parameters

  • [int] id: 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}/ 

DELETE

Removes the specified presentation from the network.

Parameters

  • [int] id: 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}/ 

GET

Returns the presentation instance with the specified name.

Parameters

  • [string] name: The name of the presentation instance

Response Body

Returns the Presentation Entity 

PUT /{name}/ 

PUT

Modifies the specified presentation instance. 

Parameters

  • [string] name: 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}/ 

DELETE

Removes the specified presentation from the network.

Parameters

  • [string] name: 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/ 

GET

Includes object permissions for a given presentation instance.

Parameters

  • [int] id: A unique identifier for the presentation instance

Response Body

Returns the Permission Entity

POST  /{id:int}/Permissions/ 

POST

Adds permissions for the specified presentation instance.

Parameters

  • [int] id: 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/ 

DELETE

Removes permissions for the specified presentation instance.

Parameters

  • [int] id: 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/ 

GET

Includes object permissions for a given presentation instance.

Parameters

  • [string] name: The name of the presentation instance

Response Body

Returns the Permission Entity

POST  /{name}/Permissions/ 

POST

Adds permissions for the specified presentation instance.

Parameters

  • [string] name: 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/ 

DELETE

Removes permissions for the specified presentation instance.

Parameters

  • [string] name: 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.