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 3 Next »

ON THIS PAGE

/feeds/text/

GET

Returns a list of Live Text (RSS) feeds on the network.

Parameters

  • 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 LiveTextFeed instances exceeds the pageSize.
  • pageSize: The maximum number of LiveTextFeed instances that can be contained in the response body
  • filter:  An expression for filtering search results. The following are accepted expressions:
    • [entry] IS '<value>'
    • [entry] CONTAINS '<value>'
    • [entry] IS IN ('<value_a>','<value_b>', [...])
    • [entry] IS NOT IN ('<value_a>','<value_b>', [...])
    • [entry] BEGINS WITH '<value>'
  • 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. "[liveTextFeed].[creationDate] ASC")

Response Body

  • [int] totalItemCount: The total number of LiveTextFeed instances relevant to the query
  • [int] pageSize: The maximum number of LiveTextFeed instances that can be returned in a single response
  • [bool] isTruncated: A flag indicating whether the totalItemCount exceeds the pageSize
  • [string] nextMarker: A value that can be included with a subsequent GET call to return additional results that have been truncated
  • [string] sortExpression: The sort expression specified in the URL
  • [string] filterExpression: The filter expression specified in the URL
  • [LiveTextFeed[]]items: An array of LiveTextFeed object instances. Each LiveTextFeed instance can have the following entries: 

    • [int] id: A unique identifier for the LiveTextFeed instance

    • [string] name: The name of the Live Text feed

    • [string] physicalPath: The location of the feed XML file in the server directory

    • [int] fileSize: The size of the feed XML file (in bytes)

    • [string] fileHash: The hash algorithm and the value that results from performing the hash algorithm on the file. The string is formatted as "{algorithm}:{value}" (e.g. "SHA1:6DB465879088280AAC52DC22B07ED0AD493A99D4").

    • [string] creationDate: A UTC timestamp indicating when the Live Text feed was created on BSN. The date/time is formatted as yyyy-mm-ddThh:mm:ss.sssZ.

    • [Item[]]items: An array of Item object instances representing RSS feed entries. The server currently returns a null value for this parameter. 

    • [Presentation[]]presentations: An array of Presentation object instances representing presentations that use the Live Text feed. Each Presentation instance can have the following values:

      • [int] id: A unique identifier for the Presentation instance 
      • [string] name: The presentation name
      • [string] type: The presentation type

    • [Permission[]]permissions: An array of Permission object instances representing permissions rules assigned to the Live Text feed

POST

Adds a new Live Text feed (RSS) to the network

Request Body

  • [string] name: The name of the Live Text feed
  • [Item[]]items: An array of Item object instances representing RSS feed entries. Each Item instance should have the following values:

    • [string] title: The key (RSS item title) of the entry

    • [string] description: The value (RSS item description) of the entry

    • [bool] validityStartDate: A UTC value that determines the validity start date for the entry (i.e. the point at which it will start being included in the Live Text feed).The date/time is formatted as yyyy-mm-ddThh:mm:ss.sssZ. A null value specifies that the item is valid immediately when added to the Live Text feed.

    • [bool] validityEndDate:  A UTC Value that determines the validity end date for the associated entry (i.e. the point at which it will no longer be included in the Live Text Feed). The date/time is formatted as yyyy-mm-ddThh:mm:ss.sssZ. A null value specifies that the item will be valid until it is removed from the Live Text feed manually by a user.

Response Body

  • [int] id: A unique identifier for the LiveTextFeed instance

  • [string] name: The name of the Live Text feed

  • [string] physicalPath: The location of the feed XML file in the server directory

  • [int] fileSize: The size of the feed XML file (in bytes)

  • [string] fileHash: The hash algorithm and the value that results from performing the hash algorithm on the file. The string is formatted as "{algorithm}:{value}" (e.g. "SHA1:6DB465879088280AAC52DC22B07ED0AD493A99D4").

  • [string] creationDate: A UTC timestamp indicating when the Live Text feed was created on BSN. The date/time is formatted as yyyy-mm-ddThh:mm:ss.sssZ.

  • [Item[]]items: An array of Item object instances representing RSS feed entries. Each Item instance should have the following values:

    • [string] title: The key (RSS item title) of the entry

    • [string] description: The value (RSS item description) of the entry

    • [bool] validityStartDate: A UTC value that determines the validity start date for the entry (i.e. the point at which it will start being included in the Live Text feed).The date/time is formatted as yyyy-mm-ddThh:mm:ss.sssZ. A null value specifies that the item is valid immediately when added to the Live Text feed.

    • [bool] validityEndDate:  A UTC Value that determines the validity end date for the associated entry (i.e. the point at which it will no longer be included in the Live Text Feed). The date/time is formatted as yyyy-mm-ddThh:mm:ss.sssZ. A null value specifies that the item will be valid until it is removed from the Live Text feed manually by a user.

  • [Presentation[]]presentations: An array of Presentation object instances representing presentations that use the Live Text feed. Each Presentation instance can have the following values:

    • [int] id: A unique identifier for the Presentation instance 
    • [string] name: The presentation name
    • [string] type: The presentation type

  • [Permission[]]permissions: An array of Permission object instances representing permissions rules assigned to the Live Text feed

 

/feeds/text/count/

GET

Retrieves 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

  • filter:  An expression for filtering the request. The following are accepted expressions:
    • [entry] IS '<value>'
    • [entry] CONTAINS '<value>'
    • [entry] IS IN ('<value_a>','<value_b>', [...])
    • [entry] IS NOT IN ('<value_a>','<value_b>', [...])
    • [entry] BEGINS WITH '<value>'

Response Body

The number of Live Text feeds is returned as an integer value.

/feeds/text/operations/

GET

Returns Business Operations for Live Text feeds.

Response Body

  • [string] uid: A unique identifier for the LiveTextFeed instance.
  • [string] singularName: The name of the operation in singular form. This value is useful for displaying in entity properties dialogs.
  • [string] pluralName: The name of the operation in plural form. This value is useful for displaying in User and Role properties dialogs.
  • [string] fullName: The name of the current operation along with its parent operations (if any). Since many operation names aren't unique, this value is useful for differentiating similar business operations.
  • [string] targetEntity: The object type affected by the operation (in this case, "LiveTextFeed")
  • [Operation{}] parent: An Operation instance indicating the operation from which permissions are inherited. This value will be Null if there is no parent operation.
  • [Operations[]]descendants: An array of Operation instances that inherit permissions from this operation. This value is Null if there are no descendant operations.
  • [Permissions[] permissions: An array of Permission instances indicating permissions associated with this operation

/feeds/text/{feed_id||name}/

GET

Returns the Feed instance with the specified ID or name.

Response Body

  • [int] id: A unique identifier for the LiveTextFeed instance

  • [string] name: The name of the Live Text feed

  • [string] physicalPath: The location of the feed XML file in the server directory

  • [int] fileSize: The size of the feed XML file (in bytes)

  • [string] fileHash: The hash algorithm and the value that results from performing the hash algorithm on the file. The string is formatted as "{algorithm}:{value}" (e.g. "SHA1:6DB465879088280AAC52DC22B07ED0AD493A99D4").

  • [string] creationDate: A UTC timestamp indicating when the Live Text feed was created on BSN. The date/time is formatted as yyyy-mm-ddThh:mm:ss.sssZ.

  • [Item[]]items: An array of Item object instances representing RSS feed entries. Each Item instance should have the following values:

    • [string] title: The key (RSS item title) of the entry

    • [string] description: The value (RSS item description) of the entry

    • [bool] validityStartDate: A UTC value that determines the validity start date for the entry (i.e. the point at which it will start being included in the Live Text feed).The date/time is formatted as yyyy-mm-ddThh:mm:ss.sssZ. A null value specifies that the item is valid immediately when added to the Live Text feed.

    • [bool] validityEndDate:  A UTC Value that determines the validity end date for the associated entry (i.e. the point at which it will no longer be included in the Live Text Feed). The date/time is formatted as yyyy-mm-ddThh:mm:ss.sssZ. A null value specifies that the item will be valid until it is removed from the Live Text feed manually by a user.

  • [Presentation[]]presentations: An array of Presentation object instances representing presentations that use the Live Text feed. Each Presentation instance can have the following values:

    • [int] id: A unique identifier for the Presentation instance 
    • [string] name: The presentation name
    • [string] type: The presentation type

  • [Permission[]]permissions: An array of Permission object instances representing permissions rules assigned to the Live Text feed

PUT

Modifies the specified LiveDataFeed instance using the entries in the request body.

Request Body

  • [string] name: The name of the Live Text feed
  • [Item[]]items: An array of Item object instances representing RSS feed entries. Each Item instance should have the following values:

    • [string] title: The key (RSS item title) of the entry

    • [string] description: The value (RSS item description) of the entry

    • [bool] validityStartDate: A UTC value that determines the validity start date for the entry (i.e. the point at which it will start being included in the Live Text feed).The date/time is formatted as yyyy-mm-ddThh:mm:ss.sssZ. A null value specifies that the item is valid immediately when added to the Live Text feed.

    • [bool] validityEndDate:  A UTC Value that determines the validity end date for the associated entry (i.e. the point at which it will no longer be included in the Live Text Feed). The date/time is formatted as yyyy-mm-ddThh:mm:ss.sssZ. A null value specifies that the item will be valid until it is removed from the Live Text feed manually by a user.

Response Body

  • [int] id: A unique identifier for the LiveTextFeed instance

  • [string] name: The name of the Live Text feed

  • [string] physicalPath: The location of the feed XML file in the server directory

  • [int] fileSize: The size of the feed XML file (in bytes)

  • [string] fileHash: The hash algorithm and the value that results from performing the hash algorithm on the file. The string is formatted as "{algorithm}:{value}" (e.g. "SHA1:6DB465879088280AAC52DC22B07ED0AD493A99D4").

  • [string] creationDate: A UTC timestamp indicating when the Live Text feed was created on BSN. The date/time is formatted as yyyy-mm-ddThh:mm:ss.sssZ.

  • [Item[]]items: An array of Item object instances representing RSS feed entries. Each Item instance should have the following values:

    • [string] title: The key (RSS item title) of the entry

    • [string] description: The value (RSS item description) of the entry

    • [bool] validityStartDate: A UTC value that determines the validity start date for the entry (i.e. the point at which it will start being included in the Live Text feed).The date/time is formatted as yyyy-mm-ddThh:mm:ss.sssZ. A null value specifies that the item is valid immediately when added to the Live Text feed.

    • [bool] validityEndDate:  A UTC Value that determines the validity end date for the associated entry (i.e. the point at which it will no longer be included in the Live Text Feed). The date/time is formatted as yyyy-mm-ddThh:mm:ss.sssZ. A null value specifies that the item will be valid until it is removed from the Live Text feed manually by a user.

  • [Presentation[]]presentations: An array of Presentation object instances representing presentations that use the Live Text feed. Each Presentation instance can have the following values:

    • [int] id: A unique identifier for the Presentation instance 
    • [string] name: The presentation name
    • [string] type: The presentation type

  • [Permission[]]permissions: An array of Permission object instances representing permissions rules assigned to the Live Text feed

DELETE

Removes the specified LiveTextFeed instance from the network. The server returns code 204 if successful and code 404 if the LiveTextFeed instance could not be found.

/feeds/media/

GET

...

Parameters

  • page_index:
  • marker:
  • page_size: 
  • filter:
  • sort:

Request Body

 

Response Body

POST

...

Parameters

 

Request Body

 

Response Body

PATCH

...

Parameters

  • filter: 

Request Body

 

Response Body

DELETE

...

Parameters

  • filter: 

Request Body

 

Response Body

 

/feeds/media/count/

GET

...

Parameters

  • filter:  

Request Body

 

Response Body

 

/feeds/media/operations/

GET

...

Parameters

 

Request Body

 

Response Body

 

/feeds/media/{feed_id}/

GET

...

Parameters

 

Request Body

 

Response Body

 

PUT

...

Parameters

 

Request Body

 

Response Body

 

PATCH

...

Parameters

 

Request Body

 

Response Body

 

DELETE

...

Parameters

 

Request Body

 

Response Body

 

/feeds/media/{feed_name}/

GET

...

Parameters

 

Request Body

 

Response Body

 

PUT

...

Parameters

 

Request Body

 

Response Body

 

PATCH

...

Parameters

 

Request Body

 

Response Body

 

DELETE

...

Parameters

 

Request Body

 

Response Body

 

/feeds/media/{feed_id}/permissions/

GET

...

Parameters

 

Request Body

 

Response Body

 

POST

...

Parameters

 

Request Body

 

Response Body

 

DELETE

...

Parameters

 

Request Body

 

Response Body

 

/feeds/media/{feed_name}/permissions/

GET

...

Parameters

 

Request Body

 

Response Body

 

POST

...

Parameters

 

Request Body

 

Response Body

 

DELETE

...

Parameters

 

Request Body

 

Response Body

 

  • No labels