Skip to content

Syndication (RSS, Atom)

Syndication support makes it easier to keep track of changes of lists, resources and their metadata.

{base}/{context-id}/resource/{entry-id}?syndication={syndication format}

Feeds are available for lists (folders) and contexts. If entry-id identifies a folder then all contained resources will be covered by the feed. This works recursively, i.e. all subfolders' resources are included, sorted after the modification date. The feed of a context is requested through the context's entry in the _contexts context:

{base}/_contexts/resource/{context-id}?syndication={syndication format}

Feeds require Solr; without it the request is answered with 501. For entries that are neither a list nor a context the response is 405, and an unsupported syndication format is answered with 400.

The syndication parameter accepts the following values:

  • atom_1.0
  • atom_0.3
  • rss_2.0
  • rss_1.0

The following optional parameters are supported:

  • feedSize: maximum number of items, default 50. Larger values are limited to entrystore.solr.max-limit, which defaults to 50 for feeds if it is not set (it defaults to 100 for search, see Search). Setting entrystore.solr.max-limit explicitly applies the same cap to both.
  • lang: preferred language of item titles and descriptions, default en.
  • urltemplate and feedtitle, see below.

EntryStore 5.x

In 5.x the cap for feedSize defaults to 100 if entrystore.solr.max-limit is not set.

Example using RSS 2.0

{baseURL}/{context-id}/resource/{entry-id}?syndication=rss_2.0

By default the links of feed items correspond to the entries' resource URIs. It is possible to override this behavior by configuring custom URL patterns that are "activated" by using the URL parameter urltemplate.

The corresponding setting in entrystore.properties is entrystore.syndication.url-template.<name>, where <name> can be any alphanumerical value, or default if a URL pattern should be applied for all syndication feeds even when the URL parameter urltemplate is missing. If urltemplate names a template that is not configured, the links fall back to the resource URIs.

In 6.x a name with characters other than lowercase letters, digits, - and _ may not be bound as written; write such keys in brackets to keep the name verbatim, e.g. entrystore.syndication.url-template[myFeed]=....

Example configuration:

entrystore.syndication.url-template.default=http://sub.entrystore.tld/store/lookup?uri={resourceuri}
entrystore.syndication.url-template.blocks=http://sub.domain.tld/details?cid={contextid}&eid={entryid}
entrystore.syndication.url-template.somethingelse=http://sub.domain.tld/somethingelse?entry={entryuri}

Example request:

GET {base}/{context-id}/resource/{entry-id}?syndication=rss_2.0&urltemplate=blocks

The following variables are supported in the URL template definition:

  • {contextid}
  • {entryid}
  • {entryuri}
  • {resourceuri}

All values are URL encoded before they are used for replacing the variables in the URL pattern.

Custom feed title

It is possible to provide a custom feed title through the feedtitle URL parameter. A title longer than 64 characters is cut off after 63 characters, and any HTML characters will be encoded. The default title is "Feed of" followed by the context's name or the list's title.

For information on syndication in search, please see the page Search.