imbRestApiResponseObject

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

Description of a deployed REST API

XML

Attributes

name	type	description
type	string	"restApi"
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.
title	string	The title of this REST API. This is retrieved from the API definitions.
version	string	The version of this REST API. This is retrieved from the API definitions.

Elements

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

JSON

property	type	description
type	string	"restApi"
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.
title	string	The title of this REST API. This is retrieved from the API definitions.
version	string	The version of this REST API. This is retrieved from the API definitions.
api	api (api)
libraries	libraries (imbLibrariesContainerBean)	Libraries contained in the REST API.
messageFlows	messageFlows (imbMsgFlowsContainerBean)	Message flows contained in the REST API.
subFlows	subFlows (imbSubFlowsContainerBean)	subflows contained in the REST API.
resources	resources (imbDeployedResourcesContainerBean)	deployed resources contained in the REST API.
references	references (imbReferencesContainerBean)	Shared library dependencies for this REST API.