Versions Compared

Old Version 52

changes.mady.by.user BrightSign TechDocs

Saved on

compared with

New Version 53

changes.mady.by.user BrightSign TechDocs

Saved on

Key

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

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.bsn.cloud/2020/10/REST/WebPages/

_________________________________________________________________________

GET

Returns a list of webpages on a network

Parameters

[

filter string

] filter:  An expression for

An expression for filtering search results.

[string] sort: An

The default value is null.


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

. The default value is null.


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

]

 

pageSize: The

The maximum number of webpage instances that can be contained in the response body. This defaults to the maximum allowed page size (100).

______________________________________________________________

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

[expression for

filter string

] filter:  An 

  

An expression for filtering search results. 

______________________________________________________________

Response Body

Returns the number of affected webpages, as an integer value.

Count/GET

Returns the number of webpages on a network

Parameters

[

filter string

]

 

filter:  An

 

An expression

 for

 for filtering search results. 

______________________________________________________________

Response Body

The webpage count is returned as an integer value.

Endpoints:

Table of Contents
maxLevel2
indent20px
excludeEndpoints:



{id:int}/GET

Returns the specified webpage(s) on a network

Parameters

[int] id: 

id int

A unique identifier for the webpage

______________________________________________________________

Response Body

Returns the WebPage Entity

{id:int}/DELETE

Deletes the specified webpage(s) from a network

Parameters

[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.

{name}/GET

Returns the specified webpage(s) on a network

Parameters

[:

name string

] name

 

A unique identifier for the webpage

______________________________________________________________

Response Body

Returns the WebPage Entity

{name}/DELETE

Deletes the specified webpage(s) from a network

Parameters

[:

name string

] name

 

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.

Operations/GET

Returns the operational permissions granted to roles for specific business operations

Response Body

Returns the Business Operations Entity

{id:int}/Permissions/GET

Includes object permissions for a given webpage instance.

Parameters

[

id int

]

 

id: 

A unique identifier for the webpage

______________________________________________________________

Response Body

Returns the Permission Entity

{id:int}/Permissions/POST

Adds permissions for a webpage on a network

Parameters

[

id int

]

 

id: 

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.

{id:int}/Permissions/DELETE

Removes permissions from a webpage on a network

Parameters

[

id int

]

 

id: 

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.

{name}/Permissions/GET

Includes object permissions for a given webpage instance.

Parameters

[

name string

] name:

 

A unique identifier for the webpage

______________________________________________________________

Response Body

Returns the Permission Entity

{name}/Permissions/POST

Adds permissions for a webpage on a network

Parameters

[

name string

] name:

 

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.

{name}/Permissions/DELETE

Removes permissions from a webpage on a network

Parameters

[

name string

] name:

 

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.