Parameters

 

The parameters panel, bottom center, provides a space to define the input and output parameters for your API or module.

It is best to define the parameters before you begin building logic because the step plugins will provide the defined parameters as options when building steps.

API Input Parameters

When creating an API input parameter, you will specify if the parameter is coming from the query string, header, or body.

A fourth input parameter exists that comes from the Path. You specify this type when defining the path of the API endpoint and it is automatically added to the Input Parameter list.

Editing a Path parameter from the Input Parameters panel provides a limited dialog, as seen below, because the Name and From values are defined in the HTTP path definition

 

Module Parameter

API Output Parameters

You can create a different set of output parameters for each HTTP status code you add to the API file.

When creating an API output parameter, the output parameter you create will be associated with the HTTP status selected in the drop down.

HTTP Status codes added to the output parameters tab will be selectable in the Set API Output low code step.

 

Â