REST API - comment - Process Instance Id

This table summarizes the REST API - comment - process instance Id.

Request

Format
POST <baseurl>/audit/comment/proc_inst/<procid>
Path Parameters procid: identifies the process instance whose events you want to audit. Can be obtained from listProcessInstances, queryProcessInstances or queryProcessInstancesAlt.
Query Parameters parentid: (Optional): The audit ID returned in the CommentResponse element in response to a previous request.
Body comment element (required): This element (from the EventCollectorUpdateService schema defines the chart query.

Response

JSON Returns a JSON representation of the content of the CommentResponse element.
XML Returns the content of the CommentResponse element (from the EventCollectorUpdateService schema).

Example

Request
POST <baseurl>/audit/comment/proc_inst/pvm:0a123
Request Body
{
  "Comment": { "message": "This is a process instance" }
}
Response
1686