Configuring a REST Resource Using the URL Template-Based Approach

Hybrid Integration 10.2 | Integrating On-Premises Applications | Document Conventions | Working with REST | Configuring a REST Resource Using the URL Template-Based Approach

Creating a REST V2 Resource

Defining a REST V2 Resource Operation

Example of Defining a REST V2 Resource Operation

Deleting a REST V2 Resource Operation

You can use the URL template-based approach to configure REST resources. In this approach, you define a URL template that serves as a template for client requests to use and invoke the resources.

REST resources configured using this approach, also known as REST V2 resources, are invoked with the restv2 directive. For each resource, you must define operations that include the following:

The format of the URL that REST clients must follow when sending requests to Integration Server acting as the REST server.

The HTTP methods supported by the REST resource.

The flow service associated with a resource operation. You can either associate an existing service with a resource operation or create a new service and associate it with the resource operation.

The URL template-based approach provides you with greater flexibility than the legacy approach in defining REST resources. For a REST V2 resource, you can define multiple operations and associate each operation with a URL template, HTTP methods, and a flow service. In addition, you can edit these details based on your requirements.

Note: A REST V2 resource is represented by the

icon in the Package Navigator view.

You cannot configure REST V2 resources when Integration Server is deployed in a multitenanted environment.