Request Message Configuration Tab (RESTful)

Prerequisites

You have entered the URL for the RESTful Web service in the Endpoint URL field.

Context

This document describes the manual procedure for the request message configuration for a RESTful Web service. For the RESTful Web service, the table with the request parameters is still empty at first. To create the parameters, choose Extend Selected Mapping. Alternatively, you can also call this function from the context menu of the table. (See also: Context Menu.)

Alternatively, you can enter the parameters using a template. (See also: Configure Message from Template.)

The parameters can be fixed values or variables. These are passed on to the request as a URL parameter or as JSON in the request body.

The variables that are defined here are mapped later on the Destinations tab in output destination mapping so that they contain the correct content of the inbound data.

Procedure

  1. In the Method field, you select the method that you want to use for calling the RESTful Web service. The GET method is the default value.
  2. Choose Extend Selected Mapping to create a parameter.

    The Add Request Mapping dialog box appears.

  3. In the dialog box, you enter the data for a parameter (see also: Add a Request or Response Mapping and Examples of Request Message Parameters (RESTful)).
  4. Enter additional parameters if necessary.

    The Required Parameter checkbox indicates that the parameter is mandatory. The checkbox is selected automatically and cannot be changed. The fields Parameter Name and Parameter Type are grayed out in the request message configuration table because they cannot be changed. The OrgUnit icon indicates that the field, for example, n1, is a higher-level field (type: object) that contains additional fields. The Request Variable icon indicates an input variable.

  5. The table of input variables is displayed to the right of the configuration table. All parameters that you have flagged as input variables are included in the list.
  6. If you choose Select Data Type for an input variable of the type structured data type, the PCo data type repository appears, where you can select the (previously imported) structured data type. (See also: Select Data Type (Selection Dialog).)

    In this case, you only have to enter a single variable in order to transfer complex and deeply nested data objects. This reduces the configuration effort significantly.

  7. If you want to change a value, click in the relevant cell and change the value. Choose Enter or click on another row to save.
  8. If you want to remove a higher-level field (with all the variables) from the table completely, select the row for the field or the row of a variable and choose Delete Selected Mapping.
  9. If you select a variable in the table and choose Remove Variable, the parameter becomes a fixed value again. The variable icon is then hidden.
  10. If you choose Propose Variable, the variable checkbox is selected and the variable name appears in the table.
  11. You can use the Import Data Types into Data Type Repository pushbutton to import the entire message configuration as a single structured data type into the PCo data type repository, so that in future you only have to define a single root variable of the type structured data type. (See also: Import Data Types into the Data Type Repository.)

Example

Examples of Request Message Parameters (RESTful)