1. Developing SOA Applications with Oracle SOA Suite
  2. Using Binding Components
  3. Integrating REST Operations in SOA Composite Applications
  4. Creating REST Support in Service and Reference Binding Components
  5. How to Configure the REST Binding Component in a SOA Composite Application
  6. REST Method Definition Dialog

REST Method Definition Dialog

Use the REST Method Definition dialog to define REST methods for a SOA REST service or reference that uses WADL and untyped payloads without schemas.

Table 37-3 REST Method Definition Dialog

Field Description

Method

Enter a name for the REST method being defined.

Resource

Select an existing URL resource path from the list or click the Add icon to add a new resource path.

HTTP Verb

Select the verb to be bound to the WSDL operation (for example, GET, PUT, POST, or DELETE).

Description

Enter an optional description. This is the description text to be published for the method.

Request
The Payload section enables you to specify the format of the request payload:
  • JSON (default selection)
  • XML
  • URL-encoded
  • Text
  • Opaque
  • No Payload
  • Other: Configure the REST binding with multipart form data by selecting the Other option and specify multipart/formdata. With the multipart form data support, you can receive and upload files to the Oracle Database. You can process both inbound (upload) and outbound (read files) requests and call REST APIs that support multipart form data.

Click Generate Sample URL for Method to view a sample URL for the method operation.

The URI Parameters section enables you to specify the mapping from the REST query or template parameters to the corresponding runtime property.

  1. Click the Generate Sample URL for Method icon (first icon) to generate a sample URL based on all previously entered binding information. This option is typically selected after all parameters are configured.

  2. Click the Add parameter icon (second icon) to manually add a mapping parameter.

  3. Under Style, select query or template. Template variables are typically used for POST and PUT operations. Query parameters are typically used for GET and Delete operations.

  4. Under Type, select the data type of the parameter. All XSD primitive types are supported.

  5. Under Default Value, you can set a default value at design time for a parameter. If a URI parameter is missing in the REST request, the corresponding default value is used by the REST service.

  6. The Runtime Property displays the name of the runtime property to which the method parameter gets mapped.

To assign values to query parameters:

  1. Double-click the invoke action that calls the REST binding component.
  2. Select Properties > To.
  3. Select the query parameter from the dropdown list and assign a variable or expression to it. For more information about the invoke activity, see Invoke Activity.

Response

The Success and Failure sections enable you to select the response Payload and Status for the method.

The default response payload is No Payload. The default HTTP status code for a successful operation is 204 and that for a failed operation is 500.