QueryProcessInstances

Query information about process instances that match specified criteria.

  • The request must specify a query that defines the search criteria.
  • The response returns information from process instances according to the specified criteria, either as a complete list or as the first page of a paged list (in which case a paging ID is also returned).

To list process instances that are in a HALTED state, use QueryHaltedProcessInstances instead.

Action QueryProcessInstances
Parameter Notes
  • query: For information about valid syntax, see "Sorting and Filtering Lists of Process Templates and Instances" in the TIBCO ActiveMatrix BPM Developer's Guide.
  • attributeMap: If a user-defined attribute is used in the SELECT statement of a paginated query, that attribute and its type should be included in the attributeMap, otherwise a database query must be made to get the type of the user-defined attribute, making the request less efficient (see the example below).
  • pageSize: Specifies the size of the page. Specify 0 for a non-paginated result. If you specify a paged result (pageSize = -1 or a number greater than 0), you must clear resources when you are finished with the paged list. (Note that the result limit for non-paginated queries (pageSize=0) is 500.)
Return QueryProcessInstancesResult

Required System Actions

queryProcessInstance