Get a feed that includes the topics for a specific forum. You can narrow down the topics that are returned by passing parameters to the request that you use to retrieve the feed.
Table 1. Atom API request details
|Value of the href attribute of the <link> element with the rel="replies" attribute value for each forum.||Lists all topics in the specified forum. Returns a feed containing topic entries.|
|Value of the href attribute of the <link> element with the rel="http://www.ibm.com/xmlns/prod/sn/forum-topics" attribute value for each community.||Lists all topics in the specified community forum. Returns a feed containing topic entries.|
You can use one or more of the input parameters to limit the number of entries returned in the feed. Separate multiple parameters with an ampersand (&).
Table 2. Input parameters
|email||Internet email address of a user. Specify this parameter to limit the returned entries to include only those topics that were created by the specified person. Format the HTTP request using the proper URL encoding. For example, the encoded form of the @ symbol is %40 as in:|
Note: Do not use this parameter if IBM® Connections is configured to prevent email addresses from being displayed. It will return an error code 400 for an invalid request. Use the userid parameter instead.
|page||Page number. Specifies the page to be returned. The default value is 1.|
|ps||Page size. Specifies the number of entries to return per page.|
|since||Returns all entries last modified since a specified date. Specify the date in the number of milliseconds since January 1, 1970, 00:00:00 GMT time. |
|sortBy||String. Specifies what to sort the returned entries by. Options are:|
Sorts the results by creation date.lastmod
Sorts the results by the date on which they were last modified.
|sortOrder||Defines the order in which to sort the results. Options are: |
|tag||Returns entries with the specified tag. |
Note: Search by one tag at a time.
|userid||Unique ID that represents a specific person. This value is specified in the <snx:userid> element. Specify this parameter to limit the returned entries to include only those topics that were created by the specified person.|
An Atom feed document containing the forum atom entries.
Parent topic: Getting Forums feeds