Versions Compared

Old Version 29

changes.mady.by.user BrightSign TechDocs

Saved on

compared with

New Version 30

changes.mady.by.user BrightSign TechDocs

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Added endpoint information

These endpoints allow users to manage device subscriptions on a network. 

Base URL for this endpoint:  https://api.bsn.cloud/2020/10/REST/

/Subscriptions/

GET

Returns a list of device subscriptions

Parameters

  • [string] marker: 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 instances exceeds the pageSize.
  • [int] pageSize: The maximum number of device subscription instances that can be contained in the response body

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.


Panel
borderColor#3D3D3D
bgColor#F4F4F4
titleColor#3D3D3D
borderWidth0
titleBGColor#3D3D3D
borderStylesolid

ON THIS PAGE

Table of Contents
maxLevel3
indent20px



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

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

Response Body

The subscription instance count is returned as an integer value.

/Subscriptions/Operations/

GET

Returns operational permissions granted to roles for specific business operations

Response Body

Returns the Business Operations Entity