Community articleRetrieving a file comment
Added by IBM contributorIBM on March 25, 2014
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

Retrieve an Atom document representation of a comment associated with a file.



Retrieve an Atom document representation of a comment associated with a file.

This method returns the Atom document of the comment. If you want to retrieve a feed, see Getting a feed of comments.

See Authenticating requests for information about how to authenticate the request.
  • {userid} is the value of the <snx:userid> of the person who owns the file. See Searching Profiles for information about how to determine a person's user ID.
  • {document-id} is the value of the <td:uuid> or <td:label> of the file and can be found in the file's Atom document. If you specify the document by label, you must also provide the identifier=label parameter as part of the request.

You can use one or more of these headers with the GET request.

You can use one or more of these input parameters with the GET request. Separate multiple parameters with an ampersand (&).

Input

None.

Output

An Atom entry document containing the comment.

Input
Method URI Description
GET /files/basic/api/userlibrary/{userid}/document/{document-id}/comment/{comment-id}/entry Returns a comment from someone else's file.
GET /files/basic/api/myuserlibrary/document/{document-id}/comment/{comment-id}/entry Returns a comment from one of your files.
Name Type Optional Description
userid
string No {userid} is the value of the <snx:userid> of the person who owns the file. See Searching Profiles for information about how to determine a person's user ID.
document-id
string No {document-id} is the value of the <td:uuid> or <td:label> of the file and can be found in the file's Atom document. If you specify the document by label, you must also provide the identifier=label parameter as part of the request.
Name Type Optional Description
acls
boolean Yes Specifies whether or not the permissions for each user should be displayed for each entry in the returned Atom document. This parameter takes a Boolean value of either true or false. By default, the permission information is not returned.
identifier
string 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. Specify "label" if the URL instead contains the value from the <td:label> element of a File Atom entry.
Name Type Optional Description
If-Modified-Since
string Yes Used to validate the local cache of the feed and entry documents retrieved previously. If the feed or entry has not been modified since the specified date, HTTP response code 304 (Not Modified) is returned.
If-None-Match
string Yes Contains an ETag response header sent by the server in a previous request to the same URL. If the ETag is still valid for the specified resource, HTTP response code 304 (Not Modified) is returned.
Output
Content Type: application/atom+xml
Code Description
200
OK. Indicates that the comment was successfully found and returned. If an error occurs, this header will contain one of the error codes below.
401
Unauthorized.
404
Not Found.