Settings API - Actions schema table

Actions (`builtin:ua.screen-actions`)

You can define here actions for multiple screen elements.

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

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
actionScope	Scope	enum	Defines in which card type this action is shown. If you select a dynamic card (such as chart group or entity list), specific cards can be referred via the card key as well.	required
key	Card key	text	Unique key of the card, which is used to reference desired card configuration. To add this actions in every card of this type, leave it empty.	optional
actionLocation	Action location	enum	Defines where on the card the action is displayed. Show in card header: The action will be shown in the drilldown in the top right corner of the card. Show in each chart: The action will be shown in the drilldown above each chart. This selection is only possible for chart group and entity list. Show in each table row: The action will be shown in the drilldown of every table row. This selection is only possible for entity list and event.	required
mainAction	Main actions	boolean	If true, buttons will be displayed outside of actions menu	optional
actions	List of actions	list	Define all actions and their parameters you want to show on this element.	required

Request body objects

The `Visualization` object

Property	Label	Type	Description	Required
displayName	Display name	text	Override/set action button display name. It will be deduced from action definition if not set.	optional
color	Color	enum	Override/set action button theme color.	optional
icon	Icon	text	Include the barista icon action button.	optional
iconOnly	Show only icon	boolean	If selected, only icon will be rendered in the action button. Display name will be moved to the tooltip on hover.	optional

The `Action` object

Property	Label	Type	Description	Required
actionExpression	Action expression	text	The definition of an action Single action expression. The format is: actionName\|key=param\|key2=param2	required
visualization	Button visualization	Visualization	If applicable, you can define visualization properties of action button	optional
conditions	List of conditions	set	All conditions from the list need to be fulfilled for the action to be visible	required

Property

Label

Type

Description

Required

actionExpression

Action expression

text

The definition of an action

Single action expression. The format is: actionName|key=param|key2=param2

required

visualization

Button visualization

Visualization

If applicable, you can define visualization properties of action button

optional

conditions

List of conditions

set

All conditions from the list need to be fulfilled for the action to be visible