imbApplicationResponseObject

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

Description of a deployed application

XML

Attributes

name type description
type string "application"
isRunning boolean Is the service 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
hasChildren string Whether the object has more children. This field is hidden if the children are actually being shown in the response.

Elements

name (type) min/max
occurs
description
libraries (imbLibrariesContainerBean) 0/1 Libraries contained in the application.
messageFlows (imbMsgFlowsContainerBean) 0/1 Message flows contained in the application.
subFlows (imbSubFlowsContainerBean) 0/1 subflows contained in the application.
resources (imbDeployedResourcesContainerBean) 0/1 deployed resources contained in the application.
references (imbReferencesContainerBean) 0/1 Shared library dependencies for this application.

JSON

property type description
type string "application"
isRunning boolean Is the service 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
hasChildren string Whether the object has more children. This field is hidden if the children are actually being shown in the response.
libraries libraries (imbLibrariesContainerBean) Libraries contained in the application.
messageFlows messageFlows (imbMsgFlowsContainerBean) Message flows contained in the application.
subFlows subFlows (imbSubFlowsContainerBean) subflows contained in the application.
resources resources (imbDeployedResourcesContainerBean) deployed resources contained in the application.
references references (imbReferencesContainerBean) Shared library dependencies for this application.