Query Stages API
Table of Contents
API Objective: Each step of a query pipeline.
The Query Stages API provides endpoints to list query stage configuration properties.
Get the properties for the "apply-defaults" type:
REQUEST
curl -u USERNAME:PASSWORD https://FUSION_HOST:FUSION_PORT/api/query-stages/schema/set-paramsRESPONSE
{
"type" : "object",
"title" : "Additional Query Parameters",
"description" : "This stage allows you to set, append, and remove additional query parameters",
"properties" : {
"skip" : {
"type" : "boolean",
"title" : "Skip This Stage",
"description" : "Set to true to skip this stage.",
"default" : false,
"hints" : [ "advanced" ]
},
"label" : {
"type" : "string",
"title" : "Label",
"description" : "A unique label for this stage.",
"hints" : [ "advanced" ],
"maxLength" : 255
},
"condition" : {
"type" : "string",
"title" : "Condition",
"description" : "Define a conditional script that must result in true or false. This can be used to determine if the stage should process or not.",
"hints" : [ "code", "javascript", "advanced" ]
},
"params" : {
"type" : "array",
"title" : "Parameters and Values",
"items" : {
"type" : "object",
"required" : [ "key" ],
"properties" : {
"key" : {
"type" : "string",
"title" : "Parameter Name"
},
"value" : {
"type" : "string",
"title" : "Parameter Value"
},
"policy" : {
"type" : "string",
"title" : "Update Policy",
"enum" : [ "replace", "append", "remove", "default" ],
"default" : "append"
}
}
}
}
},
"category" : "Advanced",
"categoryPriority" : 2