How to expose a REST-ful service

Manuals, How To, Integration, REST, External, Other System

Aware IM can expose a service you configure either as a SOAP-based web service or as a REST-ful service or both. For REST-ful services exposed by Aware IM applications that need to call the service need to call a particular URL using the HTTP protocol. This URL should include the Aware IM server name and port where Tomcat listens to requests and also the name of the service to be called and parameters. The default URL where Aware IM will listen to REST-ful requests has the following format:

http://ServerName:ServerPort/AwareIM/REST/BusinessSpace/ServiceName?parameters

Parameters are specified as paramName1=paramValue1&paramName2=paramValue2&…

Where paramName1, paramName2 etc are names of the attributes of a business object that is specified as input to the process implementing the service.

You can also specify your own custom URL in which case you also need to supply a file called rest.props

All the details are explained in the “Adding/Editing Services” section.