Response Message Configuration Tab (RESTful)

Context

This document describes the procedure for response message configuration for a RESTful Web service. For the RESTful Web service, the table with the response variables is empty at first. You have to choose Extend Selected Mapping to create the parameters.

Procedure

Choose the Response Message Configuration tab.

The following checkboxes are 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.

Choose to create a parameter.

The Add Response Mapping dialog box appears.

Enter the following in the dialog box:

Field	Description
Parameter	Specify the path for the parameter that is to be mapped. For a RESTful service, you can also specify the object $out as a root element here. This name is reserved for body style Web requests that are used for serializing the response parameters (without wrapper elements). Note If you enter an invalid parameter, a small red symbol with an exclamation mark is displayed in front of the text box for the parameter.
Type	Select the parameter type. The following types are supported: binary base64Binary boolean byte date dateTime dateTimeOffset jsDate double duration float GUID int32 single string stream Note The parameter type cannot be changed later.
Variable	The variable name is proposed here automatically. All the response variables have the prefix out.

Field

Description

Parameter

Specify the path for the parameter that is to be mapped.

For a RESTful service, you can also specify the object $out as a root element here. This name is reserved for body style Web requests that are used for serializing the response parameters (without wrapper elements).

Type

Select the parameter type. The following types are supported:

Variable

The variable name is proposed here automatically. All the response variables have the prefix out.

Choose the Add pushbutton.

The variable is copied into the Response Message Configuration table and into the table of output variables. In the table, only the variable name (in the Output Variable column) can be changed.
If you choose Select Data Type for an output 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 output variable in order to transfer complex and deeply nested data objects. This reduces the configuration effort significantly.
If you want to remove a parameter from the table completely, select the row and choose .