Comment
The comment operation allows a comment to be stored against any process instance, work item or case object. You can use these comments to create a custom audit trail, for example.
You can also store named attribute/value pairs against a comment. This enables you to set additional data when adding a comment. For example, a user id or version number.
The response returns an audit ID for the comment. You can use the audit ID in the parentCommentId parameter in a comment request. This allows you to create a hierarchical view of comments for a BPM process instance, work item or case.
Depending on your requirements, comments can be retrieved using the getProcessInstanceAudit, getWorkItemAudit and getCaseAudit APIs or, alternatively, you can return comments for a specific BPM process instance, work item or case, using getCommentAudit. Finally, you can use the comments functions to return comments for a specific BPM process instance, work item or case. See Functions.
- The request must identify the process instance, work item or case against which to store the comment, the comment to be stored, and any options for the comment.
- The response returns the audit ID of the comment.
- Required System Action
- queryAudit.