Connect REST form - PATCH Request

Use the Request tab on the Methods tab of the Connect REST form to map data for the PATCH request message.

Headers

Use the fields in this section to map data for HTTP header fields. 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 from Specify the source or the type of source of the value:
  • Clipboard — Maps from the page name or property on the clipboard that is specified by the Map from key field.
  • Constant — The data is a fixed value that does not change.
Map from key Specify the key for locating the property or rule in the source that is specified in the Map from field.
  • If you map from Clipboard, enter the property name from which the data is mapped at run time.
  • If you map from Constant, enter the value of the constant surrounded by quotation marks.

Message data

Use the fields in this section to map the request body payload from the message.

Field Description
Description Enter a short description of the string in the request body payload. The data type of the message data is String.
Map from Specify the source or the type of source of the value:
  • Clipboard — The source is a property or a page on the clipboard.
  • Constant — The source is a fixed value.
  • JSON — The source is a stream of JSON data that is formatted from a Page or Page List property.
  • XML Stream — The source is a stream of XML data that is formatted by an XML Stream rule.
  • HTML Stream — The source is a stream of HTML data that is formatted by an HTML rule.
Use fast processing This field is displayed when you select JSON 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 correctly, 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 from key Specify the key for locating the property or rule in the source that is specified in the Map from field:
  • If you map from Clipboard, enter the reference to the property from which the data is mapped at run time.
  • If you map from Constant, enter a literal text string. To include blank spaces in your text string, surround the string with double quotes.
  • If you map from JSON, enter the reference to the property from which the JSON data is generated and mapped at run time. You must specify properties of mode Page or Page List.
  • If you map from XML Stream, enter either the Stream name (second key) of the appropriate XML Stream rule or a page name and stream name by using the syntax PageName.StreamName. The page must be on the clipboard when the service rule runs for rule resolution to find the rule. If you specify the stream name only, the system uses the Applies to class of this connector rule as the first key part of the XML Stream rule.
  • If you map from HTML Stream, enter either the Stream name (second key) of the appropriate HTML rule or a page name and stream name by using the syntax PageName.StreamName. The page must be on the clipboard when the service rule runs for rule resolution to find the rule. If you specify the stream name only, the system uses the Applies to class of this connector rule as the first key part of the HTML rule.
Map as This field is displayed when you select Clipboard in the Map from field. If the content is mapped from a Java object property that contains a byte array, select Binary, otherwise, select Text.