SOAP API - getCaseAudit

• className: The fully qualified name of the case class. For example, com.example.gddemo.Customer. You can obtain this by running getCaseClassInfo.
• majorVersion: The version of the case model. For example, 2 or 2.0.0.
• managedObjectID: The case data’s ID, as it is stored in the database.
• caseReference: The reference to the case object. You can obtain case references using findAllCases.
• 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.
• 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.
  • attribute. Specifies the attribute to sort.
  • type. Specifies the sort order, either ASCENDING for ascending or DESCENDING for descending.
• Version (Optional): The version of the API you want to execute against.
• fetchComments (Optional). Returns all comments for the case.
• Detail (Optional). Not supported.

 <soapenv:Body>
      <api:getCaseAuditRequest>
         <base:Case>
            <reference>BDS-1-com.example.xyzinsuranceBDSProject.Claim-159-7</reference>
         </base:Case>
         <base:CaseAuditReportOptions>
         </base:CaseAuditReportOptions>
      </api:getCaseAuditRequest>
   </soapenv:Body>

 <SOAP-ENV:Body>
      <getCaseAuditResponse xmlns="http://api.ec.n2.tibco.com">
         <CaseAudit xmlns="http://base.api.ec.n2.tibco.com">
            <endPosition xmlns="">11</endPosition>
            <startPosition xmlns="">0</startPosition>
            <totalItems xmlns="">11</totalItems>
            <case 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/">
               <reference>BDS-1-com.example.xyzinsuranceBDSProject.Claim-159-7</reference>
            </case>
            <entry xmlns="">
               <id>19113</id>
               <creationTime>2016-03-17T16:29:36.237Z</creationTime>
               <componentId>BDS</componentId>
               <messageId>BDS_GLOBAL_DATA_LINK_CASES</messageId>
               <severity>AUDIT</severity>
               <message>BDS Link Cases</message>
               <priority>MEDIUM</priority>
               <correlationId>c59be01c-e0b3-412b-96e3-2c96e03fc4c2</correlationId>
               <contextId>c59be01c-e0b3-412b-96e3-2c96e03fc4c2</contextId>
               <messageCategory>GLOBAL_DATA</messageCategory>
               <principalId>tibco-admin</principalId>
               <principalName>tibco-admin</principalName>
               <managedObjectId>BDS-1-com.example.xyzinsuranceBDSProject.ContactAndUpdates-160-1</managedObjectId>
               <managedObjectName>com.example.xyzinsuranceBDSProject.ContactAndUpdates</managedObjectName>
               <managedObjectType>BDS</managedObjectType>
               <managedObjectVersion>1</managedObjectVersion>
               <entityId>160</entityId>
               <modelMajorVersion>1</modelMajorVersion>
               <modelVersion>1.0.1</modelVersion>
               <fetchComments>This is a case</fetchComments>
               <caseReferences>
                  <caseReference>BDS-1-com.example.xyzinsuranceBDSProject.Claim-159-3</caseReference>
               </caseReferences>
            </entry>
         </CaseAudit>
      </getCaseAuditResponse>
   </SOAP-ENV:Body>