SOAP API - checkPurgeAudit

The table summarizes the SOAP API - checkPurgeAudit.

Request Uses the checkPurgeAuditRequest element (from the EventCollectorManagementService schema).
Parameter Notes options: The only parameter for this request is a list of options, none of which are themselves mandatory.
  • requiredExtendedData: (optional) Return additional data in the purgeStatus object. May contain one of:
    • requireAllExtendedData (boolean)
    • requireExtendedData (enumeration)

      See Purge Audit Status for further details.
Response Returns a checkPurgeAuditResponse element (from the EventCollectorManagementService schema).
Parameter notes
  • statusMessage: Expands on the status code to provide data about the purge, such as the number of instances deleted. See Purge Audit Status .
  • status: Indicates the status of the purge:
    • PURGE_COMPLETED: The purge has completed successfully.
    • PURGE_STOPPED: The purge was stopped manually (typically by the stopPurgeAudit operation) before it completed.
    • PURGE_FAILED: The purge has failed because it encountered an error. The stack trace for the failure is reported in the checkPurgeAuditResponse and you can check the BPM.log for more information.
    • PURGE_IN_PROGRESS: The purge is still in progress.
Example Request:
<soapenv:Body>
      <api:checkPurgeAuditRequest/>
          <options>
               <requiredExtendedData>
                 <requireAllExtendedData>true</requireAllExtendedData>
               </requiredExtendedData>
         </options>
      </api:checkPurgeAuditRequest>
</soapenv:Body>
Response:
<SOAP-ENV:Body>
     <checkPurgeAuditResponse xmlns="http://api.ec.n2.tibco.com">
         <status xmlns="">
            <statusMessage>Purge Operation [EC-PURGE-1375969467578] started at 2013-08-08T13:44:27.579Z finished at 2013-08-08T13:44:27.956Z with success! 3 instances of total 3 deleted!</statusMessage>
            <start>2013-08-08T13:44:27.579Z</start>
            <end>2013-08-08T13:44:27.956Z</end>
            <currentInstanceCount>3</currentInstanceCount>
            <totalInstanceCount>3</totalInstanceCount>
            <purgeOperationName>EC-PURGE-1375969467578</purgeOperationName>
            <status>PURGE_COMPLETED</status>
         </status>
      </checkPurgeAuditResponse>
</SOAP-ENV:Body>