The HTTP endpoint allows you to define REST endpoints using URI templates similar to the REST API. The URI templates allow a RESTful URI to contain variables that can be populated during mediation runtime using property values whose names have the "
uri.var." prefix. An HTTP endpoint can also define the particular HTTP method to use in the RESTful invocation.
You can configure the HTTP endpoint using XML. Click on Switch to source view link in the HTTP Endpoint page.
The syntax is as follows.
HTTP Endpoint Attributes
The URI template that constructs the RESTful endpoint URL at runtime.
Using the URI postfix property:
Let's take a look at it using an example. If you add a
The HTTP method to use during the invocation.
The following page is opened by clicking HTTP Endpoint in the Add Endpoint tab of the Manage Endpoints page.
The parameters to configure an HTTP endpoint are as follows.
|Name||This parameter is used to enter a unique name for the endpoint.|
The URI template of the endpoint. Insert
If the endpoint URL is an encoded URL, then you need to add
The HTTP method to use during the invocation of the endpoint. Supported methods are as follows.
|Show Advanced Options||Click this link if you want to add advanced options to the endpoint. See Advanced Options for details of common advanced options you can add.|
You can create HTTP endpoints by specifying values for the parameters given above.
Alternatively, you can specify one parameter as the HTTP endpoint by using multiple other parameters, and then pass that to define the HTTP endpoint as follows:
Example 1 - populating an HTTP endpoint during mediation
The URI template variables in this example HTTP endpoint can be populated during mediation as follows:
This configuration will cause the RESTful URL to evaluate to: