Relationship REST Has REST Connection

A REST connection can be used to specify a status handler for all tools of a REST application.

Attribute Type Description
Realm String The realm name maps the connection to the REST tools specified in the AWM model.

Specifying a realm name is only necessary when your AWM application refers to different REST applications.

Relationship Cardinality Description
Has_Request_Header 0..* Specify a request header to be used in every REST tool defined for this connection.
Has_Status_Handler 0..* Specify a REST application wide handling of certain status codes returned by the corresponding REST tools.

Relationship: REST Connection Has Request Header

The relationship REST Connection Has Request Header enables you to specify a name/value pair to be sent in the HTTP request header for every REST tool related to this connection.

Attribute Type Description
Name String Name of the HTTP header field.
Value String Value of the HTTP header field.

Relationship: REST Connection Has Status Handler

The relationship REST Connection Has Status Handler enables you to specify a REST application-wide handling of certain status codes returned by the corresponding REST tools.

Attribute Type Description
Allow Loop [M] Boolean Specifies whether the status handler can call an action which contains the tool for which the status handler is defined. Attribute values are:
true
The status handler can execute the action specified in the Perform Action, even if this contains the REST tool for which the status handler is defined.
false
The status handler stops executing when a cyclic execution is detected when the action specified in the Perform Action is called.

The default value is true.

Fail Action [O] Action Descriptor Specifies the action to be executed if the maximum loop count is reached in case of a cyclic execution.

This attribute is only relevant when the attribute Allow Loop is set to true.

Max Loop Count [O] Integer Specifies the maximum number of loop cycles when a loop is detected.

The default value is 3.

Note: This attribute is only relevant when the attribute Allow Loop is set to true. In this case, the action specified under the attribute Fail Action is executed as soon as the maximum loop count is reached.
Perform Action [M] Action Descriptor Specifies which action should be performed when the status handler is triggered.
Response Code Pattern [M] String Specifies the response code(s) to be handled by this status handler.

Must be specified as a regular expression.

Structure Descriptor [O] File Descriptor File containing the structure for the response that is specific for the matched status code.
Workflow Execution [M] Selection Specifies the impact on the original action of the handled REST tool.

It describes how the action containing the REST tool is continued after the status handler action specified under the attribute Perform Action was executed. Attribute values are:

Stop Execution
Stop the execution of the action that executes the REST tool.
Execute Tool Again
Execute the REST tool again and continue the execution of the action.
Continue Execution
Continue the execution of the action.