SOAP API - getProcessInstanceAudit

The table summarizes the SOAP API - getProcessInstanceAudit.

Request Uses the getProcessInstanceAuditRequest element (from the EventCollectorReportService schema).
Parameter notes
  • instanceId: identifies the instance ID whose events you want to audit. Can be obtained from listProcessInstances, queryProcessInstances or queryProcessInstancesAlt.
  • getTotalCount: (Optional): whether to include a count of the total number of events in the list. This defaults to true. 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. Note that numberOfItems only applies to the root process. If there are any subprocesses, all the events are returned, regardless of how numberOfItems is set.
  • 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 . These are 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.
    • attribute. Specifies the attribute to sort.
    • type. Specifies the sort order, either ASC for ascending or DESC for descending.
  • Version (Optional): The version of the API you want to execute against.
  • fetchComments (Optional). Returns all comments for the process instance.
  • processDepth (Optional). Determines how many sub-processes to return. By default, this is set to -1 which returns all sub-processes. Note that numberOfItems and startPosition only apply to the first process instance. Any work items or sub processes are returned in full.
 
  • Detail (Optional). Provides the work items associated with the given process instance.
Response Returns a getProcessInstanceAuditResponse element (from the EventCollectorReportService schema).
Example Request: 
<soapenv:Body>
      <api:getProcessInstanceAuditRequest>
         <base:ProcessInstanceReference>
            <instanceId>pvm:0a123</instanceId>
         </base:ProcessInstanceReference>
         <base:ProcessInstanceAuditReportOptions>
         </base:ProcessInstanceAuditReportOptions>
      </api:getProcessInstanceAuditRequest>
   </soapenv:Body>
  Response: 
<SOAP-ENV:Body>
      <getProcessInstanceAuditResponse xmlns="http://api.ec.n2.tibco.com">
         <ProcessInstanceAudit xmlns="http://base.api.ec.n2.tibco.com">
            <endPosition xmlns="">33</endPosition>
            <startPosition xmlns="">0</startPosition>
            <totalItems xmlns="">33</totalItems>
            <entry xmlns="">
               <id>21133</id>
               <creationTime>2016-03-17T16:13:56.208Z</creationTime>
               <componentId>BX</componentId>
               <messageId>BX_INSTANCE_TASKS_COMPLETED</messageId>
               <severity>AUDIT</severity>
               <message>Task completed.</message>
               <priority>MEDIUM</priority>
               <messageCategory>PROCESS_INSTANCE</messageCategory>
               <principalId>tibco-admin</principalId>
               <principalName>tibco-admin</principalName>
               <managedObjectId>pvm:0a123</managedObjectId>
               <managedObjectName>CreateProfile</managedObjectName>
               <managedObjectType>reusableSubProcess</managedObjectType>
               <managedObjectVersion>1.0.1</managedObjectVersion>
               <parentObjectId>pvm:0a119</parentObjectId>
               <applicationActivityName>CreateAndAssociateDocument</applicationActivityName>
               <applicationActivityInstanceId>pvm:001i15</applicationActivityInstanceId>
               <applicationName>com.example.xyzinsurancecompanyprofile</applicationName>
               <iterationId>pvm:001i44</iterationId>
               <moduleName>/XYZInsuranceCompanyProfile/Process Packages/XYZInsuranceCompanyProfile.xpdl</moduleName>
               <caseReferences>
                  <caseReference>BDS-1-com.example.xyzinsuranceBDSProject.XYZInsurance-52-0</caseReference>
               </caseReferences>
               <genericAttributes>
                  <attribute15>0</attribute15>
                  <attribute38>pvm:001i44</attribute38>
               </genericAttributes>
            </entry>
            <processInstanceRef 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/">
               <instanceId>pvm:0a123</instanceId>
            </processInstanceRef>
          </ProcessInstanceAudit>
      </getProcessInstanceAuditResponse>
   </SOAP-ENV:Body>