VariablesSearchRequest

VariablesSearchRequest - query object to search tasks variables by provided variable names.

Schema

{
    "variableNames": [string]
}

Example value

{
  "includeVariables": [
    {
      "name": "variable_name",
      "alwaysReturnFullValue": false
    }
  ]
}

Fields

VariablesSearchRequest.variableNames ● string list

Name of variables to find.

VariablesSearchRequest.includeVariables ● IncludeVariable list

An array used to specify a list of the variables that should be included in the response.

Notes

VariablesSearchRequest.variableNames and VariablesSearchRequest.includeVariables cannot be used together in the same API request.

It is recommended to use VariablesSearchRequest.includeVariables, as VariablesSearchRequest.variableNames will be deprecated in a future release.

Consumed by

Search task variables POST