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

Webpages Endpoints (2017/01)

9min
these endpoints allow users to manage webpages (that is, an html file and associated asset files) on a network base url for these endpoints https //api brightsignnetwork com/2017/01/rest/webpages get / returns a list of webpages on a network parameters filter string an filter expressions in the main api (2017/01) docid\ l8mfvfdghpy9xgiuquwcm 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 webpage instances exceeds the pagesize pagesize int the maximum number of webpage instances that can be contained in the response body response body returns a paged list entity (2017/01) docid\ yn3gu asyfisjdxgbjdvb of webpage entity (2017/01) docid\ mpuxwuqole8junawly dv instances on a network this will return not more than 100 entities along with the information necessary to return any other remaining pages delete / deletes webpages, specified by a filter, on a network this allows multiple webpages to be deleted at once parameter filter string an filter expressions in the main api (2017/01) docid\ l8mfvfdghpy9xgiuquwcm for filtering search results response body returns the number of affected webpages, as an integer value get /count/ returns the number of webpages on a network parameter filter string an filter expressions in the main api (2017/01) docid\ l8mfvfdghpy9xgiuquwcm for filtering search results response body the webpage count is returned as an integer value get /{id\ int}/ returns the specified webpage(s) on a network parameter id int a unique identifier for the webpage response body returns the webpage entity (2017/01) docid\ mpuxwuqole8junawly dv delete /{id\ int}/ deletes the specified webpage(s) from a network parameter id int a unique identifier for the webpage response body on success this method returns a status code 2xx, on failure it returns a status code of 5xx get /{name}/ returns the specified webpage(s) on a network parameter name string a unique identifier for the webpage response body returns the webpage entity (2017/01) docid\ mpuxwuqole8junawly dv delete /{name}/ deletes the specified webpage(s) from a network parameter name string a unique identifier for the webpage response body on success this method returns a status code 2xx, on failure it returns a status code of 5xx get /operations/ returns the operational permissions granted to roles for specific business operations response body returns the business operations entity (2017/01) docid\ fwdujpp aohpf3res sz get /{id\ int}/permissions/ includes object permissions for a given webpage instance parameter id int a unique identifier for the webpage response body returns the permission entity (2017/01) docid\ horbsqti93 eafzzftgmy post /{id\ int}/permissions/ adds permissions for a webpage on a network parameter id int a unique identifier for the webpage 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 from a webpage on a network parameter id int a unique identifier for the webpage 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 webpage instance parameter name string a unique identifier for the webpage response body returns the permission entity (2017/01) docid\ horbsqti93 eafzzftgmy post /{name}/permissions/ adds permissions for a webpage on a network parameter name string a unique identifier for the webpage 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 from a webpage on a network parameter name string a unique identifier for the webpage 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