DeviceWebPages Endpoints (2020/10)
- BrightSign TechDocs
These endpoints allow users to manage device webpages on the network.
Base URL for these endpoints: https://api.bsn.cloud/2020/10/REST/DeviceWebPages
_________________________________________________________________________
GET /
Returns a list of device webpages
Required Scope Token
bsn.api.main.devicewebpages.retrieve
______________________________________________________________
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 device 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 device 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 device 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 /
Removes device webpages, specified by a filter, from a network. This allows multiple device webpages to be deleted at once.
Required Scope Token
bsn.api.main.devicewebpages.delete
______________________________________________________________
Query String Parameter
filter string required
An expression for filtering search results.
______________________________________________________________
Response
Success Response Body
200: Returns the number of affected device webpages as an integer value.
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
GET /Count/
Returns the number of device webpages on a device
Required Scope Token
bsn.api.main.devicewebpages.retrieve
______________________________________________________________
Query String Parameter
filter string optional
An expression for filtering search results.
______________________________________________________________
Response
Success Response Body
200: The device webpages count is returned as an integer value.
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
GET /{id:int}/
Returns the specified device webpage
Required Scope Token
bsn.api.main.devicewebpages.retrieve
______________________________________________________________
Segment
id int
A unique identifier for the device webpage
______________________________________________________________
Response
Success Response with Body
200: Returns the device WebPage Entity
Success Response
304: The resource was not modified since the time specified in the “If-Modified-Since” header
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
404: The server cannot find the requested resource (the path does not exist)
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 /{id:int}/
Deletes the specified device webpage
Required Scope Token
bsn.api.main.devicewebpages.delete
______________________________________________________________
Segment
id int
A unique identifier for the device webpage
______________________________________________________________
Response
Success
204: The specified device webpage(s) were deleted
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
404: The server cannot find the requested resource (the path does not exist)
406: The server cannot return the data representation that you requested (as specified in the "Accept" header)
412: Precondition failed (the resource changed since the time specified in the “If-Unmodified-Since” header value)
5XX: Any 500 code is an internal server error
GET /{name}/
Returns the specified device webpage
Required Scope Token
bsn.api.main.devicewebpages.retrieve
______________________________________________________________
Segment
name string
The name of the device webpage
______________________________________________________________
Response
Success Response Body
200: Returns the device WebPage Entity
Success Response
304: The resource was not modified since the time specified in the “If-Modified-Since” header
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
404: The server cannot find the requested resource (the path does not exist)
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 /{name}/
Deletes the specified device webpage
Required Scope Token
bsn.api.main.devicewebpages.delete
______________________________________________________________
Segment
name string
The name of the device webpage to delete
______________________________________________________________
Response
Success
204: The specified device webpage(s) were deleted
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
404: The server cannot find the requested resource (the path does not exist)
406: The server cannot return the data representation that you requested (as specified in the "Accept" header)
412: Precondition failed (the resource changed since the time specified in the “If-Unmodified-Since” header value)
5XX: Any 500 code is an internal server error
GET /Operations/
Returns operational permissions granted to roles for specific business operations
Required Scope Token
bsn.api.main.operations.retrieve
______________________________________________________________
Response
Success Response Body
200: Returns the Business Operations Entity
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
GET /{id:int}/Permissions/
Returns object permissions for a given device webpage instance.
Required Scope Token
bsn.api.main.devicewebpages.retrieve
______________________________________________________________
Segment
id int
A unique identifier for the device webpage
______________________________________________________________
Response
Success Response Body
200: Returns an array of Permission entities
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
404: The server cannot find the requested resource (the path does not exist)
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
POST /{id:int}/Permissions/
Adds permissions to a device webpage
Required Scope Token
bsn.api.main.devicewebpages.update
______________________________________________________________
Segment
id int
A unique identifier for the device webpage
______________________________________________________________
Request Body
An array of Permission entities
______________________________________________________________
Response
Success Response Body
204: The specified permissions were successfully granted
Failure
400: The request or request body 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
404: The server cannot find the requested resource (the path does not exist)
415: The server cannot accept the data representation that you sent (as specified in the "Content-Type" header)
5XX: Any 500 code is an internal server error
DELETE /{id:int}/Permissions/
Removes permissions from a device webpage
Required Scope Token
bsn.api.main.devicewebpages.update
______________________________________________________________
Segment
id int
A unique identifier for the device webpage
______________________________________________________________
Request Body
An array of Permission entities
______________________________________________________________
Response
Success
204: The specified permissions were successfully deleted from the device webpage
Failure
300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)
400: The request or request body 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
404: The server cannot find the requested resource (the path does not exist)
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
GET /{name}/Permissions/
Returns object permissions for a given device webpage instance.
Required Scope Token
bsn.api.main.devicewebpages.retrieve
______________________________________________________________
Segment
name string
The name of the device webpage
______________________________________________________________
Response
Success Response Body
200: Returns an array of Permission entities
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
404: The server cannot find the requested resource (the path does not exist)
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
POST /{name}/Permissions/
Adds permissions to a device webpage
Required Scope Token
bsn.api.main.devicewebpages.update
______________________________________________________________
Segment
name string
The name of the device webpage
______________________________________________________________
Request Body
An array of Permission entities
______________________________________________________________
Response
Success Response Body
204: The specified permissions were successfully granted
Failure
400: The request or request body 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
404: The server cannot find the requested resource (the path does not exist)
415: The server cannot accept the data representation that you sent (as specified in the "Content-Type" header)
5XX: Any 500 code is an internal server error
DELETE /{name}/Permissions/
Removes permissions from a device webpage
Required Scope Token
bsn.api.main.devicewebpages.update
______________________________________________________________
Segment
name string
The name of the device webpage
______________________________________________________________
Request Body
An array of Permission entities
______________________________________________________________
Response
Success
204: The specified permissions were successfully deleted from the device webpage
Failure
300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)
400: The request or request body 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
404: The server cannot find the requested resource (the path does not exist)
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