AppConnectRESTRequest node
Use the AppConnectRESTRequest node to interact with an IBM® App Connect REST API.
- Developer
- Application Integration Suite
- Standard
- Advanced
- Express
- Scale
- Adapter
This topic contains the following sections:
Purpose
You can use an AppConnectRESTRequest node in a message flow to issue requests to an IBM App Connect REST API. The AppConnectRESTRequest node uses an imported Swagger document (in either JSON or YAML format), which defines the REST API and the operations that are available. When you have downloaded the API, you can import it from your toolkit workspace and select the operations that you want to invoke.
The AppConnectRESTRequest node handles response messages in the JSON domain.
The AppConnectRESTRequest node is contained in the Cloud Connectors drawer of the palette, and is represented in the IBM Integration Toolkit by the following icon:
Using the AppConnectRESTRequest node in a message flow
The AppConnectRESTRequest node can be used in a message flow to invoke an App Connect REST API. For information about how to use it, see Connecting to an App Connect REST API.
Terminals and properties
The AppConnectRESTRequest node terminals are described in the following table.
| Terminal | Description |
|---|---|
| In | The input terminal that accepts a message for processing by the node. |
| Failure | The output terminal to which the message is routed if a failure is detected during processing in the node. |
| Out | The output terminal to which the message is routed if it represents successful completion of the App Connect REST API request, and if further processing is required within this message flow. |
| Error | The output terminal to which messages that include an HTTP status code that is not in the range 200 through 299, including redirection codes (3xx), are routed. |
The following tables describe the node properties. The column headed M indicates whether the property is mandatory (marked with an asterisk on the panel if you must enter a value when no default is defined); the column headed C indicates whether the property is configurable (you can change the value when you add the message flow to the BAR file to deploy it).
The AppConnectRESTRequest node Description properties are described in the following table.
| Property | M | C | Default | Description |
|---|---|---|---|---|
| Node name | No | No | The node type, AppConnectRESTRequest | The name of the node. |
| Short description | No | No | A brief description of the node. | |
| Long description | No | No | Text that describes the purpose of the node in the message flow. |
The AppConnectRESTRequest node Basic properties are described in the following table.
| Property | M | C | Default | Description | mqsiapplybaroverride command property |
|---|---|---|---|---|---|
| Definitions file | Yes | No | The name of a file containing the definitions for the App Connect REST API that you want to invoke. This file must be a valid Swagger 2.0 document, and can be in either JSON or YAML format. The file must exist in your workspace. | ||
| Operation | Yes | No | The name of the operation in the App Connect REST API that you want to invoke. | ||
| Security identity | No | Yes | The name of the security identity object that
contains the user ID, password, and API key to be used by the integration
node to authenticate to the App Connect REST
API. Use the mqsisetdbparms command
to create and configure the security identity object, and to set the
user ID, password, and API key to be accessed by the integration node.
The credentials can be specified in the security identity in any one
of the following combinations:
The default value for this property is an empty string, which signifies that the AppConnectRESTRequest node will not attempt to authenticate to the App Connect REST API. For more information about App Connect REST API security identity support, see mqsisetdbparms command. |
securityIdentity | |
| Request timeout (sec) | Yes | Yes | 120 | The time in seconds that the node waits for a response from the App Connect REST API. The valid range is 1 through (231)-1. You cannot enter a value that represents an unlimited wait. The timeout might take up to one second longer than the specified value. | timeoutForServer |
| Base URL override | No | Yes | The base URL to use when making an HTTP request to the App Connect REST API. By default, the base URL from the App Connect REST API definitions file is used. | baseURL |
The AppConnectRESTRequest node Request properties are described in the following table.
| Property | M | C | Default | Description |
|---|---|---|---|---|
| Parameters | No | No | The parameters table displays the current list of parameters for the operation that is selected on the Basic tab. For each parameter shown, you can specify an XPath or ESQL expression in the Expression column, to specify a value (either a literal or a message tree path) for that parameter. Alternatively, the values for parameters can be provided in the LocalEnvironment. | |
| Content-Type | No | No | The value of the Content-Type header to send
in the request to the App Connect REST
API. By default, the AppConnectRESTRequest node
determines a Content-Type to use based on the input message. For example,
if the input message contains an XMLNSC message, the Content-Type
header in the request will be application/xml. You
can select a Content-Type from the REST API definitions file, or you
can specify your own Content-Type. |
|
| Input body location | Yes | No | $Body | The location in the incoming message tree from which data is retrieved to form the HTTP request body that is sent from the AppConnectRESTRequest node to the App Connect REST API. The default value, $Body, represents the incoming message body. You can enter any XPath or ESQL expression that defines the location of the message tree to serialize and send to the App Connect REST API. |
| Property | M | C | Default | Description |
|---|---|---|---|---|
| Events | No | No | None | Events that you have defined for the node are
displayed on this tab. By default, no monitoring events are defined
on any node in a message flow. Use Add, Edit,
and Delete to create, change or delete monitoring
events for the node; see Configuring monitoring event sources by using monitoring properties for details. You can enable and disable events that are shown here by selecting or clearing the Enabled check box. |
Local environment overrides
You can dynamically override set values in the local environment in the same way as setting values in other elements of a message. The AppConnectRESTRequest node uses the same LE overrides as the RESTRequest node. For more information, see Using local environment variables with REST nodes.