Getting a feed of the user's file's comments (My Comments)
Added by IBM contributorIBM | Edited by Claudia R Elbourn on June 15, 2015
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 all of the comments associated with one of the user's files (My Comments).

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

Request parameters

Use one or more of the input parameters to narrow the search. Separate multiple parameters with an ampersand (&).

Notices

Because commnetId parameter has precedence over the page and sI parameters, the previous and next page links into the returned atom feed document will not point to the previous and next page, because they will carry over the commentId parameter.

Input
Method URI Description
GET /files/{auth}/api/myuserlibrary/document/{document-id}/feed Get a feed that lists all of the comments associated with one of your files.
Name Type Optional Description
document-id
string No The value of the <td:uuid> or <td:label> elements in the file's Atom entry document
Name Type Optional Description
category
string No Resource type to include in the response. This parameter should always be set to comment. If you do not specify a category, comment is returned.
commentId
string Yes Returns the page that contains the comment specified by the commentId. This parameter has no effect when the results fit into a single page. If this parameter is passed, page and sI parameters are ignored.
identifier
enumerated Yes Indicates how the document is identified in the {document-id} variable segment of the web address. By default, look up is performed with the expectation that the URL contains the value from the <td:uuid> element of a file Atom entry. Options are uuid and label. Specify label if the URL instead contains the value from the <td:label> element of a file Atom entry.
Authorized values:
  • uuid
  • label
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.
Note: This parameter replaces the pageSize parameter. The pageSize parameter is supported for backwards compatibility only; it will be deprecated in a future release.
sl
int Yes Start index. Specifies the start index (as a number) in the collection from which the results should be returned. This parameter is ignored if a page parameter is provided.
sortBy
enumerated Yes String. Specifies what to sort the returned entries by. Options are:
created
Sorts the entries by the date the item was created.
modified
Sorts the entries by the last modified date.
published
Sorts the entries by the date the item was published (usually related to atom:published element).
updated
Sorts the entries by the last time the item was updated.
The default value of this parameter is modified.
Authorized values:
  • created
  • modified
  • published
  • updated
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.
If a value is specified for the sortBy parameter, but none is specified for this parameter, then this parameter defaults to asc. If neither is specified, this parameter defaults to desc.
Authorized values:
  • asc
  • desc
Output
Content Type: application/atom+xml
Code Description
200
OK. Indicates that the request was received successfully.
401
Unauthorized. Returned when the request has no authentication header and the file is not public or when the authenticated user has no access to the specified file.
400
Bad Request. An invalid or out of bound parameter was passed.