GetProcessInstances |
The GetProcessInstances SOAP method is used to retrieve the process instances. This method is a part of the Method Set Query Process Instance Data 4.2 interface with the namespace http://schemas.cordys.com/pim/queryinstancedata/1.0.
SOAP Request
<SOAP:Envelope xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP:Body>
<GetProcessInstances xmlns="http://schemas.cordys.com/pim/queryinstancedata/1.0">
<Query xmlns="http://schemas.cordys.com/cql/1.0">
<Select>
<QueryableObject>PROCESS_INSTANCE</QueryableObject>
<Field>INSTANCE_ID</Field>
<Field>PROCESS_NAME</Field>
<Field>DESCRIPTION</Field>
<Field>START_TIME</Field>
<Field>END_TIME</Field>
<Field>USER_NAME</Field>
<Field>STATUS</Field>
<Field>TYPE</Field>
<Field>IS_ARCHIVED</Field>
<Field>PUBLISHED_TO</Field>
<Field>PROCESS_TYPE</Field>
<Field>MODEL_REVISION_ID</Field>
<Field>CURRENT_OWNER</Field>
</Select>
<Filters/>
<OrderBy>
<Property direction="desc">START_TIME</Property>
</OrderBy>
<Cursor numRows="50"/>
</Query>
</GetProcessInstances>
</SOAP:Body>
</SOAP:Envelope>
Request Parameters
Parameter |
Description |
Mandatory |
Accepted Input Values |
|---|---|---|---|
QueryableObject |
Name of the database object that is to be queried |
Yes |
Fully qualified name of the object |
Field |
Name of the database column, whose details are to be queried |
No |
Any column name of the database object |
Filters |
Constraints to filter the response |
No |
And, Or, EQ, NQ, LT, LE, GT, GE, In, Like, Between, IsNull, Not (may be nested and repeated) |
GroupBy |
Fields on which the results must be grouped |
No |
One or more of the Property elements |
OrderBy |
Fields on which the results must be ordered |
No |
One or more of the Property elements. The ordering sequence depends upon the sequence of the Property elements. |
Cursor |
Information on the set of results to be returned |
No |
|
| Cursor/@numRows | Number of rows to be retrieved | No |
SOAP Response
<data>
<GetProcessInstancesResponse xmlns="http://schemas.cordys.com/pim/queryinstancedata/1.0>
<data>
<constructor language="DBSQL">
<cursor numRows="50" id="1.23" position="50" maxRows="99999949" />
</constructor>
<tuple>
<old>
<PROCESS_INSTANCE>
<INSTANCE_ID>0050568B-7618-71DE-BB34-92E45ECB8FF7</INSTANCE_ID>
<PROCESS_NAME>DummyProc</PROCESS_NAME>
<DESCRIPTION>DummyProc</DESCRIPTION>
<START_TIME>1251362041844</START_TIME>
<END_TIME>1251362041863</END_TIME>
<USER_NAME>cn=gjansen,cn=organizational users,o=system,cn=cordys,cn=build32,o=vanenburg.com</USER_NAME>
<STATUS>COMPLETE</STATUS>
<TYPE>Run from Process Designer</TYPE>
<IS_ARCHIVED null="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true" />
<PUBLISHED_TO>0</PUBLISHED_TO>
<PROCESS_TYPE>0</PROCESS_TYPE>
<MODEL_REVISION_ID>00505681-29ed-11e3-e49c-084eee0a1de3</MODEL_REVISION_ID>
<CURRENT_OWNER>cn=gjansen,cn=organizational users,o=system,cn=cordys,cn=build32,o=vanenburg.com</CURRENT_OWNER>
</old>
</tuple>
</data>
</GetProcessInstancesResponse>
</data>
Response Parameters
Parameter |
Description |
|---|---|
| INSTANCE_ID | ID of the process instance |
PROCESS_NAME |
Fully qualified name of the business process |
DESCRIPTION |
Description of the business process |
| START_TIME | Start time of the process instance |
END_TIME |
End time of the process instance |
USER_NAME |
DN of the user who triggered the instance |
STATUS |
Status of the process instance |
TYPE |
Type of process instance execution |
IS_ARCHIVED |
Option that indicates whether the process instance is archived or not |
PUBLISHED_TO |
Space where the process instance is available 0: organization; 1: isv |
PROCESS_TYPE |
|
| MODEL_REVISION_ID | Revision ID of the model at which this instance was triggered. |
| CURRENT_OWNER | DN of the user who triggered the instance |