imbServiceResponseObject

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

Describes a service deployed on a broker

XML

Attributes

name type description
type string "service"
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
hasServiceURL boolean Indicates if the service have a Web service URL to host the WSDL and schemas.
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 within the service.
messageFlows (imbMsgFlowsContainerBean) 0/1 Message flows contained within the service.
subFlows (imbSubFlowsContainerBean) 0/1 subflows contained within the service.
resources (imbDeployedResourcesContainerBean) 0/1 deployed resources contained within the service.
interface (imbServiceInterfaceContainerBean) 0/1 The service interface.
references (imbReferencesContainerBean) 0/1 Shared library dependencies for this service.

JSON

property type description
type string "service"
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
hasServiceURL boolean Indicates if the service have a Web service URL to host the WSDL and schemas.
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 within the service.
messageFlows messageFlows (imbMsgFlowsContainerBean) Message flows contained within the service.
subFlows subFlows (imbSubFlowsContainerBean) subflows contained within the service.
resources resources (imbDeployedResourcesContainerBean) deployed resources contained within the service.
interface interface (imbServiceInterfaceContainerBean) The service interface.
references references (imbReferencesContainerBean) Shared library dependencies for this service.