This operation creates a new discussion for a file or folder in Edge Drive.
Request
Syntax
Send the request using either XML or JSON:
XML
POST <webservice>/drive/file/{fileOrfolderId}/Discussion HTTP/1.1
Host: <host name>
Accept: application/xml
Authtoken: <authentication token>
Content-type: application/xml
<entityGUID></entityGUID> <comments> <content></content> </comments>JSON
POST <webservice>/drive/file/{fileOrfolderId}/Discussion HTTP/1.1
Host: <host name>
Accept: application/xml
Authtoken: <authentication token>
Content-type: application/json
{
"entityGUID":"{{$guid}}",
"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 |
|---|---|---|
fileOrfolderId | The GUID of the file or folder for which you want to create a discussion. To retrieve the GUID of the file or folder, see View Properties of a File or Folder. | 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. |
Request Body
An XML element is required. See Syntax. The following table displays the parameters for the request body.
Name | Description | Elements |
GUID | The GUID of the file or folder for which you want to create a discussion. To retrieve the GUID of the file or folder, see View Properties of a File or Folder. | entityGUID |
content | The discussion text that you want to add. | comments |
Response
Response Parameters
Parameter | Description | Element |
entityType | The ID of the file entity type. For example, 136 for file 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>/drive/file/b495924eabbb4d9cbb90cdd91d86e620/Discussion HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Content-type: application/xml
<entityGUID>b495924eabbb4d9cbb90cdd91d86e620</entityGUID> <comments> <content>New discussion</content> </comments>JSON
To create a new discussion with a comment.
POST <webservice>/drive/file/b495924eabbb4d9cbb90cdd91d86e620/Discussion HTTP/1.1
Host: client.mydomain.com
Accept: application/json
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Content-type: application/json
{
"entityGUID":"{{b495924eabbb4d9cbb90cdd91d86e620}}",
"comments":[
{ "content":"New discussion"
}
]
}Sample Response
XML
<?xml version="1.0" encoding="UTF-8" ?> <discussion> <entityType>136</entityType> <discussionId>17</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>17</discussionId> <created>1503347511</created> <commentId>21</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": 20,
"created": 1503435401,
"entityGUID": "6eaf968caa5145dcaf17508d4cf0c454",
"modified": 1503435401,
"nbComments": 2,
"status": 1,
"owner": {
"newName": "user1",
"userName": "mydomain\user1",
"userId": 1096
},
"comments": []
},
"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. |