Versions Compared

Old Version 2

changes.mady.by.user BrightSign TechDocs

Saved on

compared with

New Version 3

changes.mady.by.user BrightSign TechDocs

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: updated information
Panel
borderColor#3D3D3D
bgColor#F4F4F4
titleColor#3D3D3D
borderWidth0
titleBGColor#3D3D3D
borderStylesolid

ON THIS PAGE

Table of Contents
maxLevel3
indent20px

/webPages/

GET

...

Parameters

  • pageIndex:
  • marker:
  • pageSize:
  • filter:  
  • sort:

Request Body

 

Response Body

 

DELETE

...

Parameters

  •  filter: 

Request Body

 

Response Body

 

/webPages/count/

GET

...

Parameters

  • filter:  

Request Body

 

Response Body

 

/webPages/operations/

GET

...

Parameters

 

Request Body

 

Response Body

 

/webPages/{page_id}/

GET

...

Parameters

 

Request Body

 

Response Body

 

DELETE

...

Parameters

 

Request Body

 

Response Body

 

/webPages/{page_name}/

GET

...

Parameters

 

Request Body

 

Response Body

 

DELETE

...

Parameters

 

Request Body

 

Response Body

 

/webPages/{page_id}/permissions/

GET

...

Parameters

 

Request Body

 

Response Body

 

POST

...

Parameters

 

Request Body

 

Response Body

 

DELETE

...

Parameters

 

Request Body

 

Response Body

 

/webPages/{page_name}/permissions/

GET

...

Parameters

 

Request Body

 

Response Body

 

POST

...

Parameters

 

Request Body

 

Response Body

 

DELETE

...

Parameters

 

Request Body

 

Response Body

...

These endpoints allow users to manage webpages (that is, an HTML file and associated asset files) on a network. 

/WebPages/

GET

Returns a list of webpages on a 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 webpage instances exceeds the pageSize.
  • [int] pageSize: 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

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

Response Body

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

/WebPages/Count/

GET

Returns the number of webpages on a network

Parameters

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

Response Body

The webpage count is returned as an integer value.


Panel
borderColor#3D3D3D
bgColor#F4F4F4
titleColor#3D3D3D
borderWidth0
titleBGColor#3D3D3D
borderStylesolid

ON THIS PAGE

Table of Contents
maxLevel3
indent20px



/WebPages/{id:int}/

GET

Returns the specified webpage(s) on a network

Parameters

  • [int] id: A unique identifier for the webpage

Response Body

Returns the WebPage Entity

DELETE

Deletes the specified webpage(s) from a network

Parameters

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

/WebPages/{name}/

GET

Returns the specified webpage(s) on a network

Parameters

  • [string] name: A unique identifier for the webpage

Response Body

Returns the WebPage Entity

DELETE

Deletes the specified webpage(s) from a network

Parameters

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

/WebPages/Operations/

GET

Returns the operational permissions granted to roles for specific business operations

Response Body

Returns the Business Operations Entity

/WebPages/{id:int}/Permissions/

GET

Includes object permissions for a given webpage instance.

Parameters

  • [int] id: A unique identifier for the webpage

Response Body

Returns the Permission Entity

POST

Adds permissions for a webpage on a network

Parameters

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

DELETE

Removes permissions from a webpage on a network

Parameters

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

/WebPages/{name}/Permissions/

GET

Includes object permissions for a given webpage instance.

Parameters

  • [string] name: A unique identifier for the webpage

Response Body

Returns the Permission Entity

POST

Adds permissions for a webpage on a network

Parameters

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

DELETE

Removes permissions from a webpage on a network

Parameters

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