SOAP API - listProcessInstances
The table summarizes the SOAP API - listProcessInstances.
Request | Uses the qualifiedProcessName element (from the ProcessManagement schema) |
Parameter notes | moduleName,
processName, and
version can be obtained from
listProcessTemplates ,
queryProcessTemplates , and
queryProcessTemplatesAlt.
Note: If the string '#IN_MEMORY' is appended to the
moduleName, the operation returns in-memory process instances. When using the '#IN_MEMORY' option, wildcards ('*' or '?') cannot be used in the
moduleName. The
moduleName must either be specified in full, or left blank. (A blank
moduleName returns all in-memory instances that match the specified process and/or version.)
|
Response | Returns a processInstances 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:qualifiedProcessName> <proc:moduleName>/WelcomeUsersDesignSolution/Process Packages/ProcessPackage.xpdl</proc:moduleName> <proc:processName>WelcomeUsers</proc:processName> <proc:version>1.0.0.201106290731</proc:version> </proc:qualifiedProcessName> </soapenv:Body> </soapenv:Envelope> |
Response:
<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>/WelcomeUsersDesignSolution/Process Packages/ProcessPackage.xpdl</moduleName> <processName>WelcomeUsers</processName> <version>1.0.0.201106290731</version> </processQName> <id>pvm:0a12e</id> <state>ACTIVE</state> <startTime>2011-06-29T07:33:04.377-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> |
Copyright © Cloud Software Group, Inc. All rights reserved.