Community articleGetting the history of a flagged file
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

Get a feed that lists a history of the flags raised on a given file.



Get a feed that lists a history of the flags raised on a given file.
 

{document-id} is the value of the <td:uuid> or <td:label> elements in the file's Atom entry document.

Discoverability


You can derive the URL from the Flagged Entries feed. Use the web address in the href attribute of the <link> element with the rel="http://www.ibm.com/xmlns/prod/sn/history" attribute for the entry representing the flagged file.

Authentication


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

You can use one or more of the input parameters to limit the number of entries returned in the feed. Separate multiple parameters with an ampersand (&).


 

Output


An Atom feed containing the reports associated with the specified file.

 

Input
Method URI Description
GET /files/basic/api/review/actions/documents/{document-id} You can derive the URL from the Flagged Entries feed. Use the web address in the href attribute of the <link> element with the rel="http://www.ibm.com/xmlns/prod/sn/history" attribute for the entry representing the flagged file.
Name Type Optional Description
document-id
string No {document-id} is the value of the <td:uuid> or <td:label> elements in the file's Atom entry document.
Name Type Optional Description
filter
enumerated Yes Value with which to filter the returned entries. Options are:
flag
Any flag record, dismissed or not.
flagIsDismissed
Only flag records that have been dismissed.
flagIsRaised
Only flag records that have not been dismissed.
The default value for this parameter is flagIsRaised.
Authorized values:
  • flag
  • flagIsDismissed
  • flagIsRaised
page
int Yes Page number. Specifies the page to be returned. The default value is 1, which returns the first page.
ps
int Yes Page size. Specifies the number of entries to return per page. The default value is 10. The maximum value you can specify is 500.
sortBy
enumerated Yes Species what value to use as the basis for organizing the entries returned in the feed. There is only one option:
date
Sorts the entries by the date on which it was changed to its current moderation status. In this case, it is the date on which the flag was created.
Authorized values:
  • date
sortOrder
enumerated Yes Specifies the order in which to sort the results. The options are:
asc
Sorts the results in ascending order.
desc
Sorts the results in descending order.
The default is desc.
Authorized values:
  • asc
  • desc
Output
Content Type: application/atom+xml