API Flow parameters

All API Flow request parameters, API Gateway step output parameters and Decision output parameters are available in API Flow as API Flow parameters.

The flow parameters can be data types such as string or integer, and JSON object.

The API flow parameters can be referenced in input fields as ${<activityName>.<parameterName>}, for example ${getInventory.list}. API Flow parameters coming directly from API Flow request are referenced using "input" instead of activity name, for example as ${input.store}.

You can also use the help function to select an API Flow parameter. On the selected input field, press CTRL+SPACE. A list of available API Flow parameters is displayed. Select an API Flow parameter to add to the input field.

In case an API Flow parameter is a JSON object. You can specify elements from the parameters with JSON Path expressions. For example, if an API Flow parameter contains a JSON Object:

{
    "store": {
        "book": [
            {
                "category": "reference",
                "author": "Nigel Rees",
                "title": "Sayings of the Century",
                "price": 8.95
            },
            {
                "category": "fiction",
                "author": "Evelyn Waugh",
                "title": "Sword of Honour",
                "price": 12.99
            }
        ],
        "bicycle": {
            "color": "red",
            "price": 19.95
        }
    },
    "expensive": 10
}

The category value from the second book is required. You can use this JSON Path:

${getInventory.list}.store.book[1].category

The result is "fiction".

For more information about the JSON path syntax, see https://github.com/json-path/JsonPath