Get Task Comment

Retrieves a task comment by task id and comment id.

Method

GET /task/{id}/comment/{commentId}

Parameters

Path Parameters

Name Description
id The id of the task.
commentId The id of the comment to be retrieved.

Result

A JSON object corresponding to the Comment interface in the engine. Its properties are as follows:

Name Value Description
id String The id of the task comment.
userId String The id of the user who created the comment.
taskId String The id of the task to which the comment belongs.
processInstanceId String The id of the process instance the comment is related to.
time Date The time when the comment was created.
message String The content of the comment.
removalTime String The time after which the comment should be removed by the History Cleanup job. Default format* yyyy-MM-dd'T'HH:mm:ss.SSSZ.
rootProcessInstanceId String The process instance id of the root process instance that initiated the process containing the task.

Response Codes

Code Media type Description
200 application/json Request successful.
404 application/json The task or comment with given task and comment id do not exist, or the history of the engine is disabled. See the Introduction for the error response format.

Example

Request

GET /task/aTaskId/comment/aTaskCommentId

Response

{
  "id": "aTaskCommentId",
  "userId": "userId",
  "taskId": "aTaskId",
  "processInstanceId": "96dc383f-23eb-11e6-8e4a-f6aefe19b687",
  "time": "2013-01-02T21:37:03.664+0200",
  "message": "comment content",
  "removalTime":"2018-02-10T14:33:19.000+0200",
  "rootProcessInstanceId": "aRootProcessInstanceId"
}

On this Page: