• Home
  • Dynatrace API
  • Environment
  • Settings
  • Schemas
  • Kitchen sink

Settings API - Kitchen sink schema table

Kitchen sink (builtin:example.kitchen-sink)

Showcase of property types supported in the UI.

This description is supporting MARKDOWN syntax.

Schema IDSchema groupsScope
builtin:example.kitchen-sink
  • group:example2
  • group:example1
environment
Retrieve schema via Settings API
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:example.kitchen-sink
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:example.kitchen-sink
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:example.kitchen-sink

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
MarkdownShowcaseMarkdownMarkdownShowcase

It's very easy to make some words bold and other words italic with Markdown.

Sometimes you want numbered lists:

  1. One
  2. Two
  3. Three

Sometimes you want bullet points:

  • Start a line with a star
  • Profit!

Alternatively,

  • Dashes work just as well
  • And if you have sub points, put two spaces before the dash or star:
    • Like this
    • And this

Sometimes it's useful to have different levels of headings to structure your documents. Start lines with a # to create headings. Multiple ## in a row denote smaller heading sizes.

You can use one # all the way up to ###### six for different heading sizes.

If you'd like to quote someone, use the > character before the line:

Coffee. The finest organic suspension ever devised... I beat the Borg with it.

  • Captain Janeway
required
propertyTypesProperty typesPropertyTypes

All supported property types

required
subPropertyTypesSub property typesSubPropertyTypes

All supported sub property types

required
collectionPropertyTypesCollection property typesCollectionPropertyTypes

All supported collection property types

required

Request body objects

The MarkdownShowcase object
PropertyLabelTypeDescriptionRequired
markdown_code_samplesMarkdown code samplestext

There are many different ways to style code with GitHub's markdown. If you have inline code blocks, wrap them in backticks: var example = true. If you've got a longer block of code, you can indent with four spaces:

if (isAwesome){
  return true
}

emoji time! 😀😎📆🐫

required
markdown_links_internalInternal linkstext

To link to other Angular screen on same environment, please start your URL with /. If you need to link to GWT screen on same environment, please start your URL with /#.

We also support anchors on same pages, just start your url with #.

Important! As you see - you don't need to worry about environment in your href!

Markdown is supported inside info popover Angular screen

required
markdown_links_externalExternal linkstext

Sometimes there is a need to link to external documentation or link to Dynatrace.com!

required
markdown_emojiemoji time!text

😀😎📆🐫

required
The PropertyTypes object
PropertyLabelTypeDescriptionRequired
texttext property typetext

Property type: text

Java class: java.lang.String

Default constraints:

  • LENGTH: Size must be between 1 and 500

Property type: text

Java class: java.lang.String

Default constraints:

  • LENGTH: Size must be between 1 and 500
required
secretsecret property typesecret

Property type: secret

Java class: java.lang.String

Default constraints:

  • LENGTH: Size must be between 1 and 500

Property type: secret

Java class: java.lang.String

Default constraints:

  • LENGTH: Size must be between 1 and 500
required
booleanboolean property typeboolean

Property type: boolean

Java class: java.lang.Boolean

Default constraints: -

Property type: boolean

Java class: java.lang.Boolean

Default constraints: -

required
floatfloat property typefloat

Property type: float

Java class: java.lang.Double

Default constraints: -

Property type: float

Java class: java.lang.Double

Default constraints: -

required
integerinteger property typeinteger

Property type: integer

Java class: java.lang.Long

Default constraints: -

Property type: integer

Java class: java.lang.Long

Default constraints: -

required
local_date_timelocal_date_time property typelocal_date_time

Property type: local_date_time

Java class: java.time.LocalDateTime

Default constraints: -

Property type: local_date_time

Java class: java.time.LocalDateTime

Default constraints: -

required
zoned_date_timezoned_date_time property typezoned_date_time

Property type: zoned_date_time

Java class: java.time.ZonedDateTime

Default constraints: -

Property type: zoned_date_time

Java class: java.time.ZonedDateTime

Default constraints: -

required
AnimalEnumAnimalEnum property typeenum

Property type: AnimalEnum

Java class: java.lang.String

Default constraints: -

Property type: AnimalEnum

Java class: java.lang.String

Default constraints: -

required
The SubPropertyTypes object
PropertyLabelTypeDescriptionRequired
monitored_entitymonitored_entity sub property typetext

Sub property type: me

Base type: text

Java class: java.lang.String

Default constraints:

  • LENGTH: Size must be between 1 and 500

Additional constraints:

  • PATTERN: Please use a format of TYPE-ID
required
host_entityhost_entity sub property typetext

Sub property type: me

Base type: text

Java class: java.lang.String

Default constraints:

  • LENGTH: Size must be between 1 and 500

Additional constraints:

  • PATTERN: Please use a format of TYPE-ID
  • PATTERN: Must match pattern ^HOST-.+$
required
multiline_textmultiline_text sub property typetext

Sub property type: multiline

Base type: text

Java class: java.lang.String

Default constraints:

  • LENGTH: Size must be between 1 and 500

Additional constraints: -

required
tagtag sub property typetext

Sub property type: tag

Base type: text

Java class: java.lang.String

Default constraints:

  • LENGTH: Size must be between 1 and 500

Additional constraints:

  • CUSTOM_VALIDATOR_REF: Custom validation failed
required
metricmetric sub property typetext

Sub property type: metric

Base type: text

Java class: java.lang.String

Default constraints:

  • LENGTH: Size must be between 1 and 500

Additional constraints:

  • CUSTOM_VALIDATOR_REF: Custom validation failed
required
float_percentagefloat_percentage sub property typefloat

Sub property type: percentage

Base type: float

Java class: java.lang.Double

Default constraints: -

Additional constraints: -

required
integer_percentageinteger_percentage sub property typeinteger

Sub property type: percentage

Base type: integer

Java class: java.lang.Long

Default constraints: -

Additional constraints: -

required
management_zonemanagement_zone sub property typetext-required
uriuri sub property typetext

Sub property type: uri

Base type: text

Java class: java.lang.String

Default constraints:

  • LENGTH: Size must be between 1 and 500

Additional constraints:

  • PATTERN: Not a valid URI
required
http_urlhttp_url sub property typetext

Sub property type: url

Base type: text

Java class: java.lang.String

Default constraints:

  • LENGTH: Size must be between 1 and 500

Additional constraints:

  • PATTERN: Not a valid URI
  • PATTERN: Not a valid http(s) URL
required
emailemail sub property typetext

Sub property type: email

Base type: text

Java class: java.lang.String

Default constraints:

  • LENGTH: Size must be between 1 and 500

Additional constraints:

  • PATTERN: Email address is not valid
required
regexregex sub property typetext

Sub property type: regex

Base type: text

Java class: java.lang.String

Default constraints:

  • LENGTH: Size must be between 1 and 500

Additional constraints:

  • REGEX: Must be a valid regular expression
required
datasource_propertydatasource_property sub property typetext-required
cssSelectorcssSelector sub property typetext

Sub property type: cssSelector

Base type: text

Java class: java.lang.String

Default constraints:

  • LENGTH: Size must be between 1 and 500

Additional constraints: -

required
jsonCodejsonCode sub property typetext

Sub property type: code/json

Base type: text

Java class: java.lang.String

Default constraints:

  • LENGTH: Size must be between 1 and 500

Additional constraints:

  • CUSTOM_VALIDATOR_REF: Custom validation failed
required
credentialscredentials sub property typetext

Sub property type: credential

Base type: text

Java class: java.lang.String

Default constraints:

  • LENGTH: Size must be between 1 and 500

Additional constraints:

  • PATTERN: Must match pattern ^CREDENTIALS_VAULT-.+$
  • PATTERN: Please use a format of TYPE-ID
required
The CollectionPropertyTypes object
PropertyLabelTypeDescriptionRequired
list_complexlist collection property type with complex itemslist

Collection property type: list

Java class: java.util.List

Default constraints: -

required
set_complexset collection property type with complex itemsset

Collection property type: set

Java class: java.util.Set

Default constraints: -

required
list_simplelist collection property type with simple itemslist

Collection property type: list

Java class: java.util.List

Default constraints: -

required
set_simpleset collection property type with simple itemsset

Collection property type: set

Java class: java.util.Set

Default constraints: -

required
The AnimalComplex object
PropertyLabelTypeDescriptionRequired
animalAnimalenum-required
goodBoiIs a good boi?boolean

Of course he is

required