Edit a Comment on a Client Computer (REST API: PUT)

This operation edits a comment for an existing discussion on a backed up file or folder on a client computer.

Request

Syntax

Send the request using either XML or JSON:

XML

PUT webservice/Subclient/subclientId/file/fileGuid/Discussion/discussionId/Comment/commentId HTTP/1.1
Host: host name
Accept: application/xml
Authtoken: authentication token
Content-type: application/xml
 <comments>
     <content></content>
 </comments>

JSON

PUT webservice/Subclient/subclientId/file/fileGuid/Discussion/discussionId/Comment/commentId HTTP/1.1
Host: host name
Accept: application/xml
Authtoken: authentication token
Content-type: application/json
 {  "content": 
 }

where <webservice> is the root path used to route the API requests to the Web Server.

For more information, see Available Web Services for REST API.

Request Parameters

Name	Description	Required
fileguid	The GUID of the file or folder. GUID is a unique identifier for a file or folder and remains the same even when you rename or move the file or folder to another path. To retrieve the GUID of the file, see View Shared Files and Folders .	Yes
subclientId	The subclient ID for the subclient that was backed up. If the subclient ID is not known, use the GET Subclient API to retrieve it.	Yes
discussionId	The unique ID of the discussion. To retrieve the discussion ID, see View Details of a Discussion.	Yes
commentId	The unique ID of the comment. To retrieve the comment ID, see View Details of a Discussion.	Yes

Request Headers

Name	Description
Host	The host name of the Web Server or Web Console used in the API request.
Accept	The format of the response. Valid values are: application/xml or application/json.
Authtoken	The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication.
Content-type	The media type contained in the request body.

Request Body

An XML element is required. See Syntax. The following table displays the parameters for the request body.

Name	Description	Elements
content	The revised comment text that you want to add.	comments

Response

Response Parameters

Parameter	Description	Element
depth	The level at which the comment was added. For new discussion, the comment level is 0.	comments
nbReplies	Number of replies for the discussion.	comments
discussionId	The unique ID for the discussion.	comments
created	The date and time when the comment was created, specified in Unix time stamp format.	comments
modified	The date and time when the comment was last modified, specified in Unix time stamp format.	comments
commentId	The unique ID of the comment that you edited.	comments
newName	Name of the user entity.	owner
userName	Domain/username of the user who created the discussion.	owner
userId	Unique ID for the user.	owner

Examples

Sample Request

XML

To edit an existing comment.

PUT webservice/Subclient/1234/file/145f25d50f1a4dcf9a09b0df393336a2/Discussion/10/Comment/17 HTTP/1.1
 Host: client.mydomain.com
 Accept: application/xml
 Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc60f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef768fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f3233d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
 Content-type: application/xml
 <comments>
     <content>"Edited Comment"</content>
 </comments>

JSON

To edit an existing comment.

PUT webservice/Subclient/1234/file/145f25d50f1a4dcf9a09b0df393336a2/Discussion/10/Comment/17 HTTP/1.1
Host: client.mydomain.com
Accept: application/json
 Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc60f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef768fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f3233d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Content-type: application/json
 {  "content":"Edited comment"
 }

Sample Response

XML

<Api_CommentOperationResp>
     <comment depth="0" nbReplies="0" discussionId="10" created="1503344084" commentId="17" modified="1503419379">
         <owner newName="user1" userName="mydomain\user1" userId="1096" />
     </comment>
     <error />
 </Api_CommentOperationResp>

JSON

{
   "comment": {
     "depth": 0,
     "nbReplies": 0,
     "discussionId": 10,
     "created": 1504879761,
     "commentId": 17,
     "modified": 1504879761,
     "owner": {
       "newName": "user1",
       "userName": "domainname\\user1",
       "userId": 1096
     }
   },
   "error": {}
 }

Supported Error Codes

Code	Status	Description
400	Bad Request	The request is missing required parameters.
401	Unauthorized	The request did not include an authentication token or the authentication token was expired.
403	Forbidden	The user did not have permission to access the requested resource.
412	Precondition Failed	Prerequisites are not met. For example, MongoDB database is not installed.