Connect REST form – Completing the Methods tab

Use the Methods tab to map the data for the request and from the response for each of the HTTP methods allowed for this particular resource.

GET Request tab

Use the Request tab to map the data for the GET request.

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 — Map from the page name or property on the clipboard specified by the Map from key field.
  • Constant — The data is a fixed value that does not change.
Map from key Specify the key to locating the property or rule in the source specified in the Map from field.
  • If the Map from value is Clipboard, enter the property name from which the data is mapped at run time.
  • If the Map from value is Constant, enter the value of the constant surrounded by double quote characters.
  • Constant — The data is a fixed value that does not change.

Use the fields in this section to specify name/value pairs to append as a query string to the resource URL of the target system.

Field Description
Name Enter the name to use for the parameter. The data type of a query string parameter is String.
Description Enter a short description of the parameter.
Map from Specify the source or the type of source of the value in Pega Platform. For descriptions of the Map from options, see the definition of the Map from field in the Headers section.
Map from key Specify the key to locating the property or rule in the source specified in the Map from field. For descriptions of the Map from key options, see the definition of the Map from key field in the Headers section.

GET Response tab

Use the Response tab to map the data from the GET response.

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 — Map to the page name or property on the clipboard specified by the Map to key field.
Map to key Specify the key to locating the property or the rule in the destination specified in the Map to field:
  • If the Map to value is Clipboard, enter the property name to which the data is mapped at run time.

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

Field Description
Description Enter a short description of 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 — Map to the page name or property on the clipboard specified by Map to key field.
  • Parse XMLRule — The incoming data is a stream of XML that must be parsed using the actions 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.
Map to key Specify the key to locating the property or the rule in the destination specified in the Map to field:
  • If the Map to value is Clipboard, enter the property name to which the data is to be mapped.
  • If the Map to value is 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" rather than "NamespaceName.ElementName." The system uses the Applies to class of this connector rule as the first key part of the parse rule.
  • If the Map to value is JSON, enter the property name to which the data is to be mapped. The property should be of mode Page or Page List.

POST Request tab

Use the Request tab to map data for the POST request message.

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 — map to the page name or property on the clipboard specified by the Map from key field.
  • Constant — The data is a fixed value that does not change.
Map from key Specify the key to locating the property or the rule in the destination specified in the Map from field:
  • If the Map from value is Clipboard, enter the property name from which the data is mapped at run time.
  • If the Map from value is Constant, enter the value of the constant surrounded by double quote characters.

Use the fields in this section to specify name/value pairs to append as a query string to the resource URL of the target system.

Field Description
Name Enter the name to use for the parameter. The data type of a query string parameter is String.
Description Enter a short description of the parameter.
Map from Specify the source or the type of source of the value in Pega Platform. For descriptions of the Map from options, see the definition of the Map from field in the Headers section.
Map from key Specify the key to locating the property or rule in the source specified in the Map from field. For descriptions of the Map from key options, see the definition of the Map from key field in the Headers section.

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

Field Description
Description Enter a short description of the string in the response. 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 formatted from a Page or Page List property.
  • XML Stream — The source is a stream of XML data formatted by an XML Stream rule.
  • HTML Stream — The source is a stream of HTML data formatted by an HTML rule.
Map from key Specify the key to locating the property or rule in the source specified in the Map from field:
  • If the Map from value is Clipboard, enter the reference to the property from which the data is mapped at run time.
  • If the Map from value is Constant, enter a literal text string. To include blank spaces in your text string, surround the string with double quotes.
  • If the Map from value is JSON, enter the reference to the property from which JSON data is generated and mapped at run time. Only properties of mode Page or Page List must be specified.
  • If the Map from value is XML Stream, enter either the Stream name (second key) of the appropriate XML Stream rule or a page name and stream name using the syntax PageName.StreamName. (The page must be on the clipboard when the connector 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 the Map from value is HTML Stream, enter either the Stream name (second key) of the appropriate HTML rule or a page name and stream name 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.

POST Response tab

Use the Response tab to map the data from the POST response.

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 — map to the page name or property on the clipboard specified by the Map to key field.
Map to key Specify the key to locating the property or the rule in the destination specified in the Map to field:
  • If the Map to value is Clipboard, enter the property name to which the data is mapped at run time.

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

Field Description
Description Enter a short description of 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 — Map to the page name or property on the clipboard specified by Map to key field.
  • Parse XMLRule — The incoming data is a stream of XML that must be parsed using the actions 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.
Map to key Specify the key to locating the property or the rule in the destination specified in the Map to field:
  • If the Map to value is Clipboard, enter the property name to which the data is to be mapped.
  • If the Map to value is 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" rather than "NamespaceName.ElementName." The system uses the Applies to class of this connector rule as the first key part of the parse rule.
  • If the Map to value is JSON, enter the property name to which the data is to be mapped. The property should be of mode Page or Page List.

PUT Request tab

Use the Request tab to map data for the PUT request message.

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 — Map from the page name or property on the clipboard specified by the Map from key field.
  • Constant — The data is a fixed value that does not change.
Map from key Specify the key to locating the property or the rule in the destination specified in the Map from field:
  • If the Map from value is Clipboard, enter the property name from which the data is mapped at run time.
  • If the Map from value is Constant, enter the value of the constant surrounded by double quote characters.

Use the fields in this section to specify name/value pairs to append as a query string to the resource URL of the target system.

Field Description
Name Enter the name to use for the parameter. The data type of a query string parameter is String.
Description Enter a short description of the parameter.
Map from Specify the source or the type of source of the value in Pega Platform. For descriptions of the Map from options, see the definition of the Map from field in the Headers section.
Map from key Specify the key to locating the property or rule in the source specified in the Map from field. For descriptions of the Map from key options, see the definition of the Map from key field in the Headers section.

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

Field Description
Description Enter a short description of the string in the response. 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 formatted from a Page or Page List property.
  • XML Stream — The source is a stream of XML data formatted by an XML Stream rule.
  • HTML Stream — The source is a stream of HTML data formatted by an HTML rule.
Map from key Specify the key to locating the property or rule in the source specified in the Map from field:
  • If the Map from value is Clipboard, enter the reference to the property from which the data is mapped at run time.
  • If the Map from value is Constant, enter a literal text string. To include blank spaces in your text string, surround the string with double quotes.
  • If the Map from value is JSON, enter the reference to the property from which JSON data is generated and mapped at run time. Only properties of mode Page or Page List must be specified.
  • If the Map from value is XML Stream, enter either the Stream name (second key) of the appropriate XML Stream rule or a page name and stream name using the syntax PageName.StreamName. (The page must be on the clipboard when the connector 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 the Map from value is HTML Stream, enter either the Stream name (second key) of the appropriate HTML rule or a page name and stream name 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.

PUT Response tab

Use the Response tab to map the data from the PUT response.

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 — map to the page name or property on the clipboard specified by the Map to key field.
Map to key Specify the key to locating the property or the rule in the destination specified in the Map to field:
  • If the Map to value is Clipboard, enter the property name to which the data is mapped at run time.

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

Field Description
Description Enter a short description of 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 — Map to the page name or property on the clipboard specified by Map to key field.
  • Parse XMLRule — The incoming data is a stream of XML that must be parsed using the actions 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.
Map to key Specify the key to locating the property or the rule in the destination specified in the Map to field:
  • If the Map to value is Clipboard, enter the property name to which the data is to be mapped.
  • If the Map to value is 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" rather than "NamespaceName.ElementName." The system uses the Applies to class of this connector rule as the first key part of the parse rule.
  • If the Map to value is JSON, enter the property name to which the data is to be mapped. The property should be of mode Page or Page List.

DELETE Request tab

Use the Request tab to map data for the DELETE request message.

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 — Map from the page name or property on the clipboard specified by the Map from key field.
  • Constant — The data is a fixed value that does not change
Map from key Specify the key to locating the property or the rule in the destination specified in the Map from field:
  • If the Map from value is Clipboard, enter the property name from which the data is mapped at run time.
  • If the Map from value is Constant, enter the value of the constant surrounded by double quote characters.

Use the fields in this section to specify name/value pairs to append as a query string to the resource URL of the target system.

Field Description
Name Enter the name to use for the parameter. The data type of a query string parameter is String.
Description Enter a short description of the parameter.
Map from Specify the source or the type of source of the value in Pega Platform. For descriptions of the Map from options, see the definition of the Map from field in the Headers section.
Map from key Specify the key to locating the property or rule in the source specified in the Map from field. For descriptions of the Map from key options, see the definition of the Map from key field in the Headers section.

Use the fields in this section to specify the data to include in the DELETE message.

Field Description
Description Enter a short description of the string in the response. 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 formatted from a Page or Page List property.
  • XML Stream — The source is a stream of XML data formatted by an XML Stream rule.
  • HTML Stream — The source is a stream of HTML data formatted by an HTML rule.
Map from key Specify the key to locating the property or rule in the source specified in the Map from field:
  • If the Map from value is Clipboard, enter the reference to the property from which the data is mapped at run time.
  • If the Map from value is Constant, enter a literal text string. To include blank spaces in your text string, surround the string with double quotes.
  • If the Map from value is JSON, enter the reference to the property from which JSON data is generated and mapped at run time. Only properties of mode Page or Page List must be specified.
  • If the Map from value is XML Stream, enter either the Stream name (second key) of the appropriate XML Stream rule or a page name and stream name using the syntax PageName.StreamName. (The page must be on the clipboard when the connector 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 the Map from value is HTML Stream, enter either the Stream name (second key) of the appropriate HTML rule or a page name and stream name 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.

DELETE Response tab

Use the Request tab to map the data from the DELETE response.

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 — map to the page name or property on the clipboard specified by the Map to key field.
Map to key Specify the key to locating the property or the rule in the destination specified in the Map to field:
  • If the Map to value is Clipboard, enter the property name to which the data is mapped at run time.

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

Field Description
Description Enter a short description of 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 — Map to the page name or property on the clipboard specified by Map to key field.
  • Parse XMLRule — The incoming data is a stream of XML that must be parsed using the actions 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.
Map to key Specify the key to locating the property or the rule in the destination specified in the Map to field:
  • If the Map to value is Clipboard, enter the property name to which the data is to be mapped.
  • If the Map to value is 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" rather than "NamespaceName.ElementName." The system uses the Applies to class of this connector rule as the first key part of the parse rule.
  • If the Map to value is JSON, enter the property name to which the data is to be mapped. The property should be of mode Page or Page List.