Update a comment 

Update the Atom document representation of the comment associated with a file.

This method replaces the current comment Atom document. To find out how to first retrieve the comment that you want to update, see Retrieve a comment.

You must authenticate this request.

Table 1. Atom API request details

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

• {userid} is the value of the <snx:userid> of the person who owns the file. See Search 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, also provide the identifier=label parameter as part of the request.

You can use this input parameter with the PUT request.

Table 2. Input parameters

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

You can provide the comment as an Atom entry document or as plain text in the request header.

• To add the comment using an Atom entry document, provide the following input:

  • Content-Type: application/atom+xml

  • Content-Length: <length-of-xml-message/>

  • Request body: atom entry element

• To add the comment using plain text, provide the following input:

  • Content-Type: text/plain

  • Content-Length: <length-of-request-body/>

  • Request body: the comment in plain text

Output

An updated comment Atom entry document.

Returned HTTP headers

HTTP/1.1 204 No Content

Indicates that the comment was successfully updated. If an error occurs, this header contains one of the error codes.

Error codes

• HTTP/1.1 401 Unauthorized

• HTTP/1.1 404 Not Found Can occur if you specify the document ID using the document label, but do not provide the identifier parameter to indicate that you are using the label as the identifier.

Parent topic

Work with comments

Related reference
Search Profiles programmatically
Files comment content

   

 

});

+

Search Tips   |   Advanced Search