Retrieve the Forums moderation service document 

Before you can manage the entries and replies added to a forum or flagged as inappropriate, retrieve the moderation service document. You can use the links that it provides to locate the resources that await moderation approval.

The user authenticating the request must be the moderator of the Forums application.

Table 1. Atom API request details

Method	Resource	URI	Description
GET	Service document	/atom/moderation/atomsvc	Accesses the moderation service document. The service document provides one workspace for entry and reply moderation.

You must edit the contentApproval property in the contentreview-config.xml file to enable premoderation. See Manage content moderation and flagged content in the Administer applications section of the product documentation for more details.

Input parameters

None.

Output

A Forums moderation service document in Atom Publishing protocol format.

The following HTTP headers are returned:

• HTTP/1.1 200 OK. Indicates document was found and returned.

• Content-Type: application/atomsvc+xml. Indicates payload contains data in Atom Publishing Service Document format.
  

Example

Input HTTP headers:

> GET /forums/atom/moderation/atomsvc HTTP/1.1
> Host: enterprise.example.com
> Accept: */*

Response HTTP headers:

HTTP/1.1 200 OK
Content-Type: application/atomsvc+xml;charset=UTF-8
Content-Language: en-US

Response:

<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">Moderation of topic and reply contents</atom:title>
    <collection href="https://enterprise.example.com/forums/atom/approval/entries">
      <atom:title type="text">Listing of pre-moderated forum content </atom:title>
      <accept/>
      <atom:id>
        https://enterprise.example.com/forums/atom/approval/entries
      </atom:id>
      <atom:category scheme="http://www.ibm.com/xmlns/prod/sn/collection" term="approval-content"/>
    </collection>
    <collection href="https://enterprise.example.com/forums/atom/approval/actions">
      <atom:title type="text">
        Change pre-moderated forum content approval status 
      </atom:title>
      <accept>application/atom+xml; type=entry</accept>
      <atom:id>
        https://enterprise.example.com/forums/atom/approval/actions
      </atom:id>
      <atom:category scheme="http://www.ibm.com/xmlns/prod/sn/collection" term="approval-action"/>
    </collection>
    <collection href="https://enterprise.example.com/forums/atom/review/entries">
      <atom:title type="text">Listing of post-moderated forum content </atom:title>
      <accept/>
      <atom:id>
        https://enterprise.example.com/forums/atom/review/entries
      </atom:id>
      <atom:category scheme="http://www.ibm.com/xmlns/prod/sn/collection" term="review-content"/>
    </collection>
    <collection href="https://enterprise.example.com/forums/atom/review/actions">
      <atom:title type="text">Change post-moderated forum content review status</atom:title>
      <accept>application/atom+xml; type=entry</accept>
      <atom:id>
        https://enterprise.example.com/forums/atom/review/actions
      </atom:id>
      <atom:category scheme="http://www.ibm.com/xmlns/prod/sn/collection" term="review-action"/>
    </collection>
  </workspace>
</service>

Parent topic

Moderating forum content programmatically

Related tasks

Manage content moderation and flagged content

   

 

});

+

Search Tips   |   Advanced Search