• Home
  • Dynatrace API
  • Environment
  • Settings
  • Schemas
  • Attribute table cards

Settings API - Attribute table cards schema table

Attribute table cards (builtin:ua.attribute-table)

Define card to display complex attribute as a table. Each attribute item in the list would be a row, each item field would be a column.

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

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
keyKeytext

Unique key, which is used to map to this entities list in the screen layout config.

required
displayNameDisplay nametext

The title of the card.

optional
descriptionDescriptiontext

The description of the card.

Markdown syntax can be used to enrich description. To define a link, you can only use seaOtter links (https://dt-url.net/XXXXXXX) or action expression

The format of a single action expression is: actionName|key=param|key2=param2

optional
entitySelectorTemplateEntity selector templatetext

An entity selector that is used to fetch data for related entities. For attribute table it should resolve to single entity.

For example for a host screen where you want to show the processes charts this might look like this:
type(PROCESS_GROUP_INSTANCE), fromRelationships.isProcessOf($(entityConditions))

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

Leave empty to gather data for current entity.

optional
attributeAttributetext

Complex attribute which should be displayed as table.

required
columnsColumnslist

Define columns for this complex attribute.

required
pageSizePage sizeinteger

The number of items displayed on one page.

required
emptyStateEmpty state definitionEmptyStateType

Specifies message shown when there are no entities found.

optional
initialSortingInitial sorting definitionInitialSortingType

Specifies initial sorting configuration.

optional
conditionsList of conditionsset

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

required

Request body objects

The InitialSortingType object
PropertyLabelTypeDescriptionRequired
columnIdColumn IDtext

Column ID is a unique identifier of column. There are several ID types for different column types:

  • Entity column - 'name'

  • Metric with selectable aggregation - 'metric-{metricDisplayName}-{aggregation}' Example: 'metric-CPU Usage-Average'

  • metric without selectable aggregation - 'metric-{metricDisplayName}'
    Example: 'metric-CPU Usage'

  • Attribute - 'attribute-{attributeKey}'
    Example: 'attribute-osType'

  • Relation - 'attribute-{relationEntityType}-{relationDisplayName}'
    Example: 'attribute-CLOUD_APPLICATION-Workloads'

  • Metric dimension (Metric Table only) - 'metricDimension-{dimensionKey}'
    Example: 'metricDimension-dt.entity.host'

required
orderSorting orderenum-required
The EmptyStateType object
PropertyLabelTypeDescriptionRequired
headerMessage headertext-required
bodyMessage bodytext-required
The AttributeType object
PropertyLabelTypeDescriptionRequired
keyAttribute keytext

Use to reference desired attribute.

required
displayNameDisplay nametext

Leave empty to resolve automatically

optional
The ColumnDefinition object
PropertyLabelTypeDescriptionRequired
attributeAttribute optionsAttributeType-required
conditionsList of conditionsset

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

required