Versions Compared

Old Version 52

changes.mady.by.user BrightSign TechDocs

Saved on

compared with

New Version Current

changes.mady.by.user BrightSign TechDocs

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

These endpoints allow users to manage webpages (that is, an HTML file and associated asset files) on  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

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

    Required Scope Token

    bsn.api.main.webpages.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")

    [string] marker: A

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

    [int] pageSize: The

    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

    Returns

    200: Returns apaged listof 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

    Endpoints:

    Table of Contents
    maxLevel2
    indent20px
    excludeEndpoints:



    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.

    Parameters

    [string] filter:  An expression for

    delete

    ______________________________________________________________

    Query String Parameter

    filter string  required

    An expression for filtering search results. 

    ______________________________________________________________

    Response

    Success Response Body

    Returns

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

    .Count/GET

    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 webpages on a network

    Parameters

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

    Response Body

    The

    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

    Endpoints:

    Table of Contents
    maxLevel2
    indent20px
    excludeEndpoints:

    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}/

    GET

     

    Returns the specified webpage

    (s) on a network

    Parameters

    [int] id: 

    Required Scope Token

    bsn.api.main.webpages.retrieve

    ______________________________________________________________

    Segment

    id int

    A unique identifier for the webpage

    ______________________________________________________________

    Response

    Success Response with Body

    Returns

    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

    DELETE /{id:int}/

    DELETE

     

    Deletes the specified webpage

    (s) from a network

    Parameters

    [int] id: 

    Required Scope Token

    bsn.api.main.webpages.delete

    ______________________________________________________________

    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

    Parameters

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

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

    ______________________________________________________________

    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

    GET /{name}/ 

    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)

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

    GET /Operations/ 

    Returns the operational permissions granted to roles for specific business operations

    Required Scope Token

    bsn.api.main.operations.retrieve

    ______________________________________________________________

    Response

    Success Response Body

    Returns

    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/

    GET

     

    Includes

    Returns object permissions for a given webpage instance.

    Required Scope Token

    bsn.api.main.webpages.

    Parameters

    [int] id: 

    retrieve

    ______________________________________________________________

    Segment

    id int 

    A unique identifier for the webpage

    ______________________________________________________________

    Response

    Success Response Body

    Returns the Permission Entity

    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/

    POST

     

    Adds permissions for a webpage on a network

    Parameters

    [int] id: 

    Required Scope Token

    bsn.api.main.webpages.update

    ______________________________________________________________

    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.

    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

    DELETE /{id:int}/Permissions/

    DELETE[int] id: 

     

    Removes permissions from a webpage on a network

    Parameters

    Required Scope Token

    bsn.api.main.webpages.delete

    ______________________________________________________________

    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.

    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

    GET /{name}/Permissions/

    GET

     

    Includes

    Returns object permissions for a given webpage instance.

    Required Scope Token

    bsn.

    Parameters

    [string] name: 

    api.main.webpages.retrieve

    ______________________________________________________________

    Segment

    name string 

    A unique identifier for the webpage

    ______________________________________________________________

    Response

    Success Response Body

    Returns the Permission Entity

    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/

    POST[string] name: 

     

    Adds permissions for a webpage on a network

    Parameters

    Required Scope Token

    bsn.api.main.webpages.update

    ______________________________________________________________

    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.

    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

    DELETE/{name}/Permissions/

    DELETE

     

    Removes permissions from a webpage on a network

    Parameters

    [string] name: 

    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

     Permission Entity

    Response Body

    On success this method returns a status code 2XX, on failure it returns a status code of 5XX.

    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