Settings 2.0 - Properties card schema

Properties card (`builtin:ua.properties`)

Entity properties are shown on the card as key-value pairs. By default, all available attribute properties are displayed. Use this configuration to override their display options or specify relation properties.

Schema ID	Schema groups	Scope
`builtin:ua.properties`	`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.properties`
	SaaS	`https://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:ua.properties`
	Environment ActiveGate	`https://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:ua.properties`

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

tagsRelatedEntitySelectors

Tags of related entities - entity selector templates

Property	Label	Type	Description	Required
tagsRelatedEntitySelectors	Tags of related entities - entity selector templates	set	Display additionally tags of some related entities. Tags of related entities are read-only. The limit is 10 related entities. For example for a host screen where you want to show host and it's host group tags - might look like this: `type(HOST_GROUP), toRelationships.isInstanceOf($(entityConditions))` Please mind that the `$(entityConditions)` is a placeholder for the relation condition.	required
displayOnlyConfigured	Display only configured properties	boolean	By default, all available properties are displayed in the card. Use this flag to display only properties defined in the table below.	optional
properties	Properties list	list	-	required

set

Display additionally tags of some related entities. Tags of related entities are read-only. The limit is 10 related entities.

For example for a host screen where you want to show host and it's host group tags - might look like this:
type(HOST_GROUP), toRelationships.isInstanceOf($(entityConditions))

Please mind that the $(entityConditions) is a placeholder for the relation condition.

required

displayOnlyConfigured

Display only configured properties

boolean

By default, all available properties are displayed in the card. Use this flag to display only properties defined in the table below.

optional

properties Properties list list - required

Request body objects

The `AttributeType` object

Property	Label	Type	Description	Required
key	Attribute key	text	Use to reference desired attribute	required
displayName	Display name	text	Leave empty to resolve automatically	optional
unit	Unit	text	Use to format numeric properties	optional
entitySelectorTemplate	Entity selector template	text	An optional entity selector to fetch attribute from related entity For example for a host screen where you want to display property of VM that it runs on, this might look like this: `type(AWS_AVAILABILITY_ZONE), fromRelationships.isSiteOf($(entityConditions))` Please mind that the `$(entityConditions)` is a placeholder for the current ME selector. Please remember that attribute key needs to be available in the context of related entity.	optional
hidden	Hide the property	boolean	-	optional

The `RelationType` object

Property Label Type Description Required

entitySelectorTemplate

Entity selector template

Property	Label	Type	Description	Required
entitySelectorTemplate	Entity selector template	text	An entity selector that is used to fetch the selected entities For example for a process screen where you want to link to the process group this might look like this: `type(PROCESS_GROUP), toRelationships.isInstanceOf($(entityConditions))` Please mind that the `$(entityConditions)` is a placeholder for the current ME selector.	required
displayName	Display name	text	-	required
fallbackMessage	Fallback Message	text	Display additional message if no entity is found. By default whole property is hidden.	optional

text

An entity selector that is used to fetch the selected entities

For example for a process screen where you want to link to the process group this might look like this:
type(PROCESS_GROUP), toRelationships.isInstanceOf($(entityConditions))

Please mind that the $(entityConditions) is a placeholder for the current ME selector.

required

displayName Display name text - required

fallbackMessage

Fallback Message

text

Display additional message if no entity is found. By default whole property is hidden.

optional

The `PropertyDefinition` object

Property	Label	Type	Description	Required
type	Property type	enum	Choose to overwrite attribute display options or specify relation	required
attribute	Attribute options	AttributeType	-	required
relation	Relation options	RelationType	-	required
importantProperty	Display in header	boolean	If true, this property will be marked as important in the UI. Those will be displayed in the header below the entity name.	optional
conditions	List of conditions	set	All conditions from the list need to be fulfilled for the property to be visible	required

Settings 2.0 - Properties card schema

Properties card (builtin:ua.properties)