Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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.

Image Added

API Parameters

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

Image Added

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

Image Added 

Module Parameter

Image Added