Connect REST form - GET Response

Use the Response tab on the Methods tab of the Connect REST form to map the data from the GET response.

Headers

Use the fields in this section to map data from the HTTP header of the message. The data type of a header field is String.

Field Description
Name Enter the external name of the header field.
Description Enter a short description of the header field.
Map to Specify the destination or the type of destination for the value in Pega Platform :
  • Clipboard — Maps to the page name or property on the clipboard that is specified by the Map to key field.
Map to key Specify the key for locating the property or the rule in the destination that is specified in the Map to field:
  • If you map to Clipboard, enter the property name to which the data is mapped at run time.

Message data

Use the fields in this section to map the response data from the message.

Field Description
Description Enter a short description fior the incoming string. The data type of the message data is String.
Map to Specify the destination or the type of destination for the value in Pega Platform :
  • Clipboard — Maps to the page name or property on the clipboard that is specified by the Map to key field.
  • Parse XMLRule — The incoming data is a stream of XML that must be parsed by using the actions that is defined in a parse XML rule (an instance of the Rule-Parse-XML rule type).
  • JSON — The incoming data is a JSON-formatted stream that must be mapped to a Page or a Page List property on the clipboard.
Use fast processing This field is displayed when JSON is selected in the Map from field. For complex JSON structures, if the clipboard structure exactly matches the JSON structure, selecting this field improves processing speed. For this option to work properly, use the following guidelines when configuring your data model:
  • The JSON property names and the clipboard property names must match.
  • The JSON tree structure and the clipboard tree structure must be similar.
  • The scalar arrays in JSON must be mapped to the clipboard as page lists.
  • Multi-dimensional arrays must be mapped into page lists of page lists with the same embedded property names.

Page groups, value groups, and Java objects are not supported.
Map to key Specify the key for locating the property or the rule in the destination that is specified in the Map to field:
  • If you map to Clipboard, enter the property name to which the data is to be mapped.
  • If you map to XML Parse Rule, enter the Namespace name (second key part) and the Element — third key part — of the appropriate Parse XML rule. Separate the Namespace from the Element name with a space using the syntax "NamespaceName ElementName". The system uses the Applies to class of this connector rule as the first key part of the parse rule.
  • If you map to JSON, enter the property name to which the data will be mapped. The property should be Page or Page List mode.