Monitor 10.7 | pub.monitor.process.instance Folder | pub.monitor.process.instance:getInstance
 
pub.monitor.process.instance:getInstance
Retrieves details about a process instance from the logging database.
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.
instanceID
String Instance ID for the process instance for which you want to retrieve details. Specify the complete, exact ID.
Output Parameters
The following table lists the output parameters.
data
Document The details for the process instance. The returned data parameter contains these fields:
*instanceID String The instance ID for the process instance that you specified in the input parameter.
*customID String An ID that the process instance logged during execution using the pub.prt.log:logCustomId service. If this service was not used to log a custom ID, customID and instanceID are the same value.
*modelID String The unique ID for the process model.
*modelName String The name of the model.
*modelVersion String The version of the model.
*instanceIteration Number Most recent instance iteration count for the process instance.
The first time a process instance is executed, the iteration count is 1. Each time a process instance is resubmitted, the iteration count is incremented.
*parentInstanceID String Instance ID for parent process instance, if any. If the process instance does not have a parent process, parentInstanceID is null.
*parentInstanceIteration Number Iteration count of the parent process instance, if any. If the process instance does not have a parent process, parentInstanceIteration is 0.
*statusDecode String A keyword value for the most recent status of the process instance. For the list of keyword values, for example “Started” or “Completed,” see Status Reference.
*status String A numerical value that represents the status of the process instance. For a list of values you can specify, see Status Reference.
*timeStamp String Time data was last logged for the process instance in the string format YYYY-MM-DD hh:mm:ss.SSS zzz.
*errorMessage String Error that occurred during the execution of this service if this service encountered an error.
processControl
String Whether you have the functional privileges to suspend/resume, stop, and resubmit the process.
*true You have all three functional privileges for this process instance.
*false You do not have all three functional privileges to control this process instance.