Configuring a REST Resource Using the URL Template-Based Approach

Cloud Application Integration (On-Premises) : Service Development : Working with REST : Configuring a REST Resource Using the URL Template-Based Approach

Configuring a REST Resource for a Service

Editing a REST Resource for a Service

Deleting a REST Resource for a Service

Starting with version 10.0 of Designer, you can use the URL template-based approach to configure REST resources for an existing Integration Server service. You need to specify:

The format of the URL that your applications must follow when sending requests to Integration Server acting as the REST server. The URL format functions as a template for the application requests to the REST server.

The HTTP methods that the REST resource will support.

The URL template-based approach provides you with greater flexibility than the legacy approach in defining REST resources. For an existing service, you can define multiple REST resources and associate each resource with a URL format of your choice and HTTP methods. In addition, you can edit the URL format associated with a REST resource based on your requirements.

REST resources configured using the URL template-based approach are invoked with the restv2 directive.

Note:

Unlike for a REST resource created using legacy approach, Designer does not create a separate folder or flow services corresponding to the supported HTTP methods for a REST resource that uses the URL template-based approach.

Note:

A REST resource configured using the URL template-based approach cannot be used in a REST API descriptor.

Contact Support | Community | Feedback