Operation: automation::runbookRun


General Description

Invoke this operation to execute a runbook process.

Operation Notes

System Privileges Mail Privileges Calendar Privileges Database Privileges
sys.a.canSpawnProcess -- -- db.[default_db].h_buz_icons.browse
db.[default_db].h_bpm_processes.browse
db.[default_db].h_bpm_processes.update
db.[default_db].h_bpm_instance.add
db.[default_db].h_bpm_instance.update

Request Message

Input Parameters

The runbookRun 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
name xs:string required once The name of the orchestration to spawn.
reference xs:anyURI optional An application defined reference, such as a URN to an entity or any other application-definable meaningful (to the application running the orchestration) reference.
inputParam inputParameterType optional
minOccurs=0
maxOccurs=unbounded
The input parameters for the runbook.

Input Data


Response Message

Output Parameters

Name Type Attributes Description
runbookId xs:string required once The unique identifier of the running runbook instance.
version xs:unsignedInt required once The version of the runbook that was executed.
state bpmStateType required once This can be InProgress, Succeeded or Failed.
failureMessage xs:string optional The error message in the case of a runbook runtime failure.

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 Esp.hornbill.ServerService, 8.0.0.3141.)