BrightSignNetwork (BSN) Main A...
Main REST HTTP API version 201...

Presentations Endpoints (2017/01)

12min
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 docid 3l0afyd3xooe ytvfk2vs 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 entity (2017/01) docid\ yn3gu asyfisjdxgbjdvb of presentation entity (2017/01) docid\ gevbxp tvfwqaja3tcl9s 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 (2017/01) docid\ gevbxp tvfwqaja3tcl9s 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 (2017/01) docid\ gevbxp tvfwqaja3tcl9s delete / removes presentations, specified by a filter, from a network this allows multiple presentations to be deleted at once parameters filter string an expression docid 3l0afyd3xooe ytvfk2vs for filtering search results response body returns the number of affected presentations as an integer value 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 docid 3l0afyd3xooe ytvfk2vs 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 docid\ ychro4ocgshfhae1gvygf 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 (2017/01) docid\ gevbxp tvfwqaja3tcl9s put /{id\ int}/ modifies the specified presentation instance parameters id int a unique identifier for the presentation instance request body the presentation entity (2017/01) docid\ gevbxp tvfwqaja3tcl9s 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 (2017/01) docid\ gevbxp tvfwqaja3tcl9s put /{name}/ modifies the specified presentation instance parameters name string the name of the presentation instance request body the presentation entity (2017/01) docid\ gevbxp tvfwqaja3tcl9s 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 (2017/01) docid\ horbsqti93 eafzzftgmy 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 (2017/01) docid\ horbsqti93 eafzzftgmy 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 (2017/01) docid\ horbsqti93 eafzzftgmy 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 (2017/01) docid\ horbsqti93 eafzzftgmy post /{name}/permissions/ adds permissions for the specified presentation instance parameters name string the name of the presentation instance request body the permission entity (2017/01) docid\ horbsqti93 eafzzftgmy 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 (2017/01) docid\ horbsqti93 eafzzftgmy response body on success this method returns a status code 2xx, on failure it returns a status code of 5xx