Versions Compared

Old Version 32

changes.mady.by.user BrightSign TechDocs

Saved on

compared with

New Version 33

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 device subscriptions on a network. 

Base URL for these endpoints:  https://api.bsn.cloud/2020/10/REST/Subscriptions/

GET

Returns a list of device subscriptions

Parameters

[: A

marker string

] marker

 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 subscription

autorun plugin instances exceeds the pageSize.

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

[


pageSize: The

pageSize int

] 

 optional

The maximum number of

device subscription

autorun plugin instances that can be contained in the response body. This defaults to the maximum allowed page size (100).

Response Body

Returns a paged list of device subscription entities on a network. This will return not more than 100 entities along with the information necessary to return any other remaining pages.

Endpoints:

Table of Contents
maxLevel2
indent20px
excludeEndpoints:



Count/GET

Retrieves the number of subscription instances on the network matching the specified filter criteria. If no filter is included, this call returns the total number of subscription instances on the network. 

Parameters

[

filter string

]

 

filter:  An

optional 

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


Response Body

The subscription instance count is returned as an integer value.

Operations/GET

Returns operational permissions granted to roles for specific business operations

Response Body

Returns the Business Operations Entity