Versions Compared

Old Version 8

changes.mady.by.user BrightSign TechDocs

Saved on

compared with

New Version 9

changes.mady.by.user BrightSign TechDocs

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: updated format

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

] filter:  An 


An expression for filtering search results

.

[string] sort: An


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

[string] marker: A


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.

[int] pageSize: The


pageSize int

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

______________________________________________________________

Response Body

Returns a paged list of WebPage Entity 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.

Parameters

Parameter

[string] filter:  An 

filter  string

An expression 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

Parameters

Parameter

[string] 

filter

:  An

  string

An expression for filtering search results.

______________________________________________________________

Response Body

The webpage count is returned as an integer value.

Endpoints:

Table of Contents
maxLevel2
indent20px
excludeEndpoints:



GET  /{id:int}/ 

Returns the specified webpage(s) on a network

Parameters

Parameter

[int] id: 

id int

A unique identifier for the webpage

______________________________________________________________

Response Body

Returns the WebPage Entity

DELETE  /{id:int}/ 

Deletes the specified webpage(s) from a network

Parameters

Parameter

[int] id: 

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

Parameters

Parameter

[string] name: 

name string

A unique identifier for the webpage

______________________________________________________________

Response Body

Returns the WebPage Entity

DELETE  /{name}/ 

Deletes the specified webpage(s) from a network

Parameters

Parameter

[string] name: 

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

GET  /{id:int}/Permissions/ 

Includes object permissions for a given webpage instance.

Parameters

Parameter

[int] id: 

id int

A unique identifier for the webpage

______________________________________________________________

Response Body

Returns the Permission Entity

POST  /{id:int}/Permissions/ 

Adds permissions for a webpage on a network

Parameters

Parameter

[int] id: 

id int

A unique identifier for the webpage

______________________________________________________________

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 from a webpage on a network

Parameters

Parameter

[int] id: 

id int

A unique identifier for the webpage

______________________________________________________________

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 webpage instance.

Parameters

Parameter

[string] name: 

name string

A unique identifier for the webpage

______________________________________________________________

Response Body

Returns the Permission Entity

POST  /{name}/Permissions/ 

Adds permissions for a webpage on a network

Parameters

Parameter

[string] name: 

name string

A unique identifier for the webpage

______________________________________________________________

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 from a webpage on a network

Parameters

Parameter

[string] name: 

name string

A unique identifier for the webpage

______________________________________________________________

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.