Loading...

View Details of a Discussion on a Shared Folder (REST API: GET)

This operation retrieves the details of a discussion on a shared folder.

Request

Syntax

GET <webservice>/ShareFolder/{shareId}/Discussion?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

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 comments or replies for the 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.

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

entityType

The ID of the entity type. For example, 7987 for share folder entity type.

discussion

discussionId

The unique ID for the discussion.

discussion

created

The date and time when the discussion was created, specified in Unix time stamp format.

discussion

entityGUID

The GUID of the file or folder.

discussion

modified

The date and time when the discussion was last modified, specified in Unix time stamp format.

discussion

nbComments

Number of comments for the discussion

discussion

status

Status 1 indicates that the discussion is enabled.

discussion

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

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

Examples

Sample Request

GET <webservice>/ShareFolder/403990/Discussion?depth=2 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_DiscussionOperationResp>
    <discussion entityType="7987" discussionId="4" created="1504724390" entityGUID="d9122dab95304f2fa25841de6592c32f" modified="1504724390" nbComments="1" status="1">
        <owner newName="user1" userName="domainname\user1" userId="2855" />
        <comments depth="0" nbReplies="0" discussionId="4" created="1504724390" commentId="7" modified="1504724390" content="new discussion5">
            <owner newName="user1" userName="domainname/user1" userId="2855" />
        </comments>
    </discussion>
    <error />
</Api_DiscussionOperationResp>

JSON

{
  "discussion": {
    "entityType": 7987,
    "discussionId": 4,
    "created": 1504724390,
    "entityGUID": "d9122dab95304f2fa25841de6592c32f",
    "modified": 1504724390,
    "nbComments": 1,
    "status": 1,
    "owner": {
      "newName": "user1",
      "userName": "domainname\\user1",
      "userId": 2855
    },
    "comments": [
      {
        "depth": 0,
        "nbReplies": 0,
        "discussionId": 4,
        "created": 1504724390,
        "commentId": 7,
        "modified": 1504724390,
        "content": "new discussion5",
        "owner": {
          "newName": "user1",
          "userName": "domainname\\user1",
          "userId": 2855
        }
      }
    ]
  },
  "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.

Last modified: 1/10/2018 4:32:49 PM