Retrieve the Forums service document 

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

Table 1. Atom API request details

Method Resource URI Description
GET Service document /atom/service Accesses a user's service document to retrieve links to a user's Forums views, which are listed as collections.


Example

To retrieve the service document for the Forums application, send the following request:

> GET /forums/atom/service HTTP/1.1
> Authorization: xxx
> Host: enterprise.example.com:9444
> Accept: */*

HTTP response:

< HTTP/1.1 200 OK

The service document for Forums is returned. For example:

<service>
  <generator uri="http://www.ibm.com/xmlns/prod/sn" version="3.0.1.0">
     IBM Connections - Discussion Forum
  </generator>
  <workspace>
    <atom:title type="text">Forums Feed Collection</atom:title>
    <collection href="https://enterprise.example.com/forums/atom/forums">
      <atom:title type="text">Forums</atom:title>
      <accept>application/atom+xml; type=entry</accept>
      <atom:id>
        https://enterprise.example.com/forums/atom/forums
      </atom:id>
      <atom:category scheme="http://www.ibm.com/xmlns/prod/sn/collection" term="Forums"/>
    </collection>
    <collection href="https://enterprise.example.com/forums/atom/forums/public">
      <atom:title type="text">Public Forums</atom:title>
      <accept/>
      <atom:id>
        https://enterprise.example.com/forums/atom/forums/public
      </atom:id>
      <atom:category scheme="http://www.ibm.com/xmlns/prod/sn/collection" term="Public-Forums"/>
    </collection>
    <collection href="https://enterprise.example.com/forums/atom/forums/my">
      <atom:title type="text">My Forums</atom:title>
      <accept/>
      <atom:id>
        https://enterprise.example.com/forums/atom/forums/my
      </atom:id>
      <atom:category scheme="http://www.ibm.com/xmlns/prod/sn/collection" term="My-Forums"/>
    </collection>
    <collection href="https://enterprise.example.com/forums/atom/topics/my">
      <atom:title type="text">My Topics</atom:title>
      <accept/>
      <atom:id>
        https://enterprise.example.com/forums/atom/topics/my
      </atom:id>
      <atom:category scheme="http://www.ibm.com/xmlns/prod/sn/collection" term="My-Topics"/>
    </collection>
  </workspace>
</service>


Parent topic

Forums API


   

 

});