Configuring REST Adapter Basic Information Properties

Enter the REST Adapter user name, description, 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.

Topics

What You Can Do from the REST Adapter Basic Info Page

You can specify the following values on the trigger (source) or invoke (target) REST Adapter Basic Info page. The REST Adapter Basic Info page is the initial wizard page that is displayed when you drag a REST Adapter to the trigger (source) or invoke (target) area.

  • Specify a meaningful name.
  • Add a description of endpoint responsibilities.
  • Specify the relative resource URI of the endpoint.
  • Select the HTTP action for the endpoint to perform.
  • Add endpoint parameters, configure the endpoint request payload, or configure the endpoint to receive the response. Based on the HTTP action selected, you can configure multiple options.
  • Select to configure standard and custom HTTP request and response headers.
  • Select to configure cross origin resource sharing (CORS).

What You See on the REST Adapter Basic Info Page

The following table describes the key information on the REST Adapter Basic Info page.

Element Description

What do you want to call your endpoint?
Provide a meaningful name so that others can understand the connection. For example, if you are creating a source Oracle REST connection, you may want to name it ExposeFlowAsRESTResource. You can include English alphabetic characters, numbers, underscores, and dashes in the name. You cannot include the following:

  • Blank spaces (for example, My REST Connection)

  • Special characters (for example,  #;83& or res(t)4)

  • Multibyte characters

What does this endpoint do?

Enter an optional description of the connection’s responsibilities (for example,This inbound REST connection exposes this integration flow as a REST resource).

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: 
http://host:port/integration/flowapi/rest/INTEGRATION_NAME

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

http://host:port/integration/flowapi/rest/EXPOSEFLOWASRESTRESOURCE

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

host:port/integrations

What action does the endpoint perform?
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.

Based on your selections, you can add parameters or configure a request and/or response for this endpoint
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.