Skip to main content
POST
/
task
/
{id}
/
comment
/
create
Create
curl --request POST \
  --url http://{host}:{port}/{contextPath}/task/{id}/comment/create \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "message": "a task comment",
  "processInstanceId": "96dc383f-23eb-11e6-8e4a-f6aefe19b687"
}'
{
  "links": [
    {
      "method": "GET",
      "href": "http://localhost:38080/rest-test/task/aTaskId/comment/aTaskCommentId",
      "rel": "self"
    }
  ],
  "id": "aTaskCommentId",
  "userId": "userId",
  "taskId": "aTaskId",
  "processInstanceId": "96dc383f-23eb-11e6-8e4a-f6aefe19b687",
  "time": "2013-01-02T21:37:03.887+0200",
  "message": "comment message",
  "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 add the comment to.

Body

application/json

Note: Only the message and processInstanceId properties will be used. Every other property passed to this endpoint will be ignored.

​
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.

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.