SOAP API - getCommentAudit

The table summarizes the SOAP API - getCommentAudit.

Request Uses the getCommentAuditRequest element (from the EventCollectorReportService schema).
Parameter notes
  • caseReference: Must be of one of the following:
    • caseRef: Must be one of the following:
      • reference: The reference to the case object. You can obtain case references using findAllCases.
      • caseDetails: Must consist of:
        • className: The fully qualified name of the case class. For example, com.example.gddemo.Car. You can obtain class names by using getCaseClassInfo.
        • modelVersion: The version number of the case model. For example, 2 or 2.0.0.
        • managedObjectId: The case model ID. For example, 1.
    • processInstanceRef: identifies the process instance ID whose events you want to audit. Can be obtained from listProcessInstances, queryProcessInstances or queryProcessInstancesAlt.
    • workItemRef: Must be:
      • idReference: identify the work item whose events you want to audit. Can be obtained from getWorkListItems.
      • fullReference: is not supported.
  • getTotalCount: (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 (Optional, default=-1): the maximum number of events to return. Specifying -1 returns all events for the process instance, work item or case.
  • populateAttributeNames (Optional, default=true): Specifies that attribute names be returned in the list of events.
  • startPosition (Optional, default=0): 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.
  • advancedOption (Optional). This is for internal use only and should not be used.
  • requireAllAttributes (Optional, default=false): Whether all attributes should be returned.
  • requiredAttribute (Optional): Specific attributes that should be returned for each event found.
  • sortOrder (Optional): Specifies the sort order of the attribute.
  • Version (Optional): The version of the API you want to execute against.
Response Returns a getCommentAuditResponse element (from the EventCollectorReportService schema).
Example Request: 
<soapenv:Body>
      <api:getCommentAuditRequest>
         <base:CommentReference>
            <processInstanceRef>
               <instanceId>pvm:0a123</instanceId>
            </processInstanceRef>
         </base:CommentReference>
         <base:CommentReportOptions>
         </base:CommentReportOptions>
      </api:getCommentAuditRequest>
   </soapenv:Body>
  Response: 
<SOAP-ENV:Body>
      <getCommentAuditResponse xmlns="http://api.ec.n2.tibco.com">
         <CommentAudit xmlns="http://base.api.ec.n2.tibco.com">
            <endPosition xmlns="">1</endPosition>
            <startPosition xmlns="">0</startPosition>
            <totalItems xmlns="">1</totalItems>
            <reference xmlns="" xmlns:api="http://api.ec.n2.tibco.com" xmlns:base="http://base.api.ec.n2.tibco.com" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
               <processInstanceRef>
                  <instanceId>pvm:0a123</instanceId>
               </processInstanceRef>
            </reference>
            <comment xmlns="">
               <id>1684</id>
               <creationTime>2016-03-21T11:50:27.137Z</creationTime>
               <componentId>EC</componentId>
               <messageId>EC_COMMENT_PI</messageId>
               <severity>AUDIT</severity>
               <message>ProcessInstance Comment</message>
               <priority>MEDIUM</priority>
               <correlationId>e25100b7-b44c-4fd7-862a-2725197724bf</correlationId>
               <contextId>e25100b7-b44c-4fd7-862a-2725197724bf</contextId>
               <messageCategory>PROCESS_INSTANCE</messageCategory>
               <principalId>tibco-admin</principalId>
               <principalName>tibco-admin</principalName>
               <managedObjectId>pvm:0a123</managedObjectId>
               <managedObjectType>AUDIT_COMMENT</managedObjectType>
               <managedObjectVersion>-1</managedObjectVersion>
               <extendedMessage>This is a claim.</extendedMessage>
               <children>
                  <comment>
                     <id>1685</id>
                     <creationTime>2016-03-21T11:52:16.783Z</creationTime>
                     <componentId>EC</componentId>
                     <messageId>EC_COMMENT_PI</messageId>
                     <severity>AUDIT</severity>
                     <message>ProcessInstance Comment</message>
                     <priority>MEDIUM</priority>
                     <correlationId>a1ae20a2-ffe3-427b-9a83-f6e3fd2556eb</correlationId>
                     <contextId>a1ae20a2-ffe3-427b-9a83-f6e3fd2556eb</contextId>
                     <messageCategory>PROCESS_INSTANCE</messageCategory>
                     <principalId>tibco-admin</principalId>
                     <principalName>tibco-admin</principalName>
                     <managedObjectId>pvm:0a123</managedObjectId>
                     <managedObjectType>AUDIT_COMMENT</managedObjectType>
                     <managedObjectVersion>1684</managedObjectVersion>
                     <extendedMessage>This is also a claim.</extendedMessage>
                  </comment>
               </children>
            </comment>
         </CommentAudit>
      </getCommentAuditResponse>
   </SOAP-ENV:Body>