Don't get lost: IMan Guides » IMan User Guide » Setup Tabs » Webservices » Webservice Lookups

Webservice Lookups

A webservice lookup allows you to perform a GET operation to a REST based webservice. The result of the service is then parsed.

ID

The id of the lookup. The ID value forms the first argument in the WebserviceLookup function.

Description

A friendly description of the authentication.

Webservice Behaviour

The webservice behaviour used for authentication and the base Url.

Content Type

Select whether the returning value will be Xml or JSON.

Query Url

This may be only the query path or the full Url. The Query path is combined with Base Url to form the full Url.

The url may be parameterised using by specifying placeholders in the form of %1, %2, %3, and so on, where the each placeholder is replaced with the corresponding values supplied from WebserviceLookup.

Each parameter should be enclosed in square brackets due to the spaceless nature of Urls e.g. %[1], %[2].

Return Path

The return path specifies the path of the value being returned from the lookup.

The return path should be in the either syntax of XPath or JPath dependent on the return content type of the lookup.

In the example above, the return path is returning the “id” property from the first object of the “customers” array.

The return path is optional and can be overridden from the returnpath parameter from the WebserviceLookup function.