Add the REST Adapter as an Invoke Connection
When you drag the REST Adapter into the integration canvas as an invoke connection, the Adapter Endpoint Configuration Wizard is invoked. Based on your selections in the wizard, the following pages can be displayed.
Topics:
REST Adapter Invoke Basic Information Page
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.
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:
|
What does this endpoint do? |
Enter an optional description of the connection’s responsibilities (for example, |
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:
For example, if the integration name is
You can override the URL, except for the fixed part at the beginning:
|
What action do you want to perform on the endpoint? |
Select a single HTTP action (method) for the endpoint to perform:
|
Select any options that you want to configure |
Select the options that you want to configure:
|
Configure Request Headers? |
Select the type of request header to configure:
|
Configure Response Headers? |
Select the type of response header to configure:
|
REST Adapter Invoke Request Parameters Page
Enter the REST Adapter request parameters for this endpoint.
Element | Description |
---|---|
Resource URI |
Displays the endpoint relative resource URI entered on the Basic Info page. |
HTTP Method | Displays the action to perform on the endpoint that you selected on the Basic Info page. |
Specify Query Parameters |
Specify query parameters for the REST endpoint. Click the Add icon to display a row for entering the parameter name and selecting its data type. For example, specify Click the Delete icon to delete a selected row. |
Template Parameters |
Displays the template parameters in the relative resource URI. Template parameters are based on details you specified on the Basic Info page and cannot be edited. Template parameters must be defined as part of a path with curly braces around them. For example, the URL Note:
|
REST Adapter Invoke Request Page
Enter the REST Adapter request payload details for the endpoint.
Element | Description |
---|---|
Select the multipart attachment processing options |
|
Select the request payload format |
Note:
Select the request payload format to use. The request payload body must be defined by the XSD element that defines the structure of this representation.
|
Schema Location |
Specify the schema file in either of the following ways:
|
Element |
Select the element that defines the payload structure. This field is not displayed until you import the request payload file. Once you browse for and select the schema or JSON sample file, the schema is displayed automatically. It also displays a combination box that selects the root element by default. |
What is the media-type of the Request Body? (Content-Type Header) |
Select the multipart attachment type for the endpoint to receive. This field is
displayed if you selected the Request is multipart with
payload option.
|
Send Query Parameter as form-data in message body |
Select if you want to pass URL-encoded form data in the
payload. The values are derived from the query parameters you
defined on the Request Parameters page. However, instead of
submitting the query parameters, they are sent as form data in the
message body with this option selected. This field is only displayed
if you made the following selections in the Adapter Endpoint
Configuration Wizard:
|
REST Adapter Invoke Request Headers Page
Enter the REST Adapter request header properties for this endpoint.
Note:
If you specify a custom header name that is the same as a standard header name, an error occurs. Ensure that you specify unique names for your custom headers.Specify the standard HTTP request headers to use.
Element | Description |
---|---|
Add Standard Request Headers |
Select the standard HTTP request header to use from the default dropdown list.
|
HTTP Header Name |
Perform the following tasks:
|
Specify the custom HTTP request headers to use.
Element | Description |
---|---|
Add Custom Request Headers |
Perform the following custom request header tasks:
|
Custom Header Name |
Enter the custom header name. |
Custom Header Description |
Enter an optional description. |
REST Adapter Invoke Response Page
Enter the REST Adapter response payload details for the endpoint.
Element | Description |
---|---|
Resource URI |
Displays the endpoint relative resource URI entered on the Basic Info page. |
HTTP Method | Displays the action to perform on the endpoint that you selected on the Basic Info page. |
Select the multipart attachment processing options |
Configure the following options based on whether the request is inbound or outbound. For inbound (trigger) responses, select the multipart attachment type to include.
|
Select the response payload format |
Note:
Select the response payload format to use. The response payload body must be defined by the XSD element that defines the structure of this representation.
|
Schema Location |
Specify the schema file in either of the following ways:
|
Element |
Select the element that defines the payload structure. This field is not displayed until you import the response payload file. Once you browse for and select the schema file, it displays a combination box that selects the root element by default. |
What is the media-type of the Response Body? (Accept Header) |
Select the payload type with which you want the endpoint to reply.
Select the multipart attachment type for the endpoint to receive. This field is
displayed if you selected the Response is multipart with
payload option.
|
REST Adapter Invoke Response Header Page
Enter the REST Adapter response header properties for this endpoint.
Note:
If you specify a custom header name that is the same as a standard header name, an error occurs. Ensure that you specify unique names for your custom headers.Specify the standard HTTP response headers to use.
Element | Description |
---|---|
Add Standard Response Headers |
Select the standard HTTP response header to use from the default dropdown list.
|
HTTP Header Name |
Perform the following tasks:
|
Specify the custom HTTP response headers to use.
Element | Description |
---|---|
Add Custom Response Headers |
Perform the following custom response header tasks:
|
Custom Header Name |
Enter the custom header name. |
Custom Header Description |
Enter an optional description. |
REST Adapter Invoke Operation Selection Page
Enter the REST Adapter invoke operation selection parameters for this endpoint.
Element | Description |
---|---|
Business Object |
Select the business object (resource) to use in this connection. |
Operations |
Select the operation (method) to perform on the business object in this connection. |
Summary Page
You can review the specified adapter configuration values on the Summary page.
Element | Description |
---|---|
Summary |
Displays a summary of the configuration values you defined on previous pages of the wizard. The information that is displayed can vary by adapter. For some adapters, the selected business objects and operation name are displayed. For adapters for which a generated XSD file is provided, click the XSD link to view a read-only version of the file. To return to a previous page to update any values, click the appropriate tab in the left panel or click Go back. To cancel your configuration details, click Cancel. Click
generate a sample cURL to
generate sample |