Monitor 10.11 | pub.monitor.process.instance Folder | pub.monitor.process.instance:getPagedInstanceList
 
pub.monitor.process.instance:getPagedInstanceList
Retrieves process instances between the fromIndex and toIndex, inclusive. Use this service instead of pub.monitor.process.instance:getInstanceList for better performance when retrieving records.
Input Parameters
The following table lists the input parameters.
modelID
String Optional. Complete model ID used for the process instances you want retrieved. You can retrieve model IDs by invoking the pub.monitor.process.instance:getProcessList service and using the value returned in the processNames/PROCESSKEY output parameter. When you specify modelID, do not use the modelNameInput parameter.
modelNameInput
String Optional. Complete or partial model name used for the process instances you want retrieved. You can retrieve model names by invoking the pub.monitor.process.instance:getProcessList service and using the value returned in the processNames/PROCESSKEYDECODE output parameter. When you specify modelNameInput, do not use the modelID parameter.
instanceID
String Optional. Complete or partial instance ID for the process instances you want retrieved.
customID
String Optional. The full, user-defined ID for the process instances that you want retrieved. User-defined IDs are assigned by executing the pub.prt.log:logCustomID service.
parentInstanceID
String Optional. Complete or partial instance ID for the parent process of the process instances that you want retrieved.
status
String Optional. The status of the process instances you want retrieved. The status you specify is matched against the most recently logged status. Use status if you want the list to contain all process instances of a single specified status. Specify the numerical value that represents the status. For a list of values you can specify, see Status Reference.
Note:
If you do not specify status or statusSet, the service returns process instances of all statuses.
statusSet
String List Optional. A set of statuses for the process instances you want retrieved. Use statusSet when you want the list to contain process instances of more than one specified status. For each status that you specify in statusSet, specify the numerical value that represents the status, as described above for the status parameter.
dateCreated
String Optional. A date range for the process instances you want retrieved. The date range identifies the date of the most recent log entry for the process instances. If you use this parameter, do not use the fromDate or toDate parameter.
*Today Today
*Yesterday Yesterday
*In the last 7 days Within the last 7 days, including today.
*Last week Any day in the previous calendar last week (A week is Sunday through Saturday.)
*This week Any day in the current calendar week. (A week is Sunday through Saturday.)
*Last month Any day in the previous calendar month.
*This month Any day in the current calendar month.
*Year to date Any day in the current calendar year.
fromDate
String Optional. The start date of when data was logged for the process instances you want retrieved. The service retrieves process instances with entries logged on or after this date. Use the format YYYY-MM-DD HH:MM:SS. If you use this parameter, use toDate to specify the end date; do not use the dateCreated parameter when you use the fromDate and toDate parameters.
toDate
String Optional. The end date of when data was logged for the process instances you want retrieved. The service retrieves process instances with entries logged on or before this date. Use the format YYYY-MM-DD HH:MM:SS.
stepID
String Optional. The full ID of a step that was executed in the process instances you want retrieved. You can retrieve step IDs using the service. When you use this stepID parameter, you must also specify:
*The modelID parameter to identify the model in which to search for the specified step.
*The user or role parameters.
user
String Optional. To retrieve information about tasks, user on which to match (that is, user that performed a task). When you use this user parameter, you must also specify the modelID parameter.
role
String Optional. To retrieve information about tasks, role on which to match (that is, role that performed a task). When you use this role parameter, you must also specify the modelID parameter.
maxRows
String Optional. Maximum number of process instances to return, starting with those most recently logged. By default, the service gets all process instances.
sortColumn
String Optional. How to sort the returned list of process instances. By default, the service sorts the returned data using AUDITTIMESTAMP. This parameter works with the sortAscending parameter. Sort by:
*PROCESSLABEL Model name.
*INSTANCEID Process instance ID.
*PARENTINSTANCEID Parent process instance ID, if any.
*STATUS Most recent status; the sort order is based on the numerical values associated with statuses. For a list of the status values, see Status Reference.
*AUDITTIMESTAMP The last time data was logged for the process instance.
sortAscending
String Optional. Whether to sort the returned list of process instances in ascending or descending order. The entries are sorted by the field identified by the sortColumn parameter.
*true Default. Sort in ascending order.
*false Sort in descending order.
isAnd
String Optional. Whether the service is to use an AND or an OR condition for the criteria specified in the input parameters.
*true  Default. Use an AND condition. The service returns process instances that match all the criteria you specify.
*false  Use an OR condition. The service returns process instances that match any of the criteria you specify.
fromIndex
String The starting start row number of the data to retrieve.
toIndex
String The ending row number of the data to retrieve.
isExactMatch
String Optional. Whether the service is to use the UPPER and LIKE conditions for the instanceID, parentInstanceID, and customID input parameters.
*true Default. Do not use the UPPER and LIKE conditions. The service returns only process instances that exactly match the instanceID, parentInstanceID, or customID input parameters.
*false Use the UPPER and LIKE conditions. The service returns any process instances that partially match the instanceID, parentInstanceID, or customID input parameters.
Note:
isExactMatch takes priority over the wm.monitor.useExactMatch parameter located in the monitor.cnf file.
Output Parameters
The following table lists the output parameters.
instances
Document List List of process instances that match the specified criteria. For each process instance, the following fields are returned:
*instanceId String Instance ID of the process instance.
*parentInstanceId String Instance ID of the process instance's parent instance, if any.
*instanceIteration Number Instance iteration of the process instance.
*customId String The user-defined ID for the process instance that was assigned by executing the pub.prt.log:logCustomID service.
*modelId String Unique model ID of the process instance.
*modelName String Name of the process instance.
*modelVersion String The version of the model.
*firstStatus Number First status of the process instance.
*firstTime String Time that data was first logged for the process instance, in string format, YYYY-MM-DD hh:mm:ss.SSS zzz, where: YYYY-MM-DD is the date, hh:mm:ss:SSS is the time and zzz is the time in milliseconds.
*lastStatus Number Latest status of the process instance.
*lastTime String Time that data was last logged for the process instance, in string format, YYYY-MM-DD hh:mm:ss.SSS zzz, where: YYYY-MM-DD is the date, hh:mm:ss:SSS is the time and zzz is the time in milliseconds.
message
String Optional. Error that occurred during the execution of this service, if this service encountered an error.
Usage Notes
This service is related to the pub.monitor.process.instance:getInstanceList service but limits the process models returned by the fromIndex and toIndex. This query performs best if there is not a large difference between the input parameters.