listProcessInstances

Lists process instances for the specified process templates.

This is a convenience operation: queryProcessInstances can return the same information, but requires more input.

  • The request must specify the process templates for which process instances are to be listed.
  • The response returns the process instances that exist for the specified process template.
    Note: The listProcessInstances response can contain a maximum of 500 process instances. This limit is fixed and cannot be configured. If you are expecting a response that exceeds 500 process instances, use queryProcessInstances with a positive pageSize parameter instead.
Note: The listProcessInstances operation can return in-memory process instances, if the string '#IN_MEMORY' is appended to the module name specified in the request. For example (using the SOAP API): 
<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>/WelcomeUsersDesignSolution/Process Packages/
         ProcessPackage.xpdl#IN_MEMORY</proc:moduleName>
         <proc:processName>WelcomeUsers</proc:processName>
         <proc:version>1.0.0.201106290731</proc:version>
      </proc:qualifiedProcessName>
   </soapenv:Body>
</soapenv:Envelope>

When using the '#IN_MEMORY' option, wildcards ('*' or '?') cannot be used in the module name. The module name must either be specified in full, or left blank. (A blank module name returns all in-memory instances that match the specified process and/or version.)

Required System Action
queryProcessInstance
API Descriptions