API Flow elements

This table shows the API Flow definition and its predefined types of steps:

Step Description

API

API icon

A step to perform a call to an API operation. In this step, you can define an API request and output parameters.

See API step.

Parallel

Parallel icon

An unconditional execution of two or more execution branches in parallel. In this step, you can define parallel calls to multiple APIs. The API flow waits until all the API calls in each of the branches are completed.

See Parallel API flows.

Decision

Decision icon

An evaluation of an expression that has several possible follow-up branches. The default branch is executed when values in the other branches do not match the expression result. In this step, you can define conditional flows based on API response code, response message etc. The decision step is exclusive. Only one branch is executed to avoid conflicts and merging of the results.

See Decision API flows.

Filter

Yes or No Decision icon

A step that allows users to create a Yes or No decision to filter out or terminate certain results in the API call.

See Adding a Filter step

Do While

Do While icon
A step to sequentially perform a list of tasks as long as a condition is true. The list of tasks is performed first and then the condition is checked.

See Adding a Do While step.

JQ transform

JQ transform icon
A step to transform the response under certain conditions set by the user. The user specifies values or conditions and JQ Transform applies those to the call. If those conditions are met, then the output reflects that information.

Adding a JQ Transform step