REST call from Blueriq

When you want to build a simple Blueriq model to experiment with calling a REST web service (i.e. be the service requestor), you can choose from a wide range of REST service providers. Some providers require you to register first to obtain an API-key that you must include in your request, but there are also API-key-free providers. You can check this blog for some nice examples (although I noticed that the very nice 'song lyrics' REST service is not available anymore, due to copyright reasons).

Most REST service providers publish documentation, either with an XSD Schema set (just like you use in a SOAP call) or more free-format documentation. They usually include one or more example request and response messages, from which you can (should be able to) derive a Domain schema. In your REST service, you can choose between an XSD Schema set or a Domain schema. The first option with an XSD is for services that accept and send XML messages, and that is similar to calling a SOAP service. If a different format such as JSON is required (like in this visual), you should use a Domain schema.

Once you have the required domain model, all you need is an exposed Flow element that contains a page for the user input and the result, and a Service call type: AQ_RestServiceClient.

This visual shows a simple Blueriq model, without data mapping. If you want, have a look at the other visual SOAP call with data mapping, about modeling a web service call from a (more realistic) project with separate implementation modules for the business model and the web service model. The data mapping part of that visual applies to both SOAP and REST calls.