List Report Overview Filter Autocomplete Suggestions

POST 
/filter/report/suggest

Returns the available options for a specific report posture filter. Also supports fuzzy autocomplete search for easier filtering.

You can find the available filter names through Get Report Overview Filters and Options request. The keys in the response object from that GET request are the available filter names.

Request

application/json; charset=UTF-8

Body

filterName stringrequired

Filter name

query string

Case-insensitive fuzzy search autocomplete filter. Includes only items that contain the query as a substring.

Responses

200

success

*/*

Schema

Schema

completeParameters object[]
Array [
name string
Name
operator string
Possible values: [tag:yaml.org,2002:value =]
Operator
value string
Value
]
links string

JSON query builder links

needsOffsetUpdate boolean

Needs offset update (for internal use)

offset int32

Offset within query

queryRemainder string

Query remainder

suggestions string[]

List of suggestions

translate boolean

Translate (for internal use)

valid boolean

Query is valid

Example (from schema)

{
  "completeParameters": [
    {
      "name": "string",
      "operator": "tag:yaml.org,2002:value =",
      "value": "string"
    }
  ],
  "links": "string",
  "needsOffsetUpdate": true,
  "offset": 0,
  "queryRemainder": "string",
  "suggestions": [
    "string"
  ],
  "translate": true,
  "valid": true
}

400

missing_required_parameter / invalid_parameter_value

404

not_found

Loading...