Response Message Configuration Tab (OData and WS)

Context

The document describes how you need to proceed when configuring the response parameters for an OData or a Web service.

Procedure

Choose the Response Message Configuration tab.

All the parameters of the selected operation are already on this tab. The following data is displayed on the tab:

Checkbox	Description
Map HTTP Status	With this checkbox, you can specify that the HTTP_STATUS variable is included in the list of variables. Note You cannot rename this variable. The variable always has the type int. Note If you have selected the Map HTTP Status checkbox, any exceptions that occur when a Web service is called are ignored. Therefore, you first need to check if such exceptions could occur.
Return Raw Response	With this checkbox, you can define that the response of the service that is called is sent completely and without parsing. If you select the checkbox, all mapped variables, with the exception of HTTP_STATUS, are removed from the list of variables. The RAW_RESPONSE variable is included in the list of variables. Note You cannot rename this variable. The variable always has the type string.

Checkbox

Description

Map HTTP Status

With this checkbox, you can specify that the HTTP_STATUS variable is included in the list of variables.

Return Raw Response

With this checkbox, you can define that the response of the service that is called is sent completely and without parsing.

If you select the checkbox, all mapped variables, with the exception of HTTP_STATUS, are removed from the list of variables. The RAW_RESPONSE variable is included in the list of variables.

Screen Area	Description
List of Output Variables	All selected output variables of the response are displayed later in this area.
Response Message Configuration	This table contains the output parameters that you can configure.

You can configure the following for a parameter in the Response Message Configuration area:

Field	Description
Required Parameter	The checkbox indicates that an entry is required in the Value field in this row. The checkbox for required parameters is selected automatically and cannot be changed. If the checkbox is not selected, the entry is optional.
Parameter Name	The name of the parameter cannot be changed. It is based on the metadata description of the selected operation.
Parameter Type	The type of the parameter cannot be changed. It is based on the metadata description of the selected operation.
Output Variable	In the Output Variable column, you can specify either the variable name of the assigned variable for a parameter, or the Create pushbutton is displayed. The Create pushbutton is always displayed if the parameter is an array or a complex object with lower-level parameters.

Click on the Create pushbutton for the parameter you want.

The data structure for the parameter is opened and additional fields are offered in the structure.
If you select a row and choose , the system checks if it is a variable and proposes a name for the output variable, for example, outID.

The variable is flagged with the icon and added to the list of output variables.
You can use the Import Data Types into Data Type Repository button to import structured data types, array data types and enumeration data types from SOAP Web services and OData services. This simplifies data entry considerably, since only one variable then needs to be selected from the data type repository. (See also: Import Data Types into the Data Type Repository.)
To delete the variable name, choose .

Next Steps

Example: Create a Universal Web Service Destination System (OData)