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/
DELETE
Deletes webpages, specified by a filter, on a network. This allows multiple webpages to be deleted at once.DELETE
Deletes webpages, specified by a filter, on a network. This allows multiple webpages to be deleted at once.
Required Scope Token
bsn.api.main.webpages.delete
______________________________________________________________
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
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
Count/GET
Returns the number of webpages on a network
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
Required Scope Token
bsn.api.main.webpages.retrieve
______________________________________________________________
Query String Parameter
filter string optional
An expression for filtering search results.
______________________________________________________________
Response
Success Response Body
200: The webpage 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
{id:int}/GET
Returns the specified webpagespecified in the "Accept" header)
5XX: Any 500 code is an internal server error
{id:int}/GET
Returns the specified webpage
Required Scope Token
bsn.api.main.webpages.retrieve
______________________________________________________________
Segment
id int
A unique identifier for the webpage
______________________________________________________________
Response
Success Response with Body
200: Returns the 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
{id:int}/DELETE
Deletes the specified webpageserver cannot return the data representation that you requested (as specified in the "Accept" header)
5XX: Any 500 code is an internal server error
{id:int}/DELETE
Deletes the specified webpage
Required Scope Token
bsn.api.main.webpages.delete
______________________________________________________________
Segment
id int
A unique identifier for the webpage
______________________________________________________________
Response
Success
204: The specified webpage was 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
{name}/GET
Returns the specified webpagethe resource changed since the time specified in the “If-Unmodified-Since” header value)
5XX: Any 500 code is an internal server error
{name}/GET
Returns the specified webpage
Required Scope Token
bsn.api.main.webpages.retrieve
______________________________________________________________
Segment
name string
A unique identifier for the webpage
______________________________________________________________
Response
Success Response with Body
200: Returns the 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)
Deletes the specified webpage406: 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
{name}/DELETE
server cannot return the data representation that you requested (as specified in the "Accept" header)
5XX: Any 500 code is an internal server error
{name}/DELETE
Deletes the specified webpage
Required Scope Token
bsn.api.main.webpages.delete
______________________________________________________________
Segment
name string
A unique identifier for the webpage
______________________________________________________________
Response
Success
204: The specified webpage was 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
Operations/GET
Returns the operational permissions granted to roles for specific business operations
failed (the resource changed since the time specified in the “If-Unmodified-Since” header value)
5XX: Any 500 code is an internal server error
Operations/GET
Returns the 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
{id:int}/Permissions/GET
Returns object permissions for a given webpage instance.int}/Permissions/GET
Returns object permissions for a given webpage instance.
Required Scope Token
bsn.api.main.webpages.retrieve
______________________________________________________________
Segment
id int
A unique identifier for the 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
{id:int}/Permissions/POST
Adds permissions for a webpage on a networkthe 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
{id:int}/Permissions/POST
Adds permissions for a webpage on a network
Required Scope Token
bsn.api.main.webpages.update
______________________________________________________________
Segment
id int
A unique identifier for the webpage
______________________________________________________________
Request Body
An array of Permission entities
______________________________________________________________
Response
Success
204: The permissions were successfully added to the specified webpage
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
{id:int}/Permissions/DELETE
Removes permissions from a webpage on a network
"Content-Type" header)
5XX: Any 500 code is an internal server error
{id:int}/Permissions/DELETE
Removes permissions from a webpage on a network
Required Scope Token
bsn.api.main.webpages.delete
______________________________________________________________
Segment
id int
A unique identifier for the webpage
______________________________________________________________
Request Body
An array of Permission entities
______________________________________________________________
Response
Success
204: The specified permissions were successfully deleted
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
{name}/Permissions/GET
Returns object permissions for a given webpage instance.an internal server error
{name}/Permissions/GET
Returns object permissions for a given webpage instance.
Required Scope Token
bsn.api.main.webpages.retrieve
______________________________________________________________
Segment
name string
A unique identifier for the 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
{name}/Permissions/POST
Adds permissions for a webpage on a network
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
{name}/Permissions/POST
Adds permissions for a webpage on a network
Required Scope Token
bsn.api.main.webpages.update
______________________________________________________________
Segment
name string
A unique identifier for the webpage
______________________________________________________________
Request Body
An array of Permission entities
______________________________________________________________
Response
Success
204: The permissions were successfully added to the specified webpage
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
{name}/Permissions/DELETE
Removes permissions from a webpage on a networkPermissions/DELETE
Removes permissions from a webpage on a network
Required Scope Token
bsn.api.main.webpages.update
______________________________________________________________
Segment
name string
A unique identifier for the webpage
______________________________________________________________
Request Body
An array of Permission entities
______________________________________________________________
Response
Success
204: The specified permissions were successfully deleted
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