Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 55 Next »

Use these endpoints to manage live text feeds on the network. For constraints on headers, see REST API#Headers.

/Feeds/Text/

GET

Returns a list of live text feeds on a network

Parameters

  • [string] filter:  An expression for filtering search results.
  • [string] sort: 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 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.
  • [int] pageSize: The maximum number of text feed instances that can be contained in the response body

Response Body

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.

POST

Creates a live text feed on a network

Request Body

The Live Text Feed Entity

Response Body

Returns a 201 status code and the new resource created and referenced by the Uri (given by the Location header field) in the response. The response includes the Live Text Feed Entity.

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.

Parameters

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

Response Body

Returns the number of affected live text feeds as an integer value.

ON THIS PAGE


/Feeds/Text/Count/

GET

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. 

Parameters

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

Response Body

The number of live text feeds is returned as an integer value.

/Feeds/Text/{id:int}/

GET

Returns the live text feeds instance with the specified id.

Parameters

  • [int] id:  A unique identifier for the live text feed instance

Response Body

Returns the Live Text Feed Entity

PUT

Modifies the specified live text feed instance.

Parameters

  • [int] id:  A unique identifier for the live text feed instance

Request Body

The Live Text Feed Entity

Response Body

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

DELETE

Removes the specified live media text instance from the network. 

Parameters

  • [int] id:  A unique identifier for the live text feed instance

Response Body

On success this method returns a status code 2XX, code 404 if the live media feed instance could not be found, or code of 5XX on failure.

/Feeds/Text/{name}/

GET

Returns the live text feeds instance for the specified name.

Parameters

  • [string] name:  A unique identifier for the plugin instance

Response Body

Returns the Live Text Feed Entity

PUT

Modifies the specified live text feed instance.

Parameters

  • [string] name:  The name of the live text feed instance

Request Body

The Live Text Feed Entity

Response Body

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

DELETE

Removes the specified live text feed instance from the network. 

Parameters

  • [string] name:  The name of the live text feed instance

Response Body

On success this method returns a status code 2XX, code 404 if the live media feed instance could not be found, or code of 5XX on failure.

/Feeds/Text/Operations/

GET

Returns operational permissions granted to roles for specific business operations.

Response Body

Returns the Business Operations Entity

/Feeds/Text/{id:int}/Permissions/

GET

Includes object permissions for a given live text feed instance.

Parameters

  • [int] id:  A unique identifier for the live text feed instance

Response Body

Returns the Permission Entity (2020/10)

POST

Adds permissions to live text feeds instance(s) with the specified id.

Parameters

  • [int] id:  A unique identifier for the live text feed instance

Request Body

The Permission Entity (2020/10)

Response Body

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

DELETE

Removes permissions from the specified live text feed instance. 

Parameters

  • [int] id:  A unique identifier for the live text feed instance

Request Body

The Permission Entity (2020/10)

Response Body

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

/Feeds/Text/{name}/Permissions/

GET

Includes object permissions for a given live text feed instance.

Parameters

  • [string] name:  The name of the live text feed instance

Response Body

Returns the Permission Entity (2020/10)

POST

Adds permissions to live text feeds instance(s) with the specified name.

Parameters

  • [string] name:  The name of the live text feed instance

Request Body

The Permission Entity (2020/10)

Response Body

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

DELETE

Removes permissions from the specified live text feed instance. 

Parameters

  • [string] name:  The name of the live text feed instance

Request Body

The Permission Entity (2020/10)

Response Body

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






  • No labels