Configuring REST Adapter Request Properties

Enter the REST Adapter request payload details for the endpoint.

What You Can Do from the REST Adapter Request Page

You can configure the following request payload details on the trigger or invoke REST Adapter Request page.

  • Select to include attachments with inbound requests
  • Specify the schema or JSON sample request payload file location
  • Select the type of payload with which you want the endpoint to reply

What You See on the REST Adapter Request Page

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

Element Description

Select the attachment processing options

Select the multipart attachment type to include with the inbound request.

  • Accept attachments from request: Select for the REST endpoint to process attachments from the inbound multipart request. This selection refreshes the page to display the Select the type of payload that you want the endpoint to receive field at the bottom of the page.

  • Request is HTML form: Select for the REST endpoint to accept to configure an HTML form. You must first select the Accept attachments from request option before you can select this option. This selection assumes that the media type is multipart/form-data.

Select the request payload file

Select the type of request payload file to use. The request payload body must be defined by the XSD element that defines the structure of this representation.
  • XML Schema

  • JSON Sample (Creates a sample JSON file.)

Schema Location

Click Browse to select the request schema file to use.

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.

Select the type of payload with which you want the endpoint to reply

Select the payload type with which you want the request payload to reply.
  • None: Select if no payload type is required.

  • XML: Displays the payload in XML format.

  • JSON: Displays the payload in JavaScript Object Notation (JSON) format.

  • URL-encoded: Displays the payload in URL-encoded format.

  • Other Media Type: Select to display the payload in another format (for example, application/oracle.cloud+json). You can only specify the media types that end with +json or +xml. The following media types are supported implicitly and cannot be configured. At runtime, the request media type is in the form of an http Content-Type header. The expected response media type is specified through an Accept header. Any service can be accessed through either of these media types.
    • Application/XML

    • Application/JSON

Select the type of payload that you want the endpoint to receive

(this field is displayed if you selected an option in Select the attachment processing options field)

Select the multipart attachment type for the endpoint to receive:
  • multipart/mixed: Send an XML or JSON payload type with an attachment. For example, send a PDF document for review as a link in an email.

  • multipart/form-data: Send an XML or JSON payload type with an attachment. For example, you create an HTML form to upload and send an image. In the HTML form, the method is defined as post and the enctype (encoding type) is defined as multipart/form-data.