This operation retrieves the details of a comment for a file or folder in Edge Drive, based on the discussion and comment IDs.
Request
Syntax
GET <webservice>/drive/file/{fileGuid}/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 |
---|---|---|
fileOrfolderId | The GUID of the file or folder for which you want to view the comment. To retrieve the GUID of the file or folder, see View Properties of a File or Folder. | 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. |
PAGE-SIZE | The size of each page in the response. Default value is 2147483647 |
SORT-DIRECTION | The sort order of the response. Valid values are 0 or descending, and 1 or ascending. |
NBREPLIES | Number of replies you want to view for the discussion. |
LAST-COMMENT-ID | The commentId of the last comment in the discussion. If the SORT-DIRECTION is 0, you must add the LAST-COMMENT-ID header. |
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 |
content | The comment text. | 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
GET <webservice>/drive/file/6eaf968caa5145dcaf17508d4cf0c454/Discussion/16/Comment/18 HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
PAGE-SIZE: 20
SORT-DIRECTION: 0
NBREPLIES:4
LAST-COMMENT-ID:123456
Sample Response
XML
<Api_CommentOperationResp>
<comment depth="0" nbReplies="0" discussionId="16" created="1503344084" commentId="18" modified="1503419650" content="revised text">
<owner newName="user1" userName="mydomain\user1" userId="1096" />
</comment>
</Api_CommentOperationResp>
JSON
{
"comment": {
"depth": 0,
"nbReplies": 0,
"discussionId": 16,
"created": 1503344084,
"commentId": 18,
"modified": 1503419650,
"content": "revised text",
"owner": {
"newName": "user1",
"userName": "mydomain\\user1",
"userId": 1096
}
}
}
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. |