Community articleRetrieving the Files moderation service document
Added by IBM contributorIBM on June 23, 2014
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

Before you can manage the files and comments that have been added to a community or flagged as inappropriate, you must retrieve the Files moderation service document. You can use the links that it provides to locate the resources that await moderation approval.



Before you can manage the files and comments that have been added to a community or flagged as inappropriate, you must 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.
 

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

Input parameters


None.

Output


A Files moderation service document in Atom Publishing protocol format.

 

Method URI Description
GET /files/basic/api/moderation/atomsvc Accesses the moderation service document. The service document provides two workspaces, one for entry moderation and one for comment moderation.
Output
Content Type: application/atom+xml
Code Description
200
OK. Indicates document was found and returned.
Examples
> GET /files/basic/api/moderation/atomsvc HTTP/1.1

> Host: enterprise.example.com

> Accept: */*


Response returned by the server
<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>