Community articleRetrieving a community file 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 retrieve a community file that is waiting to be approved, use the link element found in the file entry.



To retrieve a community file that is waiting to be approved, use the link element found in the file entry.

You can use this operation to obtain file entry information that you want to preserve prior to performing an update. See Updating a community file awaiting approval for more information. This method returns the Atom entry of a single file entry as opposed to a feed of all the files.

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

To retrieve a community file that is 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-content" .../> child element, and make a note of the web address in its href attribute.
  3. Send a GET request to the web address you copied from the previous step. In the returned feed, find the entry that you want to retrieve, and make a note of the web address in the href attribute of the <link> element with the following rel attribute value:
    • To get the Atom document of the file: rel="edit"
    • To download the file itself: rel="enclosure"
       
  4. Send a GET request to the URL that you noted in the previous step.

 

Input


None.

Output


An Atom entry document containing the file or the file itself.
 

 

Input
Method URI Description
GET /files/basic/api/approval/documents/{fileId} Value of the href attribute of <link rel="edit"> element of each entry in the Entry Approval feed.
GET /files/basic/api/approval/documents/{fileId}/media/{label} Value of the href attribute of <link rel="enclosure"> element of each entry in the Flagged Entries feed.
Name Type Optional Description
fileId
string No The ID of the file you wish to retrieve
label
string Yes Name of file you wish to retrieve
Output
Content Type: application/atom+xml
Code Description
200
OK. Indicates that the file was successfully found and returned. If an error occurs, this header contains one of the error codes.
401
Unauthorized.
404
Not Found.