SOAP API - stopPurgeAudit

The table summarizes the SOAP API - stopPurgeAudit.

Request Uses the stopPurgeAuditRequestelement (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) Use the purgeStatus object to return purge messages. See Purge Audit Status for details.
Response Returns a stopPurgeAuditResponseelement (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 had already completed by the time that the StopPurgeAudit instruction was issued.
    • PURGE_FAILED: The purge failed because it encountered an error. The stack trace for the failure is reported in the stopPurgeAuditResponseand you can check the BPM.log for more information.
    • PURGE_STOPPED: The purge has been successfully stopped.
Example Request:
<soapenv:Body>
      <api:stopPurgeAuditRequest/>
          <options>
               <requiredExtendedData>
                 <requireAllExtendedData>true</requireAllExtendedData>
               </requiredExtendedData>
         </options>
      </api:stopPurgeAuditRequest/>
</soapenv:Body>
Response:
<SOAP-ENV:Body>
  <stopPurgeAuditResponse xmlns="http://api.ec.n2.tibco.com">
     <status xmlns="">
       <statusMessage>Purge operation [EC-PURGE-1373385259591] stopped successfully!</statusMessage>
       <start>2013-08-08T13:58:57.384Z</start>
       <end>2013-08-08T13:58:57.538Z</end>
       <currentInstanceCount>3</currentInstanceCount>
       <totalInstanceCount>5</totalInstanceCount>
       <purgeOperationName>EC-PURGE-1373385259591</purgeOperationName>
       <status>PURGE_STOPPED</status>
  </stopPurgeAuditResponse>
</SOAP-ENV:Body>