Gets the comments for a process instance by id.

Method

GET /process-instance/{id}/comment

Parameters

Path Parameters

Name	Description
id	The id of the process instance to retrieve the comments for.

Result

A JSON object containing a list of task comments.

Name	Type	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	No process instance exists for the given process instance id. See the Introduction for the error response format.

Example

Request

GET /process-instance/aProcessInstanceId/comment

Response

[
  {
    "id": "commentId",
    "userId": "userId",
    "taskId": "aTaskId",
    "processInstanceId": "aProcessInstanceId",
    "time": "2013-01-02T21:37:03.764+0200",
    "message": "message",
    "removalTime":"2018-02-10T14:33:19.000+0200",
    "rootProcessInstanceId": "aRootProcessInstanceId"
  },
  {
    "id": "anotherCommentId",
    "userId": "anotherUserId",
    "taskId": "aTaskId",
    "processInstanceId": "aProcessInstanceId",
    "time": "2013-02-23T20:37:43.975+0200",
    "message": "anotherMessage",
    "removalTime":"2018-02-10T14:33:19.000+0200",
    "rootProcessInstanceId": "aRootProcessInstanceId"
  },
  {
    "id": "yetAnotherCommentId",
    "userId": "yetAnotherUserId",
    "taskId": "aTaskId",
    "processInstanceId": "aProcessInstanceId",
    "time": "2013-04-21T10:15:23.764+0200",
    "message": "yetAnotherMessage",
    "removalTime":"2018-02-10T14:33:19.000+0200",
    "rootProcessInstanceId": "aRootProcessInstanceId"
  }
]