Skip to main content
PUT
/
process-instance
/
{id}
/
comment
Update
curl --request PUT \
  --url http://{host}:{port}/{contextPath}/process-instance/{id}/comment \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "75bc161a-12da-11e4-7d3a-f4ccdc10a445",
  "message": "a process instance comment"
}
'
{
  "type": "<string>",
  "message": "<string>",
  "code": 123
}

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 associated of a process instance of a comment to be updated.

Body

application/json

Note: Only the id and message 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 [blocked] 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 [blocked] 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.