> CommCell Console > Tools & Utilities > Developer Tools > REST API > REST API Reference > Discussion Operations on a Share

View Number of Replies for a Comment on a Shared File (REST API: GET)

This operation retrieves the number of replies for a comment on a file in a shared folder or on a shared file.

Request

Syntax
GET webservice/ShareFolder/shareId/file/fileGuid/Discussion/discussionId/Comment/commentId/Replies?depth=depth 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

fileguid

The GUID of the file. 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

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

Depth

The number of levels of replies that you want to list.

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

Response Parameters

Parameter

Description

Element

depth

The number of levels of replies for the comment.

comments

nbReplies

Number of replies for the comment.

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

Domainname/username of the user who added the comment.

owner

userId

Unique ID for the user.

owner

Examples

Sample Request
GET webservice/ShareFolder/677439/file/176ebc59e06a47d7af86b5f98cc20b16/Discussion/16/Comment/18/Replies?depth=1 HTTP/1.1
 Host: client.mydomain.com
 Accept: application/xml
 Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc60f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef768fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f3233d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
 NBREPLIES:4
Sample Response
XML
<Api_CommentsOperationResp>
     <comments depth="0" nbReplies="0" discussionId="16" created="1503344084" commentId="18" modified="1503419650" content="revised text">
         <owner newName="user1" userName="mydomain\user1" userId="1096" />
     </comments>
 </Api_CommentsOperationResp>
JSON
{
   "comments": [
     {
       "depth": 0,
       "nbReplies": 0,
       "discussionId": 16,
       "created": 1504879761,
       "commentId": 18,
       "modified": 1504880895,
       "owner": {
         "newName": "user1",
         "userName": "domainname\\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.
×

Loading...