Settings 2.0 - List screen filtering schema

List screen filtering (`builtin:ua.list-filtering`)

Define filters on the list screen.

Schema ID	Schema groups	Scope
`builtin:ua.list-filtering`	`group:unified-analysis`	`ua-screen`

Retrieve schema via Settings API

GET	Managed	`https://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:ua.list-filtering`
	SaaS	`https://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:ua.list-filtering`
	Environment ActiveGate	`https://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:ua.list-filtering`

Authentication

To execute this request, you need an access token with Read settings (settings.read) scope. To learn how to obtain and use it, see Tokens and authentication.

Parameters

Property	Label	Type	Description	Required
relationships	Entity relationships list	set	To filter by attributes of related entities you need to define relationship between them. For example to filter by host group attribute on host list you need to add entity selector with relationship like this: `type(HOST_GROUP), toRelationship.isInstanceOf(type(HOST))`. Instead of `type(HOST)` you can use variable `$(entityConditions)`. Relationships should cover all possible pairs of entity types in filters.	required
entityFilters	Entity filters list	list	-	required

Request body objects

The `SplittingChartConfig` object

Property	Label	Type	Description	Required
displayChart	Display splitting chart	boolean	When true, splitting chart for this filter will be displayed	required

The `EntityFilterDefinition` object

Property	Label	Type	Description	Required
type	Type	text	-	required
entityTypes	Entity types list	set	List of entity types that are filtered by this filter. All of them must have defined relationship to entity.	required
displayName	Display name	text	-	required
freeText	Is free text filter	boolean	When true, user can type any text value. When false, user can only select one of the suggestions.	required
modifier	Text filter modifier	enum	Specifies the behavior of free text filter's value	required
defaultSearch	Is default search	boolean	When true, as user is typing it will suggest this key as default for searching. There can be only 1 default search filter in filtering.	required
distinct	Is distinct	boolean	When true, there can be only a single instance of this filter.	required
hidden	Is hidden	boolean	When true, this filter will be hidden.	optional
splittingChart	Splitting chart	SplittingChartConfig	Configure splitting chart for this filter.	optional

The `EntityFilterGroupDefinition` object

Property	Label	Type	Description	Required
displayName	Group display name	text	-	required
filters	Filters	list	Define entity filters.	required