HTTP request

This activity allows you to configure the HTTP activity to access RESTful Web APIs in your workflow. You can send requests using HTTP to web services to retrieve or update data. The HTTP activity encapsulates the header and body of the API request, making it easy to use within your workflow.

Table 1. Http request action - Inputs
Parameters Description

Method

The HTTP action to execute (GET, PUT, POST, DELETE, HEAD, OPTIONS or CONNECT).

Url

The URL to send in the HTTP request.

Connection

Optional third-party connection object to be used for the HTTP request.

RetryPolicies

An array of retry options for the HTTP request.

Each array element is an object with the following syntax:
{
"ErrorStatusCodes": [429, 500], 
"RetryCount": 3,
"RetryIntervalSec": 1
}
  • ErrorStatusCode: Defines the status codes matched against the http response to determine which retry policy to use.

  • RetryCount: Number of times the Http activity will retry the request before moving on.

  • RetryIntervalSec: The amount of time the Http activity will wait before retrying. The http activity will generate an exponential back-off interval based on the current retry count.

Table 2. Http request action - Throughputs
Parameters Description

Headers

Array of header key/value pairs to be sent in the HTTP request.

Body

Contents of the HTTP request to be sent.

Table 3. Http request action - Outputs
Parameters Description

RetryCount

Number of attempts to send the HTTP request.

StatusCode

HTTP status code returned from the request.

Success

Indicates whether the activity was completed successfully (value = True) or not (value = False)