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/task/{taskid}/comment This function requires authentication

Description

Adds a comment to the selected task with the comment text and parent comment ID specified in the request.

Parameters
Name Description Type Example
taskid
sent in url
Task ID number 1234
content
sent in body
Comment text string some text
parentid
sent in body
Parent comment ID guid 9924256A-739C-462b-AF15-E652A3B1B6EB
Example
POST api/2.0/project/task/1234/comment
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

{
  "content": "some text",
  "parentid": "9924256A-739C-462b-AF15-E652A3B1B6EB"
}
Returns

List of comments

Example Response

application/json

{
  "status": 0,
  "response": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "CreatedBy": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "DisplayName": "Mike Zanyatski",
      "Title": "Manager",
      "AvatarSmall": "url to small avatar",
      "ProfileUrl": "\\/Products\\/People\\/Profile.aspx?user=administrator"
    },
    "Text": "comment text",
    "ParentId": "00000000-0000-0000-0000-000000000000",
    "Inactive": false,
    "CanEdit": false,
    "Created": "2020-12-22T04:11:56.5008512Z",
    "Updated": "2020-12-22T04:11:56.5008512Z"
  }
}

text/xml

<result>
  <status>0</status>
  <response>
    <Id>00000000-0000-0000-0000-000000000000</Id>
    <CreatedBy>
      <Id>00000000-0000-0000-0000-000000000000</Id>
      <DisplayName>Mike Zanyatski</DisplayName>
      <Title>Manager</Title>
      <AvatarSmall>url to small avatar</AvatarSmall>
      <ProfileUrl>\/Products\/People\/Profile.aspx?user=administrator</ProfileUrl>
    </CreatedBy>
    <Text>comment text</Text>
    <ParentId>00000000-0000-0000-0000-000000000000</ParentId>
    <Inactive>False</Inactive>
    <CanEdit>False</CanEdit>
    <Created>2020-12-22T04:11:56.5008512Z</Created>
    <Updated>2020-12-22T04:11:56.5008512Z</Updated>
  </response>
</result>