The Return Query Parameters query pipeline stage is used to return query parameters as a pipeline response. The stage takes no additional properties beyond id, type, label, skip, and condition.
Query pipeline stage condition examples
Stages can be triggered conditionally when a script in the Condition field evaluates to true.
Some examples are shown below.
Run this stage only for mobile clients:
params.deviceType === "mobile"
Run this stage when debugging is enabled:
Run this stage when the query includes a specific term:
params.q && params.q.includes("sale")
Run this stage when multiple conditions are met:
request.hasParam("fusion-user-name") && request.getFirstParam("fusion-user-name").equals("SuperUser");
!request.hasParam("isFusionPluginQuery")
The first condition checks that the request parameter “fusion-user-name” is present and has the value “SuperUser”.
The second condition checks that the request parameter “isFusionPluginQuery” is not present.
Configuration
When entering configuration values in the UI, use unescaped characters, such as \t
for the tab character. When entering configuration values in the API, use escaped characters, such as \\t
for the tab character.