Retrieve a file comment 

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.

Table 1. Atom API request details

Method URI Output representation Description
GET /basic/api/userlibrary/{userid}/document/{document-id}/comment/{comment-id}/entry comment Atom document Returns a comment from someone else's file.
GET /basic/api/myuserlibrary/document/{document-id}/comment/{comment-id}/entry comment Atom document Returns a comment from one of your files.

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

Table 2. Input headers

Parameter Description
If-Modified-Since 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 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.

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

Table 3. Input parameters

Parameter Description
acls 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 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.


Input

None.


Output

An Atom entry document containing the comment.

Returned HTTP headers

HTTP/1.1 200 OK

Content-Type: application/atom+xml

Error codes


Parent topic

Work with comments

Related reference
Search Profiles programmatically
Files comment content


   

 

});