Settings API - Health cards schema table
Health cards (builtin:ua.health-cards
)
Specifies the behavior of health cards.
Schema ID | Schema groups | Scope |
---|---|---|
builtin:ua.health-cards |
| ua-screen |
Parameters
Property | Label | Type | Description | Required |
---|---|---|---|---|
key | Key | text | Unique key, which is used to map to this health card in the screen layout config | required |
tiles | Tiles | list | Collection of tiles definition in health card | required |
conditions | List of conditions | set | All conditions from the list need to be fulfilled for the Health card to be visible | required |
Request body objects
The Tile
object
Property | Label | Type | Description | Required |
---|---|---|---|---|
displayName | Display name | text | - | required |
metricSelector | Metric selector expression | text | Used for displaying last value and for matching events to mark health of the tile. For example, if you want to show the available disk space of a host, use The filter for the ME id will be applied automatically. The Metric Browser gives an overview of all the metrics an the available operations for every metric. | required |
additionalMetricSelectors | Additional metric selector expressions | AdditionalMetricSelectorsType | Used only for matching events to mark health of the tile. | optional |
displayMetricValue | Display metric value | boolean | When true, value of the selected metric will be displayed in the tile | optional |
foldTransformation | Fold transformation | enum | Define fold transformation of the displayed value | required |
anchor | Anchor | Anchor | Define element to scroll to on click. | optional |
conditions | List of conditions | set | All conditions from the list need to be fulfilled for the Tile to be visible | required |
The Anchor
object
Property | Label | Type | Description | Required |
---|---|---|---|---|
cardName | Card name | text | Card display name which is used to scroll on click. | required |
chartName | Chart name | text | Optional chart name. If card supports scrolling to chart, it will be picked to display. Use chart display name to match. | optional |
The AdditionalMetricSelectorsType
object
Property | Label | Type | Description | Required |
---|---|---|---|---|
collection | - | set | - | required |