pub.monitor.process.instanceSteps:getStepControl
Retrieves all control actions for all iterations of a specified process step.
Input Parameters
instanceID | String Instance ID of the process instance in which the step exists. Specify the complete, exact ID. Note: | Whether Monitor treats instanceID 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. |
|
instanceIteration | String A number that indicates the iteration of the process instance that contains the step. |
stepID | |
stepIteration | String Optional. A number that indicates the iteration of the step for which to retrieve document field values. |
Output Parameters
stepControl | Document List List of the retrieved control actions. For each control action, the following fields are returned: ACTION String The type of control action. The service returns the numerical value that represents the type, as follows: 1 Service Resubmit 2 Document Resubmit 3 Process Resubmit 4 Process Suspend 5 Process Resume 6 Process Stop |
| ACTIONDECODE String The keyword value for the type of control action; that is, one of the following: ![*](bullet.gif) Service Resubmit ![*](bullet.gif) Document Resubmit ![*](bullet.gif) Process Resubmit ![*](bullet.gif) Process Suspend ![*](bullet.gif) Process Resume ![*](bullet.gif) Process Stop |
| INSTANCEITERATION Number The step iteration of the step when the control action was taken. USERNAME String User who initiated the control action. SERVERID String Server where the action was initiated. |
| AUDITTIMESTRING String Time the action was logged in string format, YYYY-MM-DD hh:mm:ss.SSS zzz, where: ![*](bullet.gif) YYYY-MM-DD is the date ![*](bullet.gif) hh:mm:ss:SSS is the time, including milliseconds ![*](bullet.gif) zzz is the time zone |
message | String Optional. Error that occurred during the execution of this service if this service encountered an error. |