• Home
  • Dynatrace API
  • Environment
  • Settings
  • Schemas
  • List screen layout

Settings API - List screen layout schema table

List screen layout (builtin:ua.list-screen-settings)

Configure layout for entities list page.

Schema IDSchema groupsScope
builtin:ua.list-screen-settings
  • group:unified-analysis
ua-screen
Retrieve schema via Settings API
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:ua.list-screen-settings
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:ua.list-screen-settings
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:ua.list-screen-settings

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

PropertyLabelTypeDescriptionRequired
staticContent-StaticContent

Enable/Disable static elements like Properties or Problems.

required
layout-LayoutDefinition

Reference cards that should be shown on the screen (like chart groups or entity lists) or use the auto generated screen layout.

required

Request body objects

The Breadcrumb object
PropertyLabelTypeDescriptionRequired
typeBreadcrumb Typeenum-required
entitySelectorTemplateEntity selector templatetext

An entity selector that is used to reference related entity screen

For example for a process screen where you want to show the host it runs on, this might look like this:
type(HOST), toRelationships.isProcessOf($(entityConditions))

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

required
entityTypeEntity typetext

An entity type of entities list screen

required
linkLink keytext

A key of server-defined static link

required
displayNameDisplay nametext

A display name for a non-clickable or entity list breadcrumb

optional
The CardReference object
PropertyLabelTypeDescriptionRequired
typeCard Typeenum-required
keyCard keytext

Unique key of the card, which is used to reference desired card configuration

required
widthCard widthenum

A value that determines how much vertical space will that card take

optional
collapsedCollapse cardboolean

If true, card content will be collapsed

optional
conditionsList of conditionsset

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

required
The HeaderType object
PropertyLabelTypeDescriptionRequired
titleTitletext-optional
descriptionDescriptiontext

The description of the screen

optional
iconIcon nametext-optional
The StaticContent object
PropertyLabelTypeDescriptionRequired
showGlobalFilterShow filterboolean

If true, the screen show the filter bar

required
headerHeader definitionHeaderType-optional
hideDefaultBreadcrumbHide default breadcrumbboolean

If true, the default breadcrumb for the current page is hidden

optional
breadcrumbsBreadcrumbslist

A list of breadcrumbs leading to the screen

Define breadcrumbs list in order from root page to leaf(current page would be last on that list).

required
The LayoutDefinition object
PropertyLabelTypeDescriptionRequired
autoGenerateAuto generated contentboolean

If true the screen content is auto generated. Disable to configure your own layout.

required
cardsCards layoutlist

A list of cards that should be shown on the screen

Reference cards that should be shown on the screen.
Cards will be displayed in order defined on this list.

required