listProcessInstances

The listProcessInstances operation returns the process instances that match the input criteria. It allows you to limit the process instances returned according to those that were started from a template in a specified module, those started from a specified process template, or those of a specified template version.

Leaving all listProcessInstances parameters blank causes the operation to return all process instances.

Web Service API example (SOAP):

<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:qualifiedProcessName>
         <proc:moduleName></proc:moduleName>
<proc:processName>SalesCallbackProcess</proc:processName>
         <proc:version></proc:version>
      </proc:qualifiedProcessName>
   </soapenv:Body>
</soapenv:Envelope>
 
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Header/>
   <SOAP-ENV:Body>
      <processInstances xmlns="http://www.tibco.com/bx/2009/management/processManagerType">
         <processInstance>
            <processQName>
               <moduleName>/SalesCallback/Process Packages/SalesCallback.xpdl</moduleName>
               <processName>SalesCallbackProcess</processName>
               <version>1.0.0.201105061158</version>
            </processQName>
            <id>pvm:0a124</id>
            <state>ACTIVE</state>
            <startTime>2011-08-01T11:47:40.047-07:00</startTime>
            <completionTime xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
            <waitingWorkCount>1</waitingWorkCount>
            <parentProcessID/>
         </processInstance>
      </processInstances>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Service Connector API example (Java):

private void listProcessInstancesExample()
{
  QualifiedProcessName process = QualifiedProcessName.Factory.newInstance();
  try
  {
    // List all the available instances
    serviceConnectorInstance.listProcessInstances(process);
  }
  catch (IllegalArgumentFault e)
  {
    // TODO Auto-generated catch block
    e.printStackTrace();
  }
  catch (OperationFailedFault e)
  {
    // TODO Auto-generated catch block
    e.printStackTrace();
  }
}