Create a Discussion on a Shared File (REST API: POST)

This operation creates a new discussion on a file in a shared folder or on a shared file.

Request

Syntax

Send the request using either XML or JSON:

XML

POST webservice/ShareFolder/shareId/file/fileguid/Discussion HTTP/1.1
Host: host name
Accept: application/xml
Authtoken: authentication token
 Content-type: application/xml
 <comments>
     <content></content>
 </comments>

JSON

POST webservice/ShareFolder/shareId/Discussion HTTP/1.1
Host: host name
Accept: application/xml
Authtoken: authentication token
 Content-type: application/json
 { 
  "comments":[ 
      { "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
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
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

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

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

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.
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 comment text that you want to add.	comments

Response

Response Parameters

Parameter	Description	Element
entityType	The ID of the entity type. For example, 136 for file 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
commentId	The unique ID of the comment that you added to the discussion.	comments
content	The comment text.	comments

Examples

Sample Request

XML

To create a new discussion with a comment.

POST webservice/ShareFolder/677439/file/145f25d50f1a4dcf9a09b0df393336a2/Discussion HTTP/1.1
 Host: client.mydomain.com
 Accept: application/xml
 Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc60f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef768fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f3233d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
 Content-type: application/xml
 <comments>
     <content>new discussion</content>
 </comments>

JSON

To create a new discussion with a comment.

POST webservice/ShareFolder/677439/file/145f25d50f1a4dcf9a09b0df393336a2/Discussion HTTP/1.1
 Host: client.mydomain.com
 Accept: application/json
 Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc60f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef768fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f3233d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
 Content-type: application/json
 { 
  "comments":[ 
      { "content":"new discussion"
      } 
     ] 
  }

Sample Response

XML

<?xml version="1.0" encoding="UTF-8" ?>
 <discussion>
     <entityType>136</entityType>
     <discussionId>5</discussionId>
     <created>1503347511</created>
     <entityGUID>145f25d50f1a4dcf9a09b0df393336a2</entityGUID>
     <modified>1503347511</modified>
     <nbComments>1</nbComments>
     <status>1</status>
     <owner>
         <newName>user1</newName>
         <userName>mydomain\user1</userName>
         <userId>1096</userId>
     </owner>
     <comments>
         <depth>0</depth>
         <nbReplies>0</nbReplies>
         <discussionId>5</discussionId>
         <created>1503347511</created>
         <commentId>8</commentId>
         <modified>1503347511</modified>
         <content>New discussion</content>
         <owner>
             <newName>user1</newName>
             <userName>mydomain\user1</userName>
             <userId>1096</userId>
         </owner>
     </comments>
 </discussion>
 <error />

JSON

{
   "discussion": {
     "entityType": 136,
     "discussionId": 5,
     "created": 1504730412,
     "entityGUID": "f21b5cbb281a42459944b8eb2f90c6f5",
     "modified": 1504730412,
     "nbComments": 1,
     "status": 1,
     "owner": {
       "newName": "user1",
       "userName": "mydomain\user1",
       "userId": 2855
     },
     "comments": [
       {
         "depth": 0,
         "nbReplies": 0,
         "discussionId": 5,
         "created": 1504730412,
         "commentId": 8,
         "modified": 1504730412,
         "content": "new discussion",
         "owner": {
           "newName": "user1",
           "userName": "mydomain\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.

Create a Discussion on a Shared File (REST API: POST)

Request

Syntax

Request Parameters

Request Headers

Request Body

Response

Response Parameters

Examples

Sample Request

XML

JSON

Sample Response

XML

JSON

Supported Error Codes

Page contents