Add the REST Adapter as a Trigger Connection

When you drag the REST Adapter into the integration canvas as a trigger connection, the Adapter Endpoint Configuration Wizard is invoked. Based on your selections in the wizard, the following pages can be displayed.

REST Adapter Trigger Resource Configuration Page

Enter the REST Adapter operation name, relative resource URI, and endpoint action. You can also select to add query and template parameters or configure a request and/or response for the endpoint.

Element Description

Provide an operation name

Enter an operation name.

What does this operation do?

Enter an optional description of the operation's responsibilities.

What is the endpoint’s relative resource URI?

Specify the relative path associated with the resource. The path can contain template parameters specified with curly braces (for example, {order-id}). A resource is any source of specific information that can be addressed. The resource path follows a fixed, prefixed URL appended with the specified relative path. By default, the URL is prefixed with the following path:
https://instance_URL/ic/api/integration/v1/flows/rest/INTEGRATION_NAME/VERSION

For example, if the integration name is ExposeFlowAsRESTResource, the URL becomes:

https://instance_URL/ic/api/integration/v1/flows/rest/EXPOSEFLOWASRESTRESOURCE

You can override the URL, except for the fixed part at the beginning:

instance_URL/ic

What action do you want to perform on the endpoint?

Select a single HTTP action (method) for the endpoint to perform:
  • GET: Retrieves (reads) information (for example, makes queries). If you select this option, you cannot configure a request payload for this endpoint.

  • PUT: Updates information.

  • POST: Creates information.

  • DELETE: Deletes information. If you select this option, you cannot configure a request payload for this endpoint.

    PATCH: Partially updates existing resources ( for example, when you only need to update one attribute of the resource).

    Note: The PATCH verb does not work with a non-SSL REST service.

Select any options that you want to configure

Select the options that you want to configure:
  • Add and review parameters for this endpoint: Click to specify the query parameters and view the template request parameters created as part of the resource URI for this endpoint. If you select this option and click Next, the Request Parameters page is displayed.

  • Configure a request payload for this endpoint: Click to configure the request payload for this endpoint, including specifying the schema location and payload type with which you want the endpoint to reply. You can also select this option if you want to include an attachment with the inbound request. If you select this option and click Next, the Request page is displayed.

  • Configure this endpoint to receive the response: Click to configure the response payload for this endpoint, including specifying the schema location and payload type that you want the endpoint to receive. If you select this option and click Next, the Response page is displayed.

Configure Request Headers?

Select the type of request header to configure:

  • Standard: Select to configure standard HTTP headers for the request message.

  • Custom: Select to configure custom HTTP headers for the request message.

Configure Response Headers?

Select the type of response header to configure:

  • Standard: Select to configure standard HTTP headers for the response message.

  • Custom: Select to configure custom HTTP headers for the response message.

Configure CORS (Cross Origin Resource Sharing)

(available only in the trigger (inbound) direction)

Select to configure CORS parameters for a trigger. CORS enables restricted resources (for example,. custom HTTP headers that introduce cross-site Java scripting security issues) on a web page to be requested from another domain outside of the domain from which the resource originated.

REST Adapter Trigger Operations Page

Review or edit existing operations or add a new operation. Each operation represents a different pick action branch in a single integration. The maximum number of operations (branches) you can create in one integration is six. Each entry point can be configured with a different resource URI and HTTP action/verb, as necessary. This feature eliminates the need to create multiple integrations (each with a separate resource URI and verb) to perform different operations. You can expose multiple entry points to a single orchestrated integration with a pick action that uses the REST Adapter as the trigger connection.

See Receive Requests for Multiple Resources in a Single REST Adapter Trigger Connection of Using Integrations in Oracle Integration.

Element Description
Operation Displays the operation name entered on the Resource Configuration page.
Resource Displays the endpoint relative resource URL selected on the Resource Configuration page.
HTTP Method Displays the action selected on the Resource Configuration page.
Edit/Delete Select to edit or delete an operation and its endpoint relative resource URL and action.
Add another operation Select to return to the Resource Configuration page to add another operation name, endpoint relative resource URL, and action.