Settings API - Summary pattern examples schema table

Summary pattern examples (`builtin:example.summary.pattern`)

This schema shows some possibilities on how to customize the displaying of items using the summary pattern:

Markdown to apply formatting
ICU for general message formatting and simple logic ICU documentation
Pipes to transform values. Checkout SummaryPatternPipes#CORE_PIPE_FACTORIES (for general pipes) and MonitoringSettingsFactory#createPipeRegistry (for cluster-side and custom pipes) to see what pipes are registered and available for usage.

Schema ID	Schema groups	Scope
`builtin:example.summary.pattern`	-	`environment`

Retrieve schema via Settings API

GET	Managed	`https://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:example.summary.pattern`
	SaaS	`https://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:example.summary.pattern`
	Environment ActiveGate	`https://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:example.summary.pattern`

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
truncated	Truncated text	set	This summary shows how to use pipes, in particular the `truncate` pipe to limit the length of the displayed text to 10 characters	required
truncatedCollection	Truncated collection	set	This summary shows how to use pipes, in particular the `truncateCollection` pipe to limit the size of the collection to 3 elements and the length of each text item in it to 4 characters	required
non_empty_text	Non-empty text	set	This summary shows how to use pipes, in particular the `valueSet` pipe to check if a value is set	required
icu_select	ICU select	set	This summary makes use of ICU's `select` to display some text depending on a boolean flag	required
icu_plural	ICU plural	set	This summary makes use of ICU's `plural` to display some text depending on an integer value	required
icu_number_formatting	ICU number formatting	set	This summary makes use of some of ICU's number formatting capabilities	required

Request body objects

The `TruncatedCollection` object

Property	Label	Type	Description	Required
collProperty	-	set	-	required

The `TruncatedTextItem` object

Property	Label	Type	Description	Required
textProperty	Text	text	-	optional

The `NonEmptyTextItem` object

Property	Label	Type	Description	Required
textProperty	Text	text	-	optional

The `IcuSelectItem` object

Property	Label	Type	Description	Required
booleanProperty	Boolean	boolean	-	required

The `IcuPluralItem` object

Property	Label	Type	Description	Required
integerProperty	Integer	integer	-	required

The `IcuNumberFormattingItem` object

Property	Label	Type	Description	Required
integerProperty	Integer	integer	-	required

Settings API - Summary pattern examples schema table

Summary pattern examples (builtin:example.summary.pattern)

Authentication

Parameters

Request body objects

The TruncatedCollection object

The TruncatedTextItem object

The NonEmptyTextItem object

The IcuSelectItem object

The IcuPluralItem object

The IcuNumberFormattingItem object