Method

Displays the WSDL operation name that is being mapped. You can specify the name that is used in the generated WSDL.

Resource

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

The selected resource path is added to the URI Parameters table of the Request section at the bottom of this dialog. If the selected resource contains a template variable, such as {var}, the variable is added to the URI parameters.

HTTP Verb

Select the operation to perform (for example, GET, PATCH, PUT, POST, DELETE).

When you pick a schema for the request, actions are taken based on the verb. URI parameters are added if the verb does not have a payload (GET, DELETE). The URI Parameters table is populated with mappings from the incoming REST query parameters to the WSDL schema. The PATCH verb is used to partially update a resource, and the PUT verb is used to replace resource entirely.

The HTTP verb for the operation is also added to the Operation Bindings section of the Create REST Binding dialog.

Description

Enter an optional description. Reference binding components have the Base URI field.

Request

The Schema section displays the request schema being used.

• Schema URL: Displays the request schema to use. If you selected REST enable component or reference in the Create REST Binding dialog, this field is read-only because the schema is obtained from the service's operation WSDL. If you selected Add operation binding in the Create REST Binding dialog, you must browse for a schema or create a new schema from a sample using the Native Format Builder wizard.

• Element: Displays the element to use.

The Payload section enables you to specify the format of the request payload: XML (default selection), JSON, URL-encoded, Text, Opaque or no payload. You can choose Other option and define custom payload type. Click Generate Sample Payload to view a sample of the selected request payload.

The URI Parameters section enables you to specify the mapping from the REST query parameters to the WSDL schema. This section is automatically populated when a schema is specified (depending on the verb) in the HTTP Verb list. For GET and DELETE verbs, the parameters are bound to the WSDL schema. For POST and PUT verbs, the inbound payload is mapped to the WSDL schema.

1. Click the Generate Sample URL for operation 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. In the Style column, click a specific row to invoke a list that enables you to 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. In the Type column, select the data type of the parameter. All XSD primitive types are supported. In most case, when the parameter is automatically generated from a schema, the type is already set for you. If you create a new parameter, the Type column enables you to select the type from the list.

5. In the Default Value column, 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. In the Expression column, click a specific row to invoke the Expression Builder dialog for adding an XPath expression function. If there is no schema defined for an operation, the Expression Builder parameter only shows property variables and no message variables. The expression binds a parameter to a field in the WSDL schema. In all cases in which the parameter has been automatically generated (based on an existing or generated schema), this expression is already generated for you. You only add an expression if you want to add a new parameter and bind it to something else, such as a runtime property. The XPath expression specifies the location in which to insert the particular URI parameter in the normalized message.

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 HTTP Statuses section enables you to specify the HTTP status code. You can enter multiple statuses, separated by spaces. For a reference, these are the possible statuses that are interpreted as successful. For a service, these are the possible successful statuses that can be returned (as set by a service component such as BPEL).

The Payload section enables you to specify the possible response payloads: XML (default), JSON, URL-Encoded, Text, Opaque or no payload. You can choose Other option and define custom payload type. The output returned at runtime depends on the incoming requests. Click Generate Sample Payload to view a sample of the selected response payload.

The Schema section displays the response schema being used if a possible payload type has been selected. If no payload has been selected, this field is not displayed.

• Schema URL: Displays the response schema to use. If you have not specified a schema, you can select to browse for an existing schema or create a new schema from a sample with the Native Format Builder wizard. This wizard enables you to create a schema from a JSON interchange format, XML sample, URI-encoded format, or URI sample. For more information, see How to Generate Schemas from Samples.

• Element: Displays the element to use.

The Fault Bindings section displays the response fault name, type, status, and schema. If fault details are defined in the WSDL file, a fault binding is automatically created in this section. You can also manually define fault bindings.by clicking the Add icon. For more information about faults, see What You May Need to Know About REST Fault Binding.