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}

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 syndication parameter accepts the following values:

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

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.

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. The title will be cut off after 64 characters and any HTML characters will be encoded.

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