Rest API

Introduction

This page acts as the specification for the OpenESB Rest API

URL mapping

By default, root URL is http://localhost:4848/openesb

The WADL is available through http://localhost:4848/openesb/application.wadl

URLMethodDescriptionMediaTypeState
Global
/GET

View OpenESB runtime informations : build number, copyright, full product name,

instance name, version, system info.

  
     
Service Assemblies
/assemblies?state=any|started|stopped|shutdown&component=name_of_a_componentGETList service assemblies  
/assembliesPUTInstall a service assemblymultipart/form-data 
/assemblies/{assemblyName}GETReturn service assembly informations  
/assemblies/{assemblyName}/descriptorGETReturn the XML descriptor for the service assembly  
/assemblies/{assemblyName}/action/startGETStart the service assembly  
/assemblies/{assemblyName}/action/stopGETStop the service assembly  
/assemblies/{assemblyName}/action/shutdown?force=true|falseGETShutdown the service assembly  
/assemblies/{assemblyName}DELETEUndeploy the service assembly  
/assemblies/{assemblyName}/statsGETView service assemblies statistics TODO
     
JBI Components (BC / SE)
/components?type=binding|engine&state=any|started|stopped|shutdown&library=sl_name&assembly=sa_nameGETList binding components / service engines  
/componentsPUTInstall a JBI Componentmultipart/form-data 
/components/{componentName}GETReturn informations about components  
/components/{componentName}/descriptorGETReturn the XML descriptor for the component  
/components/{componentName}/action/startGETStart component.  
/components/{componentName}/action/stopGETStop component.  
/components/{componentName}/action/shutdown?force=true|falseGETShutdown component.  
/components/{componentName}DELETEUndeploy JBI components TODO
/components/{componentName}/endpointsGETList active endpoints / active consuming endpoints for the component  
/components/{componentName}/endpoints/inGETList active consuming endpoints for the component  
/components/{componentName}/endpoints/outGETList active endpoints for the component  
/components/{componentName}/endpoints/statsPOSTView endpoint statisticsapplication/x-www-form-urlencoded 
/components/{componentName}/configurationGETRetrieve the component's configuration  
/components/{componentName}/variablesGETRetrieves the component's application variables  
/components/{componentName}/loggersGETRetrieves the component's loggers  
     
Shared Libraries
/libraries?component=name_of_a_componentGETList shared libraries  
/libraries/{libraryName}GETReturn informations about the shared library  
/libraries/{libraryName}/descriptorGETReturn the XML descriptor for the shared library  
     
NMR
/nmrGETInformations about NMR : active channels / active endpoints / last restart time / ...  
/nmr/statsGETMessaging statistics TODO
/nmr/endpointsGETList active endpoints / active consuming endpoints registered in the NMR  
/nmr/endpoints/inGETList active consuming endpoints registered in the NMR  
/nmr/endpoints/outGETList active endpoints registered in the NMR