Community articleActing on a community file that is awaiting approval
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

To programmatically take action on a community file that is waiting to be approved, send an Atom entry document that defines the action you want to take to the moderation action feed.



To programmatically take action on a community file that is waiting to be approved, send an Atom entry document that defines the action you want to take to the moderation action feed.

Only the moderator can take action on a file awaiting approval.

See Authenticating requests for information about how to authenticate the request.

To take action on a file awaiting approval, complete the following steps:
 

  1. Retrieve the moderation service document. See Retrieving the Files moderation service document for more details.
  2. In the service document, locate the workspace with the <category term="documents-moderation" .../> child element, and then find the collection with the <atom:category term="approval-action" .../> child element, and make a note of the web address in its href attribute.
  3. Find the entry representing the file that you want to take action on by getting a list of the entries awaiting approval. See Getting a list of community files that require action for more details. Make a note of the value of the <td:uuid> element for the entry representing the file.
  4. Create an Atom entry document that defines the action you want to perform. In the <snx:moderation action="xxx" /> element, choose one of the following options:
  5. Send a POST request to the web address that you noted in Step 2. Pass the Atom entry document that you created in the previous step as input on the request.

Input


Provide a moderation action Atom entry document. The content type of the Atom entry document must be application/atom+xml.

Output


None.


 

Input
Method URI Description
POST files/basic/api/approval/actions/documents Value of the href attribute of the <collection> element that has the <atom:category term="approval-action" .../> child element having in the moderation service document.
Output
Content Type: application/atom+xml
Code Description
204
Indicates that the entry was successfully moderated. If an error occurs, this header contains one of the error codes.
400
Bad Request.
401
Unauthorized.
403
Forbidden. Returned when the current user is authorized to the use the API, but cannot moderate the specified content.
404
Not Found. Indicates that the content is no longer available.
Examples
> POST files/basic/api/approval/actions/documents HTTP/1.1

> Authorization: Basic xxx

> Host: enterprise.example.com

> Accept: */*

> Content-Type: application/atom+xml

> Content-Length: 509


Response returned by the server
< HTTP/1.1 204 No Content