Sign in
Process Instance Comment

Get Process Instance Comments

Gets the comments for a process instance by id.

get/process-instance/{id}/comment

Request

  • Base URL: http://localhost:8080/engine-rest
  • URL: http://localhost:8080/engine-rest/process-instance/{id}/comment
  • Auth: HTTP basic

Path parameters

idstring required

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

Response

Request successful.

idstring nullable

The id of the task comment.

userIdstring nullable

The id of the user who created the comment.

taskIdstring nullable

The id of the task to which the comment belongs.

processInstanceIdstring nullable

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

timestring date-time nullable

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

messagestring nullable

The content of the comment.

removalTimestring date-time nullable

The time after which the comment should be removed by the History Cleanup job. Default format yyyy-MM-dd'T'HH:mm:ss.SSSZ.

rootProcessInstanceIdstring nullable

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

Changes

No recorded changes to this operation across all 1 revision of this API.