Feeds/Text Endpoints (2020/10)
Use these endpoints to manage live text feeds on the network.
Base URL for these endpoints: https://api.bsn.cloud/2020/10/REST/Feeds/Text
_________________________________________________________________________
GET /
Returns a list of live text feeds on a network
Required Scope Token
bsn.api.main.feeds.text.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"). 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 text feed instances exceeds the pageSize.
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 text feed instances that can be contained in the response body. This defaults to the maximum allowed page size (100).
______________________________________________________________
Response
Success Response Body
200: Returns a paged list of Live Text Feed 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
POST /
Creates a live text feed on a network
Required Scope Token
bsn.api.main.feeds.text.create
______________________________________________________________
Request Body
______________________________________________________________
Response
Success Response Body
201: Returns the Live Text Feed Entity created and referenced by the Uri (given by the Location header field) in the response.
Failure
300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)
400: Either 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
406: The server cannot return the data representation that you requested (as specified in the "Accept" header)
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
Endpoints:
- 1 GET /
- 2 POST /
- 3 DELETE /
- 4 GET /Count/
- 5 GET /{id:int}/
- 6 PUT /{id:int}/
- 7 DELETE /{id:int}/
- 8 GET /{name}/
- 9 PUT /{name}/
- 10 DELETE /{name}/
- 11 GET /Operations/
- 12 GET /{id:int}/Permissions/
- 13 POST /{id:int}/Permissions/
- 14 DELETE /{id:int}/Permissions/
- 15 GET /{name}/Permissions/
- 16 POST /{name}/Permissions/
- 17 DELETE /{name}/Permissions/
DELETE /
Removes live text feed instances, specified by a filter, from a network. This allows multiple live text feed instances to be deleted at once.
Required Scope Token
bsn.api.main.feeds.text.delete
______________________________________________________________
Query String Parameters
filter string required
An expression for filtering search results
______________________________________________________________
Response
Success Response Body
200: Returns the number of affected live text feed instances 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
GET /Count/
Returns the number of live text feeds on the network that match the specified filter criteria. If no filter is included, this call returns the total number of live text feeds on the network.
Required Scope Token
bsn.api.main.feeds.text.retrieve
______________________________________________________________
Query String Parameters
filter string
An expression for filtering search results
______________________________________________________________
Response
Success Response Body
200: The number of live text feeds 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
GET /{id:int}/
Returns the specified live text feeds instance
Required Scope Token
bsn.api.main.feeds.text.retrieve
______________________________________________________________
Segment
id int
A unique identifier for the live text feed instance
______________________________________________________________
Response
Success Response with Body
200: Returns the Live Text Feed 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
PUT /{id:int}/
Modifies the specified live text feed instance
Required Scope Token
bsn.api.main.feeds.text.update
______________________________________________________________
Segment
id int
A unique identifier for the live text feed instance
______________________________________________________________
Request Body
______________________________________________________________
Response
Success
204: The specified live text feed instance has been updated
Failure
300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)
400: Either 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)
412: Precondition failed (the resource/live text feed instance changed since the time specified in the “If-Unmodified-Since” header value)
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}/
Removes the specified live text feed instance
Required Scope Token
bsn.api.main.feeds.text.delete
______________________________________________________________
Segment
id int
A unique identifier for the live text feed instance
______________________________________________________________
Response
Success
204: The specified live text feed has been 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 live text feeds instance
Required Scope Token
bsn.api.main.feeds.text.retrieve
______________________________________________________________
Segment
name string
The name of the live text feed instance
______________________________________________________________
Response
Success Response with Body
200: Returns the Live Text Feed 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
PUT /{name}/
Modifies the specified live text feed instance
Required Scope Token
bsn.api.main.feeds.text.update
______________________________________________________________
Segment
name string
The name of the live text feed instance
______________________________________________________________
Request Body
______________________________________________________________
Response
Success
204: The specified live text feed instance has been updated
Failure
300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)
400: Either 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)
412: Precondition failed (the resource/live text feed instance changed since the time specified in the “If-Unmodified-Since” header value)
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}/
Removes the specified live text feed instance
Required Scope Token
bsn.api.main.feeds.text.delete
______________________________________________________________
Segment
name string
The name of the live text feed instance
______________________________________________________________
Response
Success
204: The specified live text feed has been 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 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
GET /{id:int}/Permissions/
Returns object permissions for a given live text feed instance.
Required Scope Token
bsn.api.main.feeds.text.retrieve
______________________________________________________________
Segment
id int
A unique identifier for the live text feed instance
______________________________________________________________
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
POST /{id:int}/Permissions/
Adds permissions to the specified live text feeds instance(s)
Required Scope Token
bsn.api.main.feeds.text.update
______________________________________________________________
Segment
id int
A unique identifier for the live text feed instance
______________________________________________________________
Request Body
An array of Permission entities
______________________________________________________________
Response
Success
204: The specified permissions were successfully granted
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/
Removes permissions from the specified live text feed instance
Required Scope Token
bsn.api.main.feeds.text.update
______________________________________________________________
Segment
id int
A unique identifier for the live text feed instance
______________________________________________________________
Request Body
An array of Permission entities
______________________________________________________________
Response Body
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/
Returns object permissions for a given live text feed instance
Required Scope Token
bsn.api.main.feeds.text.retrieve
______________________________________________________________
Segment
name string
The name of the live text feed instance
______________________________________________________________
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
POST /{name}/Permissions/
Adds permissions to the specified live text feed(s)
Required Scope Token
bsn.api.main.feeds.text.update
______________________________________________________________
Segment
name string
The name of the live text feed
______________________________________________________________
Request Body
An array of Permission entities
______________________________________________________________
Response
Success
204: The specified permissions were successfully granted
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 specified representation of the permissions entity is invalid or not supported (as specified in the "Content-Type" header)
5XX: Any 500 code is an internal server error
DELETE /{name}/Permissions/
Removes permissions from the specified live text feed
Required Scope Token
bsn.api.main.feeds.text.update
______________________________________________________________
Segment
name string
The name of the live text feed
______________________________________________________________
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