Retrieving the Files moderation service document

Retrieve the Files moderation service document
Before you can manage the files and comments that have been added to a community or flagged as inappropriate, retrieve the Files 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 Files application.
Table 1. Atom API request details

Method Resource URI Description
GET Service document /basic/api/moderation/atomsvc Accesses the moderation service document. The service document provides two workspaces, one for entry moderation and one for comment 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 Files 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 /files/basic/api/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 version="3.0.0.0" uri="http://www.ibm.com/xmlns/prod/sn" apiVersion="1.0.1">
    IBM Connections - Files
  </generator>
  <workspace>
    <title type="text">Moderation of Files documents</title>
    <category term="documents-moderation" scheme="http://www.ibm.com/xmlns/prod/sn/workspace"/>
    <collection href="https://enterprise.example.com/files/basic/api/approval/documents">
      <category term="approval-content" scheme="http://www.ibm.com/xmlns/prod/sn/collection"/>
      <title type="text">List documents by approval status</title>
      <accept/>
    </collection>
    <collection href="https://enterprise.example.com/files/basic/api/approval/actions/documents">
      <category term="approval-action" scheme="http://www.ibm.com/xmlns/prod/sn/collection"/>
      <title type="text">Change document approval status</title>
      <accept>entry</accept>
    </collection>
    <collection href="https://enterprise.example.com/files/basic/api/review/documents">
      <category term="review-content" scheme="http://www.ibm.com/xmlns/prod/sn/collection"/>
      <title type="text">List documents by review status</title>
      <accept/>
    </collection>
    <collection href="https://enterprise.example.com/files/basic/api/review/actions/documents">
      <category term="review-action" scheme="http://www.ibm.com/xmlns/prod/sn/collection"/>
      <title type="text">Change document review status</title>
      <accept>entry</accept>
    </collection>
  </workspace>
  <workspace>
    <title type="text">Moderation of Files comments</title>
    <category term="comments-moderation" scheme="http://www.ibm.com/xmlns/prod/sn/workspace"/>
    <collection href="https://enterprise.example.com/files/basic/api/approval/comments">
      <category term="approval-content" scheme="http://www.ibm.com/xmlns/prod/sn/collection"/>
      <title type="text">List comments by approval status</title>
      <accept/>
    </collection>
    <collection href="https://enterprise.example.com/files/basic/api/approval/actions/comments">
      <category term="approval-action" scheme="http://www.ibm.com/xmlns/prod/sn/collection"/>
      <title type="text">Change comment approval status</title>
      <accept>entry</accept>
    </collection>
    <collection href="https://enterprise.example.com/files/basic/api/review/comments">
      <category term="review-content" scheme="http://www.ibm.com/xmlns/prod/sn/collection"/>
      <title type="text">List comments by review status</title>
      <accept/>
    </collection>
    <collection href="https://enterprise.example.com/files/basic/api/review/actions/comments">
      <category term="review-action" scheme="http://www.ibm.com/xmlns/prod/sn/collection"/>
      <title type="text">Change comment review status</title>
      <accept>entry</accept>
    </collection>
  </workspace>
</service>
Parent topic
Moderating community files and comments programmatically

Related tasks

Manage content moderation and flagged content

});

+
Search Tips | Advanced Search

Method	Resource	URI	Description
GET	Service document	/basic/api/moderation/atomsvc	Accesses the moderation service document. The service document provides two workspaces, one for entry moderation and one for comment moderation.