Community articleNavigating Forums resources
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

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



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

When you create an application that accesses Forums resources, do not construct URLs to Forums resources; instead write code to follow the links from the user's service document to the user's forums collection, and then to each individual forum.

The following table describes the available Forums resources.

Table 1. Forums resources

Resource
URI
Method | Representation
Description
Service document
/atom/service
GET | Service Document
As defined in the AtomPub specification. Access a user's service document to retrieve links to the user's forum collection.
Forums
Web address found in the href attribute of the collection that has the <atom:category term="Forums"/> element in the service document
  • GET | forum feed
  • POST | forum entry
Collection of forums. Includes all stand-alone and community forums.
Public forums
Web address found in the href attribute of the collection that has the <atom:category term="Public-Forums"/> element in the service document
  • GET | forum feed
Collection of forums. Includes all stand-alone forums.
My forums
Web address found in the href attribute of the collection that has the <atom:category term="My-Forums"/> element in the service document
  • GET | forum feed
Collection of forums. Includes forums you are following, own, or that are associated with communities to which you belong.
Forum entry
Web address found in the href attribute of the <link> element that has a rel="edit" attribute in each entry in the Forums collection.
  • GET | forum edit URL
  • PUT | forum edit URL
  • DELETE | forum edit URL
Represents a forum.
My topics
Web address found in the href attribute of the collection that has the <atom:category term="My-Topics"/> element in the service document
  • GET | topic feed
Collection of topics. Includes topics you follow, own through forum ownership, or that are associated with communities to which you belong.
Topic entry
Web address found in the href attribute of the <link> element that has a rel="edit" attribute in each entry in the forum entry document.
  • GET | topic edit URL
  • PUT | topic edit URL
  • DELETE | topic edit URL
Represents a topic.
Replies
Web address found in the href attribute of the rel="replies" link for each forum or reply entry in the Forums feed or in a forum, topic, or reply entry.
  • GET | reply feed
  • POST | reply entry
Collection of replies.
Reply entry
Web address found in the href attribute of the <link> element that has a rel="edit" attribute in each entry in the Replies collection.
  • GET | reply edit URL
  • PUT | reply edit URL
  • DELETE | reply edit URL
Represents a reply to a topic or other reply.