TRY NEW VERSION

Try now New API BETA

Try out the new view and capabilities of the API documentation

START

POST api/2.0/project/comment This function requires authentication

Description

Adds a project comment with the parameters specified in the request. The parent comment ID can also be selected.

Parameters
Name Description Type Example
parentcommentid
sent in body
Parent comment ID string some text
entityid
sent in body
Entity ID number 1234
content
sent in body
Comment text string some text
type
sent in body
Comment type (message or task) string some text
Example
POST api/2.0/project/comment
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

{
  "parentcommentid": "some text",
  "entityid": 1234,
  "content": "some text",
  "type": "some text"
}
Returns

Comment information

Example Response

application/json

{
  "status": 0,
  "response": {
    "commentID": "12261949-db62-43c2-b956-91e12c412d5a",
    "userID": "15985c13-ad91-4f2c-9286-cf991448e796",
    "userPost": null,
    "userFullName": "Administrator",
    "userProfileLink": "\\/Products\\/People\\/Profile.aspx?user=administrator",
    "userAvatarPath": "\\/skins\\/default\\/images\\/default_user_photo_size_82-82.png",
    "commentBody": "das\\u000a",
    "inactive": false,
    "isRead": true,
    "isEditPermissions": true,
    "isResponsePermissions": true,
    "timeStampStr": "15:39 Today",
    "commentList": null,
    "attachments": null
  }
}

text/xml

<result>
  <status>0</status>
  <response>
    <commentID>12261949-db62-43c2-b956-91e12c412d5a</commentID>
    <userID>15985c13-ad91-4f2c-9286-cf991448e796</userID>
    <userPost />
    <userFullName>Administrator</userFullName>
    <userProfileLink>\/Products\/People\/Profile.aspx?user=administrator</userProfileLink>
    <userAvatarPath>\/skins\/default\/images\/default_user_photo_size_82-82.png</userAvatarPath>
    <commentBody>das\u000a</commentBody>
    <inactive>False</inactive>
    <isRead>True</isRead>
    <isEditPermissions>True</isEditPermissions>
    <isResponsePermissions>True</isResponsePermissions>
    <timeStampStr>15:39 Today</timeStampStr>
    <commentList />
    <attachments />
  </response>
</result>