Operation: automation::runbookGetState

General Description

Invoke this operation get information about the specified runbook instance.

Operation Notes

System Privileges Mail Privileges Calendar Privileges Database Privileges
-- -- -- db.[default_db].h_bpm_instance.browse

Request Message

Input Parameters

The runbookGetState method takes the following input parameters. It is important to note that the parameters must be passed to the operation in the same order as they appear here in order to satisfy the requirement of the input validation checks.

Name Type Attributes Description
runbookId xs:string required once The unique identifier of the spawned runbook process.
returnRuntimeContext xs:boolean optional
Set this to true if you would like to return the runtime context
waitSequence xs:unsignedInt optional
Provide the last value returned in the waitSequence response parameter to wait for a status change
waitTime xs:unsignedInt optional
The amount of time to wait (in seconds) for a staus change. Default is 10

Input Data

Response Message

Output Parameters

Name Type Attributes Description
name xs:string required once The name of the runbooks process
reference xs:anyURI optional An application defined reference, such as a URN to an entity record or any other application-definable meaningful (to the application initiating the runbook) reference.
processState bpmStateType required once The state of the runbook process.
currentNode xs:string optional The node identifier of the currently executed node in the runbook.
failureMessage xs:string optional The error message in the case of process failure.
inputParam inputParameterType optional
The input parameters for the runbook.
outputParam outputParameterType optional
The output parameters from this runbook.
runtimeContext xs:string optional Returns a JSON formatted object that represents the BPM runtime variables.
lastUpdated xs:dateTime required once Returns the date/time the process was last updated
waitSequence xs:unsignedInt required once You can use this value to call this operation again to wait for status changes

Output Data

Code Generation & Samples

The links below will generate sample code in the respective languages. You can use these links as a convenient way of generating the correct code needed to invoke this method

JavaScript   PHP   C#   Java   C++   [ hide code ]  

Powered by Hornbill, for more information click here. (page served by , .)