Monitor 10.11 | pub.monitor.process.model Folder | pub.monitor.process.model:getModelList
 
pub.monitor.process.model:getModelList
Retrieves a list of process models for which at least one process instance of the model has run.
Input Parameters
The following table lists the input parameters.
modelID
String Optional. Complete model ID of a process model. Use the modelID parameter if you want to determine whether a specific model has had any running process instances. You can retrieve model IDs by invoking the pub.monitor.process.model:getModelNames service and using the value returned in the modelNames/PROCESSKEY output parameter. If you specify modelID, do not use the modelNameInput parameter.
Note:
Whether Monitor treats modelID as case-sensitive depends on how the underlying database (for example, Oracle, DB2, or SQL server) handles the queries that Monitor issues to obtain data.
modelNameInput
String Optional. Partial model name of a model. Use the modelNameInput parameter if you want to limit the retrieved models to those that match the partial model name. You can retrieve model names by invoking the pub.monitor.process.model:getModelNames service and using the value returned in the modelNames/PROCESSKEYDECODE output parameter. When you specify modelNameInput, do not use the modelID parameter.
Note:
Whether Monitor treats modelNameInput as case-sensitive depends on how the underlying database (for example, Oracle, DB2, or SQL server) handles the queries that Monitor issues to obtain data.
enabled
String Optional. For webMethods-executed process models only, whether you want to retrieve models that are enabled or disabled.
*0 Disabled
*1 Enabled
*2 Default. Either enabled or disabled
sortColumn
String Optional. How you want the service to sort the list of retrieved process models. This parameter works with the sortOrder parameter.
*started The value in the Started column, which is the number of process instances that use this process model that are started.
*completed The value in the Completed column, which is the number of process instances that are completed.
*suspended The value in the Suspended column, which is the number of process instances that are suspended.
*failed The value in the Failed column, which is the number of process instances that have failed.
*canceled The value in the Canceled column, which is the number of process instances that have been canceled.
*resumed The value in the Resumed column, which is the number of process instances that have been resumed.
*resubmitted The value in the Resubmitted column, which is the number of process instances that have been resubmitted.
*modelName Default. Name of the process model.
*enabled Whether the process models are enabled or disabled.
*deployTime The time the process models were updated in the Process Audit Log database component.
*For a webMethods-executed process model, this is the last date and time the process model version was built and uploaded for execution.
*For an externally executed process model, this is the last date and time the process model was uploaded for analysis.
*For an integration process, this is when the pub.monitor.integrationProcessLogging:createProcessMetadata service was used to log information about the process.
sortOrder
String Optional. Whether to sort in ascending or descending order. This parameter works with the sortColumn parameter.
*0 Default. Sort in ascending order.
*1 Sort in descending order.
Output Parameters
The following table lists the output parameters.
modelTable
Document List List of the retrieved webMethods-executed process models, externally executed process models, integration processes, and task models. For each model, the following fields are returned:
*MODELID String Unique model ID of the process model.
*MODELNAME String Name of the process model.
For the process model, the total number of process instances:
*STARTED String Number of process instances in Started status.
*COMPLETED String Number of process instances in Completed status.
*FAILED String Number of process instances in Failed status.
*SUSPENDED String Number of process instances in Suspended status.
*CANCELED String Number of process instances in Canceled status.
*RESUMED String Number of process instances in Resumed status.
*RESUBMITTED String Total number of process instances in Resubmitted status.
*DEPLOYDATE String Time the process model was last updated in the Process Audit Log database component. The time is 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
*DEPLOYTIME Number Time the process model was last updated in the Process Audit Log database component. The time is specified in epoch time, which is the number of seconds since January 1, 1970.
*ENABLED String For webMethods-executed process models, whether the process model is enabled or disabled.
* 0  Disabled
* 1  Enabled
*-1  Disabled and generation failed
*-2  Enabled and generation failed
*DeployVersion String The version of the process model. Externally executed process models are always version 1.
wfTable
Document List List of workflow models that were created using webMethods Workflow. If you still have workflow models in your logging database, they are returned in the following fields for each workflow model.
*MODELID String Unique model ID of the workflow.
*MODELNAME String Name of the workflow.
*STARTED String Number of processes in Started status.
*COMPLETED String Number of processes in Completed status.
*FAILED String Number of processes that are currently in the Failed status and are based on the workflow.
*SUSPENDED String Number of processes that are currently in the Suspended status and are based on the workflow.
*CANCELED String Number of processes in Canceled status.
*RESUMED String Number of processes in Resumed status.
*RESUBMITTED String Number of processes in Resubmitted status.
*DEPLOYDATE String Time the model was last updated in the Process Audit Log database tables, 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
*DEPLOYTIME Number Time the model was last updated in the Process Audit Log database component. The time is in epoch time, which is the number of seconds since January 1, 1970.
message
String Error that occurred while executing this service.
Usage Notes
If there are multiple versions of a process model, the service returns all versions.