REST API - Comment - Process Instance Id - GET

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

Request

Format 
GET <baseurl>/audit/comment/proc_inst/<reference>
Path Parameters reference: identify the instance ID whose comments you want to retrieve. Can be obtained from listProcessInstances, queryProcessInstances or queryProcessInstancesAlt.
Query Parameters
  • requireallattributes=string (optional, default=false). Whether all attributes should be returned. Can be obtained from getAllAttributes or getAttributes. The default is false.
  • requiredattribute=string (optional). Specific attributes that should be returned for each event found. Can be obtained from getAllAttributes or getAttributes.
  • sortorder=string (0-n, optional): What attribute or attributes the results should be sorted on, and in what direction the sort should run. Specify this in the following format: 
    attribute 1:ASCENDING|DESCENDING;attribute 2:ASCENDING|DESCENDING; … attribute n:ASCENDING|DESCENDING
  • gettotalcount=string (optional, default=true). Whether to include a count of the total number of events in the list. The count is returned in the totalItems value in the response. You should set getTotalCount to false unless you specifically need the total figure, because setting it to true is expensive in terms of database access time. Note that:
    • If you pass false in this attribute, and there is at least one item in the list, the totalItems value returned in the response is -1. However, if you pass false and there are no work items in the list, the totalItems value in the response is 0 (zero).
    • If you pass true in this attribute but numberOfItems is set to zero, the totalItems value in the response is 0 regardless of how many items are actually in the list. The total count of items is only available when you are fetching one or more items.
  • numberofitems=integer (optional, default=-1). The maximum number of events to return. Specifying -1 returns all events for the process instance.
  • populateattributenames=string (optional). Specify that attribute names be returned in the list of events.
  • startposition=integer (optional, default=-1). The position in the list from which to start the page of results. The list is zero-based. To start at the first item, specify 0.

Response

JSON Returns a JSON representation of the content of the getCommentAuditResponse element.
XML Returns the content of the getCommentAuditResponse element (from the EventCollectorReportService schema).

Example

Request 
GET <baseurl>/audit/comment/proc_inst/pvm:0a123
Response 
{
    "xml-fragment": {
        "endPosition": 1,
        "startPosition": 0,
        "totalItems": 1,
        "reference": {
            "processInstanceRef": {
                "instanceId": "pvm:0a123"
            }
        },
        "comment": {
            "id": 1684,
            "creationTime": "2016-03-21T11:50:27.137Z",
            "componentId": "EC",
            "messageId": "EC_COMMENT_PI",
            "severity": "AUDIT",
            "message": "ProcessInstance Comment",
            "priority": "MEDIUM",
            "correlationId": "e25100b7-b44c-4fd7-862a-2725197724bf",
            "contextId": "e25100b7-b44c-4fd7-862a-2725197724bf",
            "messageCategory": "PROCESS_INSTANCE",
            "principalId": "tibco-admin",
            "principalName": "tibco-admin",
            "managedObjectId": "pvm:0a123",
            "managedObjectType": "AUDIT_COMMENT",
            "managedObjectVersion": -1,
            "extendedMessage": "This is a claim.",
            "children": {
                "comment": {
                    "id": 1685,
                    "creationTime": "2016-03-21T11:52:16.783Z",
                    "componentId": "EC",
                    "messageId": "EC_COMMENT_PI",
                    "severity": "AUDIT",
                    "message": "ProcessInstance Comment",
                    "priority": "MEDIUM",
                    "correlationId": "a1ae20a2-ffe3-427b-9a83-f6e3fd2556eb",
                    "contextId": "a1ae20a2-ffe3-427b-9a83-f6e3fd2556eb",
                    "messageCategory": "PROCESS_INSTANCE",
                    "principalId": "tibco-admin",
                    "principalName": "tibco-admin",
                    "managedObjectId": "pvm:0a123",
                    "managedObjectType": "AUDIT_COMMENT",
                    "managedObjectVersion": 1684,
                    "extendedMessage": "This is also a claim.",
                    "children": {
                        "comment": {
                            "id": 1686,
                            "creationTime": "2016-03-21T12:05:08.923Z",
                            "componentId": "EC",
                            "messageId": "EC_COMMENT_PI",
                            "severity": "AUDIT",
                            "message": "ProcessInstance Comment",
                            "priority": "MEDIUM",
                            "correlationId": "15e15bd3-e67b-494a-88e0-ea8f29ee3b9a",
                            "contextId": "15e15bd3-e67b-494a-88e0-ea8f29ee3b9a",
                            "messageCategory": "PROCESS_INSTANCE",
                            "principalId": "tibco-admin",
                            "principalName": "tibco-admin",
                            "managedObjectId": "pvm:0a123",
                            "managedObjectType": "AUDIT_COMMENT",
                            "managedObjectVersion": 1685,
                            "extendedMessage": "This is also a claim too."
                        }
                    }
                }
            }
        }
    }
}