API Call

When to use

This policy is used when you want to make a call to another API which can be from the platform or external

Details

In a flow you may want to get the data from outside either to make a decision or to add data to to one of the policies inputs or to the data that is sent to the backend API call.

You can use “API Call” policy to make an API call. 

Configuration

The configuration fields for the policy are:

[* Indicates a mandatory field]

Name *: Display name of the policy

Description: Description of policy

Enabled: Flag to indicate if the policy is enabled. If this field is not checked, the policy will be ignored at runtime and any fields from its output will contain a default initial value

Continue on Error: Flag to indicate that the flow should continue even if this policy throws an error

URL*: The url of the API to be called. This should be complete URL including domain name and path

Method*: HTTP method to be called on the API

Connection Timeout: The time in milliseconds for which the attempt to connect to the API url will be tried before timing out 

Response Timeout: The time in milliseconds for which the call will wait to get response from the API before timing out 

Circuit Breaker Threshold*: The number of API requests that fail before the circuit breaker will activate 

Circuit Breaker Window(minutes)*: The amount of time in which the calls will be counted for circuit breaker threshold

Circuit Break Duration(minutes)*: The amount of time (in minutes) for which the circuit breaker will be applied once it is activated

Circuit Breaker Message: The message to be sent in response in case the request is received when the circuit breaker is active 

Input fields

requestBody: The body of contents to be sent in request

headers: A collection of name and value pairs for headers

parameters: A collection of name and value pairs for parameters

Output fields

responseBody: The body of contents to received in response

headers: A collection of name and value pairs for headers received in response