Suggest Filters

POST 
/apm/api/v1/filter/action-plan/suggest

List suggestions for UI filters. You must have ActionPlanOverview_READ permission to access this endpoint.

Request

Header Parameters

x-redlock-auth stringrequired
Authorize using Authentication token
Example: jwt token

application/json; charset=UTF-8

Body

required

filterName FilterSuggestFieldEnum

Possible values: [status, finding.type]

name of the filter It will be action_plan.name

query string

Typed in string on UI (substring will be searched)

Responses

200

OK

application/json; charset=UTF-8

Schema

Schema

offset int64

Exact offset where the query begins

queryRemainder string
translate boolean
needsOffsetUpdate boolean
completeParameters string[]
valid boolean
suggestions string[]

Example (from schema)

{
  "offset": 0,
  "queryRemainder": "",
  "translate": false,
  "needsOffsetUpdate": false,
  "completeParameters": [],
  "valid": false,
  "suggestions": [
    "PRIVILEGE_ESCALATION",
    "HIGH_PRIVILEGED_ROLE"
  ]
}

400

Bad Request

application/json; charset=UTF-8

Schema

Schema

error object
code string
message string
target string

Example (from schema)

{
  "error": {
    "code": "string",
    "message": "string",
    "target": "string"
  }
}

401

Unauthorized

403

Forbidden

429

Too Many Requests

Loading...