Monitor 10.11 | pub.monitor.process.instance Folder | pub.monitor.process.instance:getInstanceListCustomData Set
 
pub.monitor.process.instance:getInstanceListCustomData Set
Retrieves process instances that meet specified criteria, including specifying a set of values of multiple custom logged fields, which instructs the service to return all process instances where the values you specify were logged for the specified custom logged fields.
Note:
Whether the search is case-sensitive or case-insensitive depends on how the underlying database (for example, Oracle, DB2, or SQL server) handles the queries that Monitor issues to obtain data.
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.
modelIDSet
String List Optional. A set of complete model IDs 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.
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 of 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.
parentInstanceID
String Optional. Complete or partial instance ID for the parent process of the process instances that 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.
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. Set the value to the code to retrieve process instances that match the most recent entry:
*Today Today
*Yesterday Yesterday
*In the last 7 days Within the last 7 days, including current date.
*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.
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.
customTable
String Table Optional. The custom fields and their values that you want to use to search for process instances. The service returns process instances that match all the custom field data you specify. For each custom field, specify the following fields.
*documentName String The complete name of the document that contains the custom field that you want to use to search for process instances. Specify the name as it was defined in Designer.
*fieldName String The complete name of the logged field that you want to use to search for process instances. The logged field should be a field within the document identified by documentName.
*fieldType String The data type of fieldname. Specify either String or Number.
*comparator String A comparator indicates how the service should compare the value you specify in value to the actual value logged for the custom field specified by fieldName. Specify one of the following: = , Contains, Not Contains, != , < , >, <= , >=
*value String The value that you want the service to use to compare with the actual value stored for the custom field specified by fieldName.
maxRows
String Optional. Maximum number of process instances to return, starting with those most recently logged. By default, the service gets all process instances.
isAnd
String Optional. Whether the service uses 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.
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.
*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.
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:
*ROOTCONTEXTID String Root context ID.
*PARENTCONTEXTID String Parent context ID.
*CONTEXTID String Context ID.
*AUDITTIMESTAMP Number Time data was last logged for the process instance, in epoch time; that is, the number of seconds since January 1, 1970.
*AUDITTIMESTRING String Time 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, including milliseconds
*zzz is the time zone
*PARENTINSTANCEID String Instance ID of the parent instance, if any.
*PARENTINSTANCEITERATION Number Instance iteration of the parent instance, if any.
*INSTANCEID String Instance ID.
*INSTANCEITERATION Number Instance iteration.
*STATUS String Instance status. The service returns the numerical value that represents the status. For a description of the status values, see Status Reference.
*STATUSDECODE String Status value for this process instance. The service returns the keyword value that represents the status. For the list of keyword values, for example “Started” or “Completed,” see Status Reference.
*PROCESSKEY String Unique model ID of the process instance.
*PROCESSKEYDECODE String Process name of the process instance.
*CUSTOMID String User-defined ID for the process instance that was assigned by executing the pub.prt.log:logCustomID service.
*PROCESSLABEL String Process name of the process instance.
message
String Optional. Error that occurred during the execution of this service if this service encountered an error.