SOAP API - purgeTerminatedProcessInstances

The table summarizes the SOAP API - purgeTerminatedProcessInstances.

Request Uses the purgeTerminatedProcessInstancesRequest element (from the ProcessManagement schema)
Parameter notes states (optional) : Permissible values are COMPLETED, CANCELLED and FAULTED. If not specified, all terminal states are applied.

batchSize (optional): Number of process instances that should be deleted before the transaction is committed. The default batchSize is 100.

runInBackground (optional) : specifies whether the purge runs in the background.

threshold (optional): Date before which process instances must have been completed, cancelled or failed for them to be purged in this operation.

applications (optional): specifies which applications the setting applies to (the process templates belonging to the set of applications). If not set, then it applies to all applications.

processTemplates (optional) : specifies which process templates the setting appies to. If not set, it apples to all process templates.

processInstances (optional): specifies which process instances the setting applies to. If not set, it applies to all process instances.

Response Returns a purgeTerminatedProcessInstancesResponse element (from the ProcessManagement schema)
Example Request: 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:proc="http://www.tibco.com/bx/2009/management/processManagerType">
   <soapenv:Header/>
   <soapenv:Body>
      <proc:purgeTerminatedProcessInstancesRequest>
         <proc:options>
            <proc:applications>
               <proc:applicationName>app2</proc:applicationName>
            </proc:applications>
            <proc:processTemplates>
               <proc:processQName>
                  <proc:moduleName>/simpleCorrelateTest/Process Packages/simpleCorrelateTest2.xpdl</proc:moduleName>
                  <proc:processName>procD</proc:processName>
               </proc:processQName>
            </proc:processTemplates>
         </proc:options>
      </proc:purgeTerminatedProcessInstancesRequest>
   </soapenv:Body>
</soapenv:Envelope>
Response: 
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Header/>
   <SOAP-ENV:Body>
      <purgeTerminatedProcessInstancesResponse xmlns="http://www.tibco.com/bx/2009/management/processManagerType">
         <statusMessage>223 has been purged.</statusMessage>
         <totalInstanceCount>223 </totalInstanceCount>
         <status>PURGE_STOPPED</status>
      </purgeTerminatedProcessInstancesResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>