IBM Integration Bus also contains an old and deprecated RESTful API.
The documentation for this is still available at oldApi.html, however it is strongly recommended that
move to the new API as soon as possible
REST Resources
Mount Point: /apiv1
Note that all URIs here start with /apiv1/ and that "query parameters" should be specified by appending to the end of the URI, i.e. "?field1=value1&field2=value2&field3=value3..."The response format is set by the "Accept" header.
For example, to query all resources deployed to Execution Group 'default' and get the response in json the following curl command could be used
curl 'localhost:4414/apiv1/executiongroups/default/?depth=2' -H 'Accept: application/json'
When using POST or PUT with a body, the format of the body must be specified with the "Content-type" header otherwise the server will give an error.
Allowed values for Accept or Content-type are:
- text/xml
- application/xml
- application/json
This API supports a Representational State Transfer (REST) model for accessing a set of resources through a fixed set of operations. The following resources are accessible through the RESTful model:
- /
- /bar/readBar
- /bar/readOverrides
- /business
- /business/businesstransactions
- /business/businesstransactions/{businessTransactionName}
- /business/businesstransactions/{businessTransactionName}/Results
- /business/businesstransactions/{businessTransactionName}/Results/{transactionID}/Events
- /business/businesstransactions/{businessTransactionName}/Results/{transactionID}/Events/{msgKey}
- /components
- /components/{componentName}
- /components/{componentName}/properties
- /components/{componentName}/properties/{propertyName}
- /data
- /data/datacapture
- /data/datacapture/{dataStoreName}
- /data/datacapture/{dataStoreName}/{msgId}
- /executiongroups
- /executiongroups/{egName}
- /executiongroups/{egName}/applications
- /executiongroups/{egName}/applications/{appName}
- /executiongroups/{egName}/applications/{appName}/libraries
- /executiongroups/{egName}/applications/{appName}/libraries/{libName}
- /executiongroups/{egName}/applications/{appName}/libraries/{libName}/messageflows
- /executiongroups/{egName}/applications/{appName}/libraries/{libName}/messageflows/{flowName}
- /executiongroups/{egName}/applications/{appName}/libraries/{libName}/messageflows/{flowName}/activitylog
- /executiongroups/{egName}/applications/{appName}/libraries/{libName}/messageflows/{flowName}/flowdesign
- /executiongroups/{egName}/applications/{appName}/libraries/{libName}/messageflows/{flowName}/flowdesign/policynode
- /executiongroups/{egName}/applications/{appName}/libraries/{libName}/messageflows/{flowName}/properties
- /executiongroups/{egName}/applications/{appName}/libraries/{libName}/messageflows/{flowName}/properties/{propertyName}
- /executiongroups/{egName}/applications/{appName}/libraries/{libName}/properties
- /executiongroups/{egName}/applications/{appName}/libraries/{libName}/resources
- /executiongroups/{egName}/applications/{appName}/libraries/{libName}/resources/{resourceName}
- /executiongroups/{egName}/applications/{appName}/libraries/{libName}/resources/{resourceName}/properties
- /executiongroups/{egName}/applications/{appName}/libraries/{libName}/subflows
- /executiongroups/{egName}/applications/{appName}/libraries/{libName}/subflows/{subflowName}
- /executiongroups/{egName}/applications/{appName}/libraries/{libName}/subflows/{subflowName}/flowdesign
- /executiongroups/{egName}/applications/{appName}/libraries/{libName}/subflows/{subflowName}/flowdesign/policynode
- /executiongroups/{egName}/applications/{appName}/libraries/{libName}/subflows/{subflowName}/properties
- /executiongroups/{egName}/applications/{appName}/messageflows
- /executiongroups/{egName}/applications/{appName}/messageflows/{flowName}
- /executiongroups/{egName}/applications/{appName}/messageflows/{flowName}/activitylog
- /executiongroups/{egName}/applications/{appName}/messageflows/{flowName}/flowdesign
- /executiongroups/{egName}/applications/{appName}/messageflows/{flowName}/flowdesign/policynode
- /executiongroups/{egName}/applications/{appName}/messageflows/{flowName}/properties
- /executiongroups/{egName}/applications/{appName}/messageflows/{flowName}/properties/{propertyName}
- /executiongroups/{egName}/applications/{appName}/properties
- /executiongroups/{egName}/applications/{appName}/references
- /executiongroups/{egName}/applications/{appName}/resources
- /executiongroups/{egName}/applications/{appName}/resources/{resourceName}
- /executiongroups/{egName}/applications/{appName}/resources/{resourceName}/properties
- /executiongroups/{egName}/applications/{appName}/subflows
- /executiongroups/{egName}/applications/{appName}/subflows/{subflowName}
- /executiongroups/{egName}/applications/{appName}/subflows/{subflowName}/flowdesign
- /executiongroups/{egName}/applications/{appName}/subflows/{subflowName}/flowdesign/policynode
- /executiongroups/{egName}/applications/{appName}/subflows/{subflowName}/properties
- /executiongroups/{egName}/deploy
- /executiongroups/{egName}/libraries
- /executiongroups/{egName}/libraries/{libName}
- /executiongroups/{egName}/libraries/{libName}/messageflows
- /executiongroups/{egName}/libraries/{libName}/messageflows/{flowName}
- /executiongroups/{egName}/libraries/{libName}/messageflows/{flowName}/activitylog
- /executiongroups/{egName}/libraries/{libName}/messageflows/{flowName}/flowdesign
- /executiongroups/{egName}/libraries/{libName}/messageflows/{flowName}/flowdesign/policynode
- /executiongroups/{egName}/libraries/{libName}/messageflows/{flowName}/properties
- /executiongroups/{egName}/libraries/{libName}/messageflows/{flowName}/properties/{propertyName}
- /executiongroups/{egName}/libraries/{libName}/properties
- /executiongroups/{egName}/libraries/{libName}/resources
- /executiongroups/{egName}/libraries/{libName}/resources/{resourceName}
- /executiongroups/{egName}/libraries/{libName}/resources/{resourceName}/properties
- /executiongroups/{egName}/libraries/{libName}/subflows
- /executiongroups/{egName}/libraries/{libName}/subflows/{subflowName}
- /executiongroups/{egName}/libraries/{libName}/subflows/{subflowName}/flowdesign
- /executiongroups/{egName}/libraries/{libName}/subflows/{subflowName}/flowdesign/policynode
- /executiongroups/{egName}/libraries/{libName}/subflows/{subflowName}/properties
- /executiongroups/{egName}/messageflows
- /executiongroups/{egName}/messageflows/{flowName}
- /executiongroups/{egName}/messageflows/{flowName}/activitylog
- /executiongroups/{egName}/messageflows/{flowName}/flowdesign
- /executiongroups/{egName}/messageflows/{flowName}/flowdesign/policynode
- /executiongroups/{egName}/messageflows/{flowName}/properties
- /executiongroups/{egName}/messageflows/{flowName}/properties/{propertyName}
- /executiongroups/{egName}/properties
- /executiongroups/{egName}/properties/{propertyName}
- /executiongroups/{egName}/pushapis/authenticate
- /executiongroups/{egName}/pushapis/catalogs
- /executiongroups/{egName}/pushapis/products
- /executiongroups/{egName}/pushapis/pushapi
- /executiongroups/{egName}/pushapis/stageproduct
- /executiongroups/{egName}/resourcemanagers
- /executiongroups/{egName}/resourcemanagers/{resourceManagerName}
- /executiongroups/{egName}/resourcemanagers/{resourceManagerName}/activitylog
- /executiongroups/{egName}/resourcemanagers/{resourceManagerName}/properties
- /executiongroups/{egName}/resourcemanagers/{resourceManagerName}/properties/{propertyName}
- /executiongroups/{egName}/resources
- /executiongroups/{egName}/resources/{resourceName}
- /executiongroups/{egName}/resources/{resourceName}/properties
- /executiongroups/{egName}/restapis
- /executiongroups/{egName}/restapis/{restApiName}
- /executiongroups/{egName}/restapis/{restApiName}/api
- /executiongroups/{egName}/restapis/{restApiName}/libraries
- /executiongroups/{egName}/restapis/{restApiName}/libraries/{libName}
- /executiongroups/{egName}/restapis/{restApiName}/libraries/{libName}/messageflows
- /executiongroups/{egName}/restapis/{restApiName}/libraries/{libName}/messageflows/{flowName}
- /executiongroups/{egName}/restapis/{restApiName}/libraries/{libName}/messageflows/{flowName}/activitylog
- /executiongroups/{egName}/restapis/{restApiName}/libraries/{libName}/messageflows/{flowName}/flowdesign
- /executiongroups/{egName}/restapis/{restApiName}/libraries/{libName}/messageflows/{flowName}/flowdesign/policynode
- /executiongroups/{egName}/restapis/{restApiName}/libraries/{libName}/messageflows/{flowName}/properties
- /executiongroups/{egName}/restapis/{restApiName}/libraries/{libName}/properties
- /executiongroups/{egName}/restapis/{restApiName}/libraries/{libName}/resources
- /executiongroups/{egName}/restapis/{restApiName}/libraries/{libName}/resources/{resourceName}
- /executiongroups/{egName}/restapis/{restApiName}/libraries/{libName}/resources/{resourceName}/properties
- /executiongroups/{egName}/restapis/{restApiName}/libraries/{libName}/subflows
- /executiongroups/{egName}/restapis/{restApiName}/libraries/{libName}/subflows/{subflowName}
- /executiongroups/{egName}/restapis/{restApiName}/libraries/{libName}/subflows/{subflowName}/flowdesign
- /executiongroups/{egName}/restapis/{restApiName}/libraries/{libName}/subflows/{subflowName}/flowdesign/policynode
- /executiongroups/{egName}/restapis/{restApiName}/libraries/{libName}/subflows/{subflowName}/properties
- /executiongroups/{egName}/restapis/{restApiName}/messageflows
- /executiongroups/{egName}/restapis/{restApiName}/messageflows/{flowName}
- /executiongroups/{egName}/restapis/{restApiName}/messageflows/{flowName}/activitylog
- /executiongroups/{egName}/restapis/{restApiName}/messageflows/{flowName}/flowdesign
- /executiongroups/{egName}/restapis/{restApiName}/messageflows/{flowName}/flowdesign/policynode
- /executiongroups/{egName}/restapis/{restApiName}/messageflows/{flowName}/properties
- /executiongroups/{egName}/restapis/{restApiName}/properties
- /executiongroups/{egName}/restapis/{restApiName}/references
- /executiongroups/{egName}/restapis/{restApiName}/resources
- /executiongroups/{egName}/restapis/{restApiName}/resources/{resourceName}
- /executiongroups/{egName}/restapis/{restApiName}/resources/{resourceName}/properties
- /executiongroups/{egName}/restapis/{restApiName}/subflows
- /executiongroups/{egName}/restapis/{restApiName}/subflows/{subflowName}
- /executiongroups/{egName}/restapis/{restApiName}/subflows/{subflowName}/flowdesign
- /executiongroups/{egName}/restapis/{restApiName}/subflows/{subflowName}/flowdesign/policynode
- /executiongroups/{egName}/restapis/{restApiName}/subflows/{subflowName}/properties
- /executiongroups/{egName}/services
- /executiongroups/{egName}/services/{svcName}
- /executiongroups/{egName}/services/{svcName}/interface
- /executiongroups/{egName}/services/{svcName}/interface/{operationName}
- /executiongroups/{egName}/services/{svcName}/interface/{operationName}/properties
- /executiongroups/{egName}/services/{svcName}/interfaceFiles
- /executiongroups/{egName}/services/{svcName}/interfaceFilesAsZip
- /executiongroups/{egName}/services/{svcName}/libraries
- /executiongroups/{egName}/services/{svcName}/libraries/{libName}
- /executiongroups/{egName}/services/{svcName}/libraries/{libName}/messageflows
- /executiongroups/{egName}/services/{svcName}/libraries/{libName}/messageflows/{flowName}
- /executiongroups/{egName}/services/{svcName}/libraries/{libName}/messageflows/{flowName}/activitylog
- /executiongroups/{egName}/services/{svcName}/libraries/{libName}/messageflows/{flowName}/flowdesign
- /executiongroups/{egName}/services/{svcName}/libraries/{libName}/messageflows/{flowName}/flowdesign/policynode
- /executiongroups/{egName}/services/{svcName}/libraries/{libName}/messageflows/{flowName}/properties
- /executiongroups/{egName}/services/{svcName}/libraries/{libName}/messageflows/{flowName}/properties/{propertyName}
- /executiongroups/{egName}/services/{svcName}/libraries/{libName}/properties
- /executiongroups/{egName}/services/{svcName}/libraries/{libName}/resources
- /executiongroups/{egName}/services/{svcName}/libraries/{libName}/resources/{resourceName}
- /executiongroups/{egName}/services/{svcName}/libraries/{libName}/resources/{resourceName}/properties
- /executiongroups/{egName}/services/{svcName}/libraries/{libName}/subflows
- /executiongroups/{egName}/services/{svcName}/libraries/{libName}/subflows/{subflowName}
- /executiongroups/{egName}/services/{svcName}/libraries/{libName}/subflows/{subflowName}/flowdesign
- /executiongroups/{egName}/services/{svcName}/libraries/{libName}/subflows/{subflowName}/flowdesign/policynode
- /executiongroups/{egName}/services/{svcName}/libraries/{libName}/subflows/{subflowName}/properties
- /executiongroups/{egName}/services/{svcName}/messageflows
- /executiongroups/{egName}/services/{svcName}/messageflows/{flowName}
- /executiongroups/{egName}/services/{svcName}/messageflows/{flowName}/activitylog
- /executiongroups/{egName}/services/{svcName}/messageflows/{flowName}/flowdesign
- /executiongroups/{egName}/services/{svcName}/messageflows/{flowName}/flowdesign/policynode
- /executiongroups/{egName}/services/{svcName}/messageflows/{flowName}/properties
- /executiongroups/{egName}/services/{svcName}/messageflows/{flowName}/properties/{propertyName}
- /executiongroups/{egName}/services/{svcName}/properties
- /executiongroups/{egName}/services/{svcName}/references
- /executiongroups/{egName}/services/{svcName}/resources
- /executiongroups/{egName}/services/{svcName}/resources/{resourceName}
- /executiongroups/{egName}/services/{svcName}/resources/{resourceName}/properties
- /executiongroups/{egName}/services/{svcName}/subflows
- /executiongroups/{egName}/services/{svcName}/subflows/{subflowName}
- /executiongroups/{egName}/services/{svcName}/subflows/{subflowName}/flowdesign
- /executiongroups/{egName}/services/{svcName}/subflows/{subflowName}/flowdesign/policynode
- /executiongroups/{egName}/services/{svcName}/subflows/{subflowName}/properties
- /executiongroups/{egName}/sharedlibraries
- /executiongroups/{egName}/sharedlibraries/{shlibName}
- /executiongroups/{egName}/sharedlibraries/{shlibName}/properties
- /executiongroups/{egName}/sharedlibraries/{shlibName}/references
- /executiongroups/{egName}/sharedlibraries/{shlibName}/referents
- /executiongroups/{egName}/sharedlibraries/{shlibName}/resources
- /executiongroups/{egName}/sharedlibraries/{shlibName}/resources/{resourceName}
- /executiongroups/{egName}/sharedlibraries/{shlibName}/resources/{resourceName}/properties
- /executiongroups/{egName}/sharedlibraries/{shlibName}/subflows
- /executiongroups/{egName}/sharedlibraries/{shlibName}/subflows/{subflowName}
- /executiongroups/{egName}/sharedlibraries/{shlibName}/subflows/{subflowName}/flowdesign
- /executiongroups/{egName}/sharedlibraries/{shlibName}/subflows/{subflowName}/flowdesign/policynode
- /executiongroups/{egName}/sharedlibraries/{shlibName}/subflows/{subflowName}/properties
- /executiongroups/{egName}/subflows
- /executiongroups/{egName}/subflows/{subflowName}
- /executiongroups/{egName}/subflows/{subflowName}/flowdesign
- /executiongroups/{egName}/subflows/{subflowName}/flowdesign/policynode
- /executiongroups/{egName}/subflows/{subflowName}/properties
- /logout
- /monitoring
- /monitoring/adminlog
- /monitoring/events
- /monitoring/events/{eventIdentifier}
- /policy
- /policy/{policyType}
- /policy/{policyType}/{policyName}
- /policy/businesstransactionrecorders
- /policy/businesstransactionrecorders/{intServName}
- /policy/businesstransactionrecorders/{ISName}
- /policy/configurableservices
- /policy/configurableservices/{configurableServiceType}
- /policy/configurableservices/{configurableServiceType}/{configurableServicename}
- /policy/configurableservices/{configurableServiceType}/{configurableServicename}/configurableServiceFile
- /policy/configurableservices/importConfigurableService
- /policy/DataCapture
- /policy/DataCapture/{policyName}
- /policy/MQEndpoint
- /policy/MQEndpoint/{policyName}
- /policy/MQTTPublish
- /policy/MQTTPublish/{policyName}
- /policy/MQTTSubscribe
- /policy/MQTTSubscribe/{policyName}
- /policy/securityidentities
- /policy/securityidentities/{resource}
- /portconfigurationexportasmodproxymodule
- /portconfigurationexportaswasplugin
- /properties
- /properties/{propertyName}
- /security
- /security/currentuser
- /security/currentuser/permissions
- /security/currentuser/profile
- /security/users
- /security/users/{username}
- /security/users/{username}/permissions
- /security/users/{username}/profile
- /test
- /test/recordedtestdata
There is also a WADL document describing the REST API.
Data Model
All endpoints act on a common set of data. The data can be represented with difference media (i.e. "MIME") types, depending on the endpoint that consumes and/or produces the data. The data can described by XML Schema, which definitively describes the XML representation of the data, but is also useful for describing the other formats of the data, such as JSON.
This document will describe the data using terms based on XML Schema. Data can be grouped by namespace, with a schema document describing the elements and types of the namespace. Generally speaking, types define the structure of the data and elements are instances of a type. For example, elements are usually produced by (or consumed by) a REST endpoint, and the structure of each element is described by its type.
Namespace "ns2"
Namespace URI: | (default namespace) |
XSD: | ns2.xsd |
Data Elements
- api
- basic
- basic
- btd
- businessEvents
- businessTransaction
- businessTransactionMonitoring
- configuration
- configurations
- description
- description
- description
- elements
- links
- mqConnectionDetailsPolicy
- policy
- policy
- policy
- policy
- policyProperties
- policyProperties
- policyProperties
- policyProperties
- testData
Data Types
- (anonymous)
- (anonymous)
- (anonymous)
- (anonymous)
- (anonymous)
- (anonymous)
- (anonymous)
- (anonymous)
- (anonymous)
- (anonymous)
- (anonymous)
- (anonymous)
- (anonymous)
- (anonymous)
- (anonymous)
- (anonymous)
- (anonymous)
- (anonymous)
- abstractElementsModelBean
- apiWrapper
- businessEventContainerBean
- businessEventModelBean
- businessTransactionModelBean
- imbTestDataObject
- linkModelBean
- operationWrapper
- parameterWrapper
- resourceWrapper
Namespace "ns1"
Namespace URI: | http://www.ibm.com/iib/apiv1/responseObject |
XSD: | ns1.xsd |
Data Elements
- activityLog
- activityLogEntry
- adminLog
- adminLogEntry
- application
- broker
- businessDataCaptureEntry
- businessDataCaptureStore
- checkpoint
- component
- configurableService
- currentUser
- dataCaptureEntry
- dataCaptureReplayResponse
- dataCaptureStore
- DataLocation
- event
- exception
- executionGroup
- flowDesign
- library
- messageFlow
- node
- nodeconnection
- operation
- Payload
- permissions
- policy
- profile
- properties
- property
- Publisher
- Publishers
- recordedTestData
- resource
- resourceManager
- restApi
- securityIdentity
- service
- sharedLibrary
- statisticsOutputFormat
- subFlow
- testData
- TransactionCorrelation
- user
- userDefinedProperty
Data Types
- api
- imbAccountingStatisticsResponseObject
- imbAccountStatsOutputFormatResponseObject
- imbActivityLogEntry
- imbActivityLogResponseObject
- imbAdminLogEntry
- imbAdminLogResponseObject
- imbApplicationResponseObject
- imbBusinessDataCaptureEntryResponseObject
- imbBusinessDataCaptureResponseObject
- imbBusinessTransactionDescription
- imbCheckpointResponseObject
- imbComponentResponseObject
- imbConfigurableServiceResponseObject
- imbCurrentUserResponseObject
- imbDataCaptureCustomizationsResponseObject
- imbDataCaptureEntryResponseObject
- imbDataCaptureReplayResponse
- imbDataCaptureResponseObject
- imbDeployedArtifactResponseObject
- imbDeployedResourcesResponseObject
- imbEventResponseDataLocation
- imbEventResponseObject
- imbEventResponsePayload
- imbEventResponsePublisher
- imbEventResponsePublishers
- imbEventResponseTransactionCorrelation
- imbExceptionResponseObject
- imbExecutionGroupResponseObject
- imbLibraryResponseObject
- imbMessageFlowDesignObject
- imbMessageFlowResponseObject
- imbNodeConnectionObject
- imbNodeObject
- imbPermissionObject
- imbPolicyResponseObject
- imbPropertiesObject
- imbPropertyObject
- imbRecordedTestDataResponseObject
- imbResourceManagerResponseObject
- imbRestApiResponseObject
- imbRootResponseObject
- imbSecurityIdentityResponseObject
- imbServiceOperationResponseObject
- imbServiceResponseObject
- imbSharedLibraryResponseObject
- imbSubFlowResponseObject
- imbTestDataResponseObject
- imbURI
- imbUserDefinedPropertyObject
- imbUserPermissionsObject
- imbUserProfileObject
- imbUserResponseObject
Namespace "ns3"
Namespace URI: | http://www.ibm.com/iib/apiv1/responseObject/businesstransaction |
XSD: | ns3.xsd |
Data Elements
Data Types
- abstractElementsModel
- businessEventContainer
- businessEventModel
- businessTransactionModel
- businessTransactionRecorder
- dataSource
- description
- flowElementsModel
- linkModel
Namespace "ns0"
Namespace URI: | http://www.ibm.com/iib/apiv1/responseObject/container |
XSD: | ns0.xsd |
Data Elements
- applications
- business
- businessDataCaptureStores
- businessTransactionRecorders
- businessTransactions
- components
- configurableServices
- configurableServiceTypes
- data
- dataCaptureStores
- events
- executionGroups
- interface
- libraries
- messageFlows
- monitoring
- policy
- policyType
- references
- referents
- resourceManagers
- resources
- restApis
- security
- securityIdentities
- services
- sharedLibraries
- subFlows
- test
- users
Data Types
- imbApplicationsContainerBean
- imbBusinessContainerBean
- imbBusinessDataCaptureContainerBean
- imbBusinessTransactionContainer
- imbBusinessTransactionRecorderContainer
- imbComponentContainerBean
- imbConfigurableServicesContainerBean
- imbConfigurableServiceTypeContainerBean
- imbDataCaptureContainerBean
- imbDataContainerBean
- imbDeployedResourcesContainerBean
- imbEgContainerBean
- imbEventsContainerBean
- imbGenericContainerBean
- imbLibrariesContainerBean
- imbMonitoringContainerBean
- imbMsgFlowsContainerBean
- imbPolicyContainerBean
- imbPolicyTypeContainerBean
- imbRecordedTestDataContainerBean
- imbReferencesContainerBean
- imbReferentsContainerBean
- imbResourceManagerContainerBean
- imbRestApisContainerBean
- imbSecurityContainerBean
- imbSecurityIdentityContainerBean
- imbServiceInterfaceContainerBean
- imbServicesContainerBean
- imbSharedLibrariesContainerBean
- imbSubFlowsContainerBean
- imbUsersContainerBean