Operation: bpm::processGetState


General Description

Invoke this operation get information about the specified BPM instance.

Operation Notes

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

Request Message

Input Parameters

The processGetState 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
identifier xs:string required once The unique identifier of the spawned process.
returnRuntimeContext xs:boolean optional
default=false
Set this to true if you would like to return the runtime context

Input Data


Response Message

Output Parameters

Name Type Attributes Description
application appNameType required once Name of the application that the process belongs to
name xs:string required once The name of the business process
inputParams anyDataType optional The current values of the input parameters of the business 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 spawning the process) reference.
timePlan xs:string optional The name of the time plan being used to measure timings for this process instance. If not specified then no timing is measured.
processState bpmStateType required once The state of the business process.
stage bpmStageStatusType required
minOccurs=1
maxOccurs=unbounded
The stage information for the business process .
currentStage xs:string required once The stage identifier of the currently executed stage.
currentNode xs:string optional The node identifier of the currently executed node.
failureMessage xs:string optional The error message in the case of process failure.
processParams anyDataType optional The output parameters of the business process if it has completed. Otherwise, it returns nothing. These parameters are specified in the business process definition XML document.
task xs:string optional
minOccurs=0
maxOccurs=unbounded
DEPRECATED: INSTEAD USE taskInfo/id
List of associated tasks of the business process.
taskInfo bpmTaskInfoType optional
minOccurs=0
maxOccurs=unbounded
List of associated task information of the business process.
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

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 , .)