REST call from Blueriq

When you want to build a simple Blueriq model for your first call to 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.

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 of Domain schema. Once you have the required domain, all you need is an exposed flow that contains a page for the user input and the result, and a service call of type AQ_WebServiceClient.

If you want, have a look at the other visual about modeling a web service call from a (more realistic) project with separate implementation modules for the business model and the web service model. In that situation, you will need a data mapping.

When you want to build a simple Blueriq model for your first call to a SOAP web service (i.e. be the service requestor) you can use the example project WebCalculator (that comes with a standard Blueriq installation) to act as the service provider: create a new project based on this example project WebCalculator, save it and go to your runtime dashboard to expose it (if you don’t see the widget, press the button Widgets and check ‘Expose as a webservice’ and save it). When you do that, a button ‘View WSDL’ appears, that enables you to see and save the WSDL. This WSDL contains the communication contract between the service requestor and the service provider.

Now when you create a new project to model the service requestor, you can have a quick start by using the WSDL import wizard. That can generate for you the service model (i.e. the domain model from the service provider), the Schema set and SOAP service. Now all that is left for you to do, is to make an exposed flow that contains a page for the user input and the result, and a service call of type AQ_WebServiceClient.