Get a feed that includes the topics in a specific forum, whether it is a stand-alone or community 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
|Description||HTTP Method||Sample URL|
How to discover the URL depends on which type of forum you are working with.
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 entry returned by one of the communities feeds.Stand-alone forum
Value of the href attribute of the <link> element with the rel="replies" attribute value for each forum entry returned by one of the forums feeds.
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, which returns the first page.|
|ps||Page size. Specifies the number of entries to return per page. The default value is 10. The maximum value you can specify is 100.|
|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 entries by the date the item was created.modified
Use with the sortOrder parameter to specify the order in which to display the results.
Sorts the entries by the last modified date.
Note: This option replaces the lastmod option. lastmod is supported for backwards compatibility only; it will be deprecated in a future release.
|sortOrder||Specifies the order in which to sort the results. The options are: |
Sorts the results in ascending order.desc
Sorts the results in descending order.
|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