Community articleForums API
Added by IBM contributorIBM on December 21, 2015
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

The Forums application of IBM® Connections enables a team to discuss issues that are pertinent to their work. The Forums API allows application programs to create new forums, and to read and modify existing forums.



The Forums application of IBM® Connections enables a team to discuss issues that are pertinent to their work. The Forums API allows application programs to create new forums, and to read and modify existing forums.

Forums implements the following APIs:

Subscription

Forums implements the Atom Syndication Format (Atom 1.0) to serve Atom feeds that you can use in your applications to search for and retrieve information from any of the forums created by the people in your organization. The format documented here is what feed readers use to discover updated content in a forum.

Publishing

Forums implements the Atom Publishing Protocol to enable you to programmatically manipulate Forums content. Forums provides a service document and some category documents. The service document contains the currently authenticated user's collections and feeds. You can use the publishing APIs in your applications to perform actions, such as creating a forum. When interacting with forums to which you have owner access, you can retrieve more detailed information about the forum. You can also delete, restore, or update the forum and any of its topics. When interacting with forums to which you have author access, you can update, delete, and restore any forum topics that you authored; you can also add new topics.

Navigating Forums resources
Describes how to navigate from one Forums resource to another using the resources made available through the API.

Retrieving the Forums service document
To update resources made available through the Atom APIs, you must first retrieve the service document for the application.

Getting Forums feeds
Use the Atom subscription API to retrieve resources from the forums hosted by the Forums application.

Working with stand-alone forums
Using the Atom Publishing Protocol, also known as AtomPub, you can create or update forums.

Working with stand-alone forum topics
Using the Atom Publishing Protocol, also known as AtomPub, you can create or update topics in stand-alone forums.

Working with stand-alone forum replies
Using the Atom Publishing Protocol, also known as AtomPub, you can create or update replies to stand-alone forum topics.

Working with stand-alone forum members
Using the Atom Publishing Protocol, also known as AtomPub, you can add members as owners or moderators to the members list of a stand-alone forum and make updates to the list. All forums are public, so anyone who can authenticate with IBM Connections is considered a member of its forums. Only forum owners can add people to a forum as owners and moderators.

Moderating forum content programmatically
Use the Atom Publishing Protocol, also known as AtomPub, to moderate forum content.

Forums entry types
Lists the Atom entry types that can appear in feeds produced by the Forums API or in an Atom Entry document produced or sent to the API.