Class: QueryProcessInstancesRequest

tibco.objectapi.service.request.QueryProcessInstancesRequest

new QueryProcessInstancesRequest(query, pageSize)

Object QueryProcessInstancesRequest Usage: RestApiService.getProcessManagementService().queryProcessInstances(request, callback);
Parameters:
Name Type Description
query string Full (SQL syntax) query string. The "FROM process" clause should be included in the query.
pageSize number (Java type: int) Page size to be used to return the list of process instances. One of the following values:
  • 0: Return the entire result set in a single, non-paged list. The result set when using this value is restricted to 500 entries.
  • -1: Return the result set in a paged list, using the default page size.
  • positive integer: return the result set in a paged list, with the specified number of items on each page.

If you specify a paged result (pageSize = -1 or a number greater than 0), use the queryFirstPage, queryLastPage, queryNextPage, and queryPreviousPage functions to navigate the paged list, and queryDone to clear resources when you are finished with the paged list. (Note that the result limit for non-paginated queries (pageSize=0) is 500.)

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 name and type parameters (see below), otherwise a database query must be made to get the type of the user-defined attribute, making the request less efficient.
Since:
  • 4.0.0

Members

names :Array.<string>

Query parameter: 'name' (Java type: List) Name of the template attribute.
Type:
  • Array.<string>
Since:
  • 4.0.0

statusMode :string

Query parameter: 'statusmode' Used to filter process instances by status. The valid entries are: ACTIVE, TERMINATED, and ACTIVE_AND_ TERMINATED.
Type:
  • string
Since:
  • 4.0.0

types :Array.<string>

Query parameter: 'type' (Java type: List) Data type of the template attribute.
Type:
  • Array.<string>
Since:
  • 4.0.0