REST API

The REST API component is an application component that allows users to make requests to external REST APIs. It can carry out the following tasks:

#Release Stage

Alpha

#Configuration

The component configuration is defined and maintained here.

#Setup

FieldField IDTypeNote
Authentication (required)authenticationobjectAuthentication method to use for the REST API

#Supported Tasks

#Get

Send a HTTP GET request.

InputIDTypeDescription
Task ID (required)taskstringTASK_GET
Endpoint Url (required)endpoint-urlstringThe API endpoint url
Bodyoutput-body-schemastringThe request body
OutputIDTypeDescription
Status Codestatus-codeintegerThe HTTP status code of the response
BodybodyanyThe body of the response
HeaderheaderobjectThe HTTP header of the response

#Post

Send a HTTP POST request.

InputIDTypeDescription
Task ID (required)taskstringTASK_POST
Endpoint Url (required)endpoint-urlstringThe API endpoint url
BodybodyanyThe request body
Bodyoutput-body-schemastringThe JSON schema of output body
OutputIDTypeDescription
Status Codestatus-codeintegerThe HTTP status code of the response
BodybodyanyThe body of the response
HeaderheaderobjectThe HTTP header of the response

#Patch

Send a HTTP PATCH request.

InputIDTypeDescription
Task ID (required)taskstringTASK_PATCH
Endpoint Url (required)endpoint-urlstringThe API endpoint url
BodybodyanyThe request body
Bodyoutput-body-schemastringThe JSON schema of output body
OutputIDTypeDescription
Status Codestatus-codeintegerThe HTTP status code of the response
BodybodyanyThe body of the response
HeaderheaderobjectThe HTTP header of the response

#Put

Send a HTTP PUT request.

InputIDTypeDescription
Task ID (required)taskstringTASK_PUT
Endpoint Url (required)endpoint-urlstringThe API endpoint url
BodybodyanyThe request body
Bodyoutput-body-schemastringThe JSON schema of output body
OutputIDTypeDescription
Status Codestatus-codeintegerThe HTTP status code of the response
BodybodyanyThe body of the response
HeaderheaderobjectThe HTTP header of the response

#Delete

Send a HTTP DELETE request.

InputIDTypeDescription
Task ID (required)taskstringTASK_DELETE
Endpoint Url (required)endpoint-urlstringThe API endpoint url
BodybodyanyThe request body
Bodyoutput-body-schemastringThe JSON schema of output body
OutputIDTypeDescription
Status Codestatus-codeintegerThe HTTP status code of the response
BodybodyanyThe body of the response
HeaderheaderobjectThe HTTP header of the response

Send a HTTP HEAD request.

InputIDTypeDescription
Task ID (required)taskstringTASK_HEAD
Endpoint Url (required)endpoint-urlstringThe API endpoint url
Bodyoutput-body-schemastringThe request body
OutputIDTypeDescription
Status Codestatus-codeintegerThe HTTP status code of the response
BodybodyanyThe body of the response
HeaderheaderobjectThe HTTP header of the response

#Options

Send a HTTP OPTIONS request.

InputIDTypeDescription
Task ID (required)taskstringTASK_OPTIONS
Endpoint Url (required)endpoint-urlstringThe API endpoint url
BodybodyanyThe request body
Bodyoutput-body-schemastringThe JSON schema of output body
OutputIDTypeDescription
Status Codestatus-codeintegerThe HTTP status code of the response
BodybodyanyThe body of the response
HeaderheaderobjectThe HTTP header of the response

Last updated: 7/2/2024, 1:19:14 PM