imbMessageFlowResponseObject

Extends:	imbDeployedArtifactResponseObject
Namespace:	http://www.ibm.com/iib/apiv1/responseObject
XML Schema:	ns1.xsd

Describes a message flow deployed on a broker

XML

Attributes

name	type	description
type	string	"messageFlow"
isRunning	boolean	Is the flow currently running
runMode	string	Returns 'running' if the message flow is able to run when the execution group is started, otherwise returns 'stopped'. This reports the logical runstate of the message flow, which means that it can return 'running' even if the execution group in which the message flow is deployed is currently stopped. See 'isRunning' to report whether the message flow is currently running.
startMode	string	The current value of start mode for this message flow. One of: Maintained - which means at deploy time or restart the message flow will start based on its isRunEnabled value Automatic - which means at deploy time or restart the message flow will be running Manual - which means at deploy time or restart the message flow will start based on its isRunEnabled value
flowDesignUri	imbURI	URI to the flow design of this object
activityLogUri	imbURI	URI to the activity log of this object
flowMonitoringActive	boolean	Is flow monitoring active?
isInTestRecordMode	boolean	Whether the message flow is in test record mode or not.

Elements

name (type)	min/max occurs	description
archiveStatistics (imbAccountingStatisticsResponseObject)	0/1	Archive Accounting and Statistics
snapshotStatistics (imbAccountingStatisticsResponseObject)	0/1	Snapshot Accounting and Statistics
policies/policy (imbPolicyResponseObject)	0/unbounded	WorkLoad Management policy

JSON

property	type	description
type	string	"messageFlow"
isRunning	boolean	Is the flow currently running
runMode	string	Returns 'running' if the message flow is able to run when the execution group is started, otherwise returns 'stopped'. This reports the logical runstate of the message flow, which means that it can return 'running' even if the execution group in which the message flow is deployed is currently stopped. See 'isRunning' to report whether the message flow is currently running.
startMode	string	The current value of start mode for this message flow. One of: Maintained - which means at deploy time or restart the message flow will start based on its isRunEnabled value Automatic - which means at deploy time or restart the message flow will be running Manual - which means at deploy time or restart the message flow will start based on its isRunEnabled value
flowDesignUri	imbURI	URI to the flow design of this object
activityLogUri	imbURI	URI to the activity log of this object
flowMonitoringActive	boolean	Is flow monitoring active?
isInTestRecordMode	boolean	Whether the message flow is in test record mode or not.
archiveStatistics	archiveStatistics (imbAccountingStatisticsResponseObject)	Archive Accounting and Statistics
snapshotStatistics	snapshotStatistics (imbAccountingStatisticsResponseObject)	Snapshot Accounting and Statistics
policies	array of policies/policy (imbPolicyResponseObject)	WorkLoad Management policy