Call an external endpoint (Currently Http(s))
Table 1. Supported parameters
| Parameter |
Required |
Data type |
Details |
| cache |
No |
object |
Specify to cache using expire and scope |
| endpoint |
Yes |
object |
The Endpoint configuration to use for the invoke action |
| inputMessage |
No |
string or null |
The name of a message that will be used to form the request |
| outputMessage |
No |
string or null |
The name of a message that will be used to store the response data from the request |
Table 2. Nested properties inside
endpoint
| Parameter |
Required |
Data type |
Details |
| http |
Yes |
object |
The Endpoint configuration to use for the invoke action |
Table 3. Nested properties inside
http
| Parameter |
Required |
Data type |
Details |
| statusException |
No |
array |
Throw a selected set of CatchErrorConfig errors else CatchErrorConfig of type CustomError
with the response code and canonical message if the response code matches any of the listed pattern
entries |
| target |
Yes |
object |
The configuration of the HTTP Endpoint |
| verb |
No |
string or null |
The HTTP method to use for the Invoke. Keep the method of the incoming request if
unspecified |
Table 4. Nested properties inside
statusException
| Parameter |
Required |
Data type |
Details |
| pattern |
Yes |
object |
3 character pattern match for HTTP status code of 0-9 or * for any. Must match regular
expression: ^[0-9\*]{3}$ |
Table 5. Nested properties inside
target
| Parameter |
Required |
Data type |
Details |
| chunkedUpload |
No |
boolean |
Specify to use `transfer-encoding: chunked`` or to use input message headers and payload type
unmodified. Default to use incoming (false) |
| compressRequest |
No |
object |
Specify which compression to use. Default to None. Set Accept-Encoding header with all
supported types. Handle Content-Encoding with all supported types |
| decompressResponse |
No |
boolean |
Specify if response should be decompressed |
| followRedirects |
No |
boolean |
Specify to follow redirects, default to false |
| persistentConnections |
No |
boolean |
Specify to use persistent connections, default to true |
| timeout |
No |
integer |
The time to wait before a reply from the endpoint (in seconds). The default value is 20.
Value must be greater or equal to 0.0. |
| tlsClientProfile |
No |
string or null |
The TLS profile to use for the secure transmission of data |
| url |
Yes |
string |
The URL for the target service |
| urlType |
No |
object |
Indication of how url string is interpreted |
| version |
No |
object |
The HTTP version to use. The default is to keep the version of the incoming request |
Table 6. Options for urlType
| Parameter |
Required |
Data type |
Details |
| plain |
No |
enum (of string) |
Plain string value |
| variables |
No |
enum (of string) |
Interpret $(var) as variable substitution |
| distributedVariable |
No |
enum (of string) |
Interpret string as a distributed variable |
| jsonata |
No |
enum (of string) |
Interpret string as a JSONata expression |
Table 7. Options for version
| Parameter |
Required |
Data type |
Details |
| HTTP/1.0 |
No |
enum (of string) |
Specifies the HTTP protocol version |
| HTTP/1.1 |
No |
enum (of string) |
Specifies the HTTP protocol version |
| HTTP/2 |
No |
enum (of string) |
Specifies the HTTP protocol version |