Community articleGetting a feed of forum topics
Added by IBM contributorIBM | Edited by IBM contributorNiklas Heidloff on July 31, 2014
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

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.



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.


Discoverability


How to discover the URL depends on which type of forum you are working with.

Community forum

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.

Authentication


Request parameters


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 (&).


Output


An Atom feed document containing the forum atom entries.

 

Input
Method URI Description
GET /forums/atom/topics?forumUuid={forumUuid} 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.
GET /communities/service/atom/community/forum/topics?communityUuid={communityUuid} Community forum - 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.
Name Type Optional Description
forumUuid
string Yes UUID of specific forum
communityUuid
string Yes UUID of the community you wish to query
Name Type Optional Description
email
string Yes 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:
adam_eventide%40garden.com
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
int Yes Page number. Specifies the page to be returned. The default value is 1, which returns the first page.
ps
int Yes 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
string Yes 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
enumerated Yes String. Specifies what to sort the returned entries by. Options are:
created
Sorts the entries by the date the item was created.
modified
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.
Use with the sortOrder parameter to specify the order in which to display the results.
Authorized values:
  • created
  • modified
sortOrder
enumerated Yes Specifies the order in which to sort the results. The options are:
asc
Sorts the results in ascending order.
desc
Sorts the results in descending order.
Authorized values:
  • asc
  • desc
tag
string Yes Returns entries with the specified tag.
Note: Search by one tag at a time.
userid
string Yes 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.
filter
enumerated Yes Identifies the topic type to return. Options are:
answeredquestions
questions
allquestions
topics
The default value is topics.
Authorized values:
  • answeredquestions
  • questions
  • allquestions
  • topics
within
enumerated Yes Identifies the topic scope to return.
Options are:
standalone
communities
Note: this parameter will filter the questions by standalone forums and community forums only. If it is not set, then the default value is standalone
Authorized values:
  • standalone
  • communities
Output
Content Type: application/atom+xml
Code Description
200
OK. Indicates that the request was received successfully.