Community articleGetting the Public Forums feed
Added by IBM contributorIBM on June 27, 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 all of the forums hosted by the Forums application. You can narrow down the forums that are returned by passing parameters to the request that you use to retrieve the feed.



Get a feed that includes all of the forums hosted by the Forums application. You can narrow down the forums that are returned by passing parameters to the request that you use to retrieve the feed.
 

Discoverability


You can derive the URL from the service document. Find the value of the href attribute of the <collection> element that contains an <atom:category> element which has a term="Public-Forums" attribute value.

Authentication


Request parameters


You can use one or more of the input parameters to limit the number of forums 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/forums/public Get a feed that includes all of the forums hosted by the Forums application. You can narrow down the forums that are returned by passing parameters to the request that you use to retrieve the feed.
Name Type Optional Description
communityUuid
string Yes The unique ID of a community. Limits the returned entries to include only those forums associated with the specified community.
email
string Yes Internet email address of a user. Specify this parameter to limit the returned entries to include only those forums 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
number 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 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 forums that were created by the specified person.
Output
Content Type: application/atom+xml
Code Description
200
OK. Indicates that the request was received successfully.