Versions Compared

Old Version 59

changes.mady.by.user BrightSign TechDocs

Saved on

compared with

New Version 60

changes.mady.by.user BrightSign TechDocs

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: updated definitions as per Eugene M

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

Query String Parameters

filter string optional

An expression for filtering search results. The default value is null.


sort string optional

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"). The default value is null.


marker string optional

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.

This parameter is only required if you need more elements in the paged list than the pageSize (100).


pageSize int optional

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

______________________________________________________________

Response

Success Response Body

200: 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.

Failure

300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)

400: The request is malformed and therefore invalid

401: The access token is invalid or not specified

403: The supplied access token, though valid, doesn't provide access to this method 

406: The server cannot return the data representation that you requested (as specified in the "Accept" header)

5XX: Any 500 code is an internal server error

DELETE

Deletes webpages, specified by a filter, on a network. This allows multiple webpages to be deleted at once.

Query String Parameter

filter string  required

An expression for filtering search results. 

______________________________________________________________

Response

Success Response Body

200: Returns the number of affected webpages, as an integer value

Failure

400: The request is malformed and therefore invalid

401: The access token is invalid or not specified

403: The supplied access token, though valid, doesn't provide access to this method 

406: The server cannot return the data representation that you requested (as specified in the "Accept" header)

5XX: Any 500 code is an internal server error

Count/GET

Returns the number of webpages on a network

Query String Parameter

filter string  optional 

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

Segment

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

Segment

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

Segment

name string 

A unique identifier for the webpage

______________________________________________________________

Response Body

Returns the WebPage Entity

{name}/DELETE

Deletes the specified webpage(s) from a network

Segment

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.

Operations/GET

Returns the operational permissions granted to roles for specific business operations

Response Body

Returns the Business Operations Entity

{id:int}/Permissions/GET

Returns object permissions for a given webpage instance.

Segment

id int 

A unique identifier for the webpage

______________________________________________________________

Response Body

Success

200: Returns the permissions property value of the WebPage Entity as a paged list of webpage entities.an array of Permission entities 

{id:int}/Permissions/POST

Adds permissions for a webpage on a network

Segment

id int 

A unique identifier for the webpage

______________________________________________________________

Request Body

An array of Permission entities

______________________________________________________________

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

Segment

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.

{name}/Permissions/GET

Returns object permissions for a given webpage instance.

Segment

name string 

A unique identifier for the webpage

______________________________________________________________

Response Body

Success

200: Returns the permissions property value of the WebPage Entity as a paged list of webpage entities.an array of Permission entities 

{name}/Permissions/POST

Adds permissions for a webpage on a network

Segment

name string 

A unique identifier for the webpage

______________________________________________________________

Request Body

An array of Permission entities

______________________________________________________________

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

Segment

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.