Skip to main content
GET
/
task
/
{id}
/
comment
Get List
curl --request GET \
  --url http://{host}:{port}/{contextPath}/task/{id}/comment \
  --header 'Authorization: Basic <encoded-value>'
[
  {
    "id": "commentId",
    "userId": "userId",
    "taskId": "aTaskId",
    "processInstanceId": "96dc383f-23eb-11e6-8e4a-f6aefe19b687",
    "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": "96dc383f-23eb-11e6-8e4a-f6aefe19b687",
    "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": "96dc383f-23eb-11e6-8e4a-f6aefe19b687",
    "time": "2013-04-21T10:15:23.764+0200",
    "message": "yetAnotherMessage",
    "removalTime": "2018-02-10T14:33:19.000+0200",
    "rootProcessInstanceId": "aRootProcessInstanceId"
  }
]

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

​
id
string
required

The id of the task to retrieve the comments for.

Response

Request successful.

​
id
string | null

The id of the task comment.

​
userId
string | null

The id of the user who created the comment.

​
taskId
string | null

The id of the task to which the comment belongs.

​
processInstanceId
string | null

The id of the process instance the comment is related to.

​
time
string<date-time> | null

The time when the comment was created. Default format yyyy-MM-dd'T'HH:mm:ss.SSSZ.

​
message
string | null

The content of the comment.

​
removalTime
string<date-time> | null

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 | null

The process instance id of the root process instance that initiated the process containing the task.

​
links
object[] | null

The links associated to this resource, with method, href and rel.