Relationship REST Has REST Connection

A REST connection can be used to specify a specific 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 TEST 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 if loops are allowed in the status handler, that is, the status handler action can reference itself.

The default value is true.

Response Code Pattern [M] String Specifies the response code(s) to be handled by this status handler.

Must be specified as a regular expression.

Perform Action [M] Action Descriptor Specifies which action should be performed when the status handler is triggered.
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.