Cloud APIs
...
BSN.Cloud Main APIs
Main API version 2020/10
Device Subscriptions Endpoints (2020/10)
3min
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 required scope token bsn api main subscriptions retrieve query string parameters marker string string optional 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 instances exceeds the pagesize this parameter is only required if you need more elements in the paged list than the pagesize (100) pagesize int int optional optional the maximum number of device subscription instances that can be contained in the response body this defaults to the maximum allowed page size (100) response success response body 200 200 returns a paged list entity (2020/10) docid\ joielmbbiwrnzeqzvpqqa of player subscription entities on a network this will return not more than 100 entities along with the information necessary to return any other remaining pages failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /count/ 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 required scope token bsn api main subscriptions retrieve query string parameter filter string string an filtering and sorting expressions in the main api docid 3l0afyd3xooe ytvfk2vs for filtering search results the default value is null response success response body 200 200 the subscription instance count is returned as an integer value failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 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 200 returns the business operations entity (2020/10) docid\ ychro4ocgshfhae1gvygf failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error