Delete a Comment on a Shared Folder (REST API: DELETE)

This operation deletes a comment on a shared folder, based on the discussion and comment IDs.

Request

Syntax

DELETE webservice/ShareFolder/shareId/Discussion/discussionId/Comment/commentId HTTP/1.1
 Accept: application/xml
Host: host name
Authtoken: authentication token

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
shareId	The unique identifier (syncWebFolderId response) returned when you share a file or folder or view the shared files and folders in the ObjectStore. Provide the shareId of the shared folder. For details on retrieving the syncWebFolderId response, see Viewing Shared Files and Folders.	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

Name

Description

Required

shareId

The unique identifier (syncWebFolderId response) returned when you share a file or folder or view the shared files and folders in the ObjectStore. Provide the shareId of the shared folder.

For details on retrieving the syncWebFolderId response, see Viewing Shared Files and Folders.

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 the Command Center 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.

Response Parameters

Parameter	Description	Element
errorCode	The possible error codes. Valid values are: 0, successful completion. 2, a failure. a specific error code.	App_GenericResp
errorMessage	The description of the error code. Not all error codes have an error message.	App_GenericResp

Parameter

Description

Element

errorCode

The possible error codes.

Valid values are:

0, successful completion.
2, a failure.
a specific error code.

App_GenericResp

errorMessage

The description of the error code. Not all error codes have an error message.

App_GenericResp

Examples

Sample Request

DELETE webservice/ShareFolder/403990/Discussion/4/Comment/7 HTTP/1.1
 Host: client.mydomain.com
 Accept: application/xml
 Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc60f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef768fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f3233d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

Sample Response

XML

<Api_CommentOperationResp />

JSON

{
 "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.