Settings API - GET a schema

Gets parameters of the specified settings schema.

The request produces an application/json payload.

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

Authentication

To execute this request, you need an access token with any scope. To learn how to obtain and use it, see Tokens and authentication.

Parameters

Parameter	Type	Description	In	Required
schemaId	string	The ID of the required schema.	path	required
schemaVersion	string	The version of the required schema. If not set, the most recent version is returned.	query	optional

Parameter

Type

Description

Required

schemaId

string

The ID of the required schema.

path

required

schemaVersion

string

The version of the required schema.

If not set, the most recent version is returned.

query

optional

Response

Response codes

Code	Type	Description
200	SchemaDefinitionRestDto	Success
403	ErrorEnvelope	Failed. Forbidden.
404	ErrorEnvelope	Failed. The specified schema doesn't exist.

Response body objects

The `SchemaDefinitionRestDto` object

Element	Type	Description
dynatrace	string	The version of the data format.
schemaId	string	The ID of the schema.
displayName	string	The display name of the schema.
description	string	A short description of the schema.
documentation	string	An extended description of the schema and/or links to documentation.
schemaGroups	string[]	Names of the groups, which the schema belongs to.
version	string	The version of the schema.
multiObject	boolean	Multiple (`true`) objects per scope are permitted or a single (`false`) object per scope is permitted.
ordered	boolean	If `true` the order of objects has semantic significance. Only applicable when multiObject is set to `true`.
maxObjects	integer	The maximum amount of objects per scope. Only applicable when multiObject is set to `true`.
allowedScopes	string[]	A list of scopes where the schema can be used.
enums	object	A list of definitions of enum properties.
types	object	A list of definitions of types. A type is a complex property that contains its own set of subproperties.
properties	object	A list of schema's properties.
constraints	ComplexConstraint[]	A list of constrains limiting the values to be accepted by the schema.
metadata	object	Metadata of the setting.
uiCustomization	UiCustomization	Customization for UI elements

The `EnumType` object

Definition of an enum property.

Element	Type	Description
type	string	The type of the property. The element can hold these values `enum`
items	EnumValue[]	A list of allowed values of the enum.
enumClass	string	An existing Java enum class that holds the allowed values of the enum.
displayName	string	The display name of the property.
description	string	A short description of the property.
documentation	string	An extended description and/or links to documentation.

The `EnumValue` object

An allowed value for an enum property.

Element	Type	Description
value	object	The allowed value of the enum.
displayName	string	The display name of the value.
description	string	A short description of the value.
icon	string	The icon of the value.
enumInstance	string	The name of the value in an existing Java enum class.

The `SchemaType` object

A list of definitions of types.

A type is a complex property that contains its own set of subproperties.

Element	Type	Description
properties	object	Definition of properties that can be persisted.
version	string	The version of the type.
constraints	ComplexConstraint[]	A list of constraints limiting the values to be accepted.
versionInfo	string	A short description of the version.
searchPattern	string	The pattern for the summary search(for example, "Alert after X minutes.") of the configuration in the UI.
summaryPattern	string	The pattern for the summary (for example, "Alert after X minutes.") of the configuration in the UI.
displayName	string	The display name of the property.
description	string	A short description of the property.
documentation	string	An extended description and/or links to documentation.

The `PropertyDefinition` object

Configuration of a property in a settings schema.

Element	Type	Description
default	object	The default value to be used when no value is provided. If a non-singleton has the value of `null`, it means an empty collection.
type	object	The type of the property's value.
displayName	string	The display name of the property.
description	string	A short description of the property.
metadata	object	Metadata of the property.
constraints	Constraint[]	A list of constraints limiting the values to be accepted.
subType	string	The subtype of the property's value.
nullable	boolean	The value can (`true`) or can't (`false`) be `null`.
referencedType	string	The type referenced by the property value
items	Item	An item of a collection property.
modificationPolicy	string	Modification policy of the property. The element can hold these values `ALWAYS` `DEFAULT` `NEVER`
documentation	string	An extended description and/or links to documentation.
uiCustomization	UiCustomization	Customization for UI elements
maxObjects	integer	The maximum number of objects in a collection property. Has the value of `1` for singletons.
precondition	Precondition	A precondition for visibility of a property.
minObjects	integer	The minimum number of objects in a collection property.
datasource	DatasourceDefinition	Configuration of a datasource for a property.

The `Constraint` object

A constraint on the values accepted for a settings property.

Element	Type	Description
type	string	The type of the constraint. The element can hold these values `CUSTOM_VALIDATOR_REF` `LENGTH` `NOT_BLANK` `NOT_EMPTY` `NO_WHITESPACE` `PATTERN` `RANGE` `REGEX` `TRIMMED` `UNIQUE` `UNKNOWN`
maximum	number	The maximum allowed value.
minimum	number	The minimum allowed value.
pattern	string	The regular expression pattern for valid string values.
maxLength	integer	The maximum allowed length of string values.
minLength	integer	The minimum required length of string values.
uniqueProperties	string[]	A list of properties for which the combination of values must be unique.
customValidatorId	string	The ID of a custom validator.
customMessage	string	A custom message for invalid values.

The `Item` object

An item of a collection property.

Element	Type	Description
type	object	The type of the item's value.
displayName	string	The display name of the item.
description	string	A short description of the item.
metadata	object	Metadata of the items.
constraints	Constraint[]	A list of constraints limiting the values to be accepted.
subType	string	The subtype of the item's value.
referencedType	string	The type referenced by the item's value.
documentation	string	An extended description and/or links to documentation.
uiCustomization	UiCustomization	Customization for UI elements
datasource	DatasourceDefinition	Configuration of a datasource for a property.

The `UiCustomization` object

Customization for UI elements

Element	Type	Description
table	UiTableCustomization	Customization for UI tables
tabs	UiTabsCustomization	UI customization for tabs
callback	UiCallbackCustomization	UI customization options for defining custom callbacks
expandable	UiExpandableCustomization	UI customization for expandable section

The `UiTableCustomization` object

Customization for UI tables

Element	Type	Description
columns	UiTableColumnCustomization[]	A list of columns for the UI table
emptyState	UiEmptyStateCustomization	UI customization for empty state in a table

The `UiTableColumnCustomization` object

Customization for UI table columns

Element	Type	Description
type	string	The ui specific type for this column.
displayName	string	The display name for this column.
builtinColumnRef	string	The ui specific builtin column-implementation for this column.
propertyRef	string	The referenced property for this column.

The `UiEmptyStateCustomization` object

UI customization for empty state in a table

Element	Type	Description
text	string	The text to be shown in the empty state

The `UiTabsCustomization` object

UI customization for tabs

Element	Type	Description
groups	UiTabGroupCustomization[]	A list of groups

The `UiTabGroupCustomization` object

Tab group customization for UI

Element	Type	Description
properties	string[]	A list of properties
displayName	string	The display name
description	string	The description

The `UiCallbackCustomization` object

UI customization options for defining custom callbacks

Element	Type	Description
buttons	UiButtonCustomization[]	UI customization for defining buttons that call functions when pressed

The `UiButtonCustomization` object

UI customization for defining a button that calls a function when pressed

Element	Type	Description
displayName	string	The label of the button
description	string	The description to be shown in a tooltip when hovering over the button
identifier	string	The identifier of the function to be called when the button is pressed
insertAfter	string	The path of a property where the button should be shown in the UI

The `UiExpandableCustomization` object

UI customization for expandable section

Element	Type	Description
displayName	string	The display name
sections	UiExpandableSectionCustomization[]	A list of sections
expanded	boolean	Defines if the item should be expanded by default

The `UiExpandableSectionCustomization` object

Expandable section customization for UI

Element	Type	Description
properties	string[]	A list of properties
displayName	string	The display name
description	string	The description
expanded	boolean	Defines if the section should be expanded by default

The `DatasourceDefinition` object

Configuration of a datasource for a property.

Element	Type	Description
identifier	string	The identifier of a custom data source of the property's value.
filterProperties	string[]	The properties to filter the datasource options on.
resetValue	string	When to reset datasource value in the UI on filter change. The element can hold these values `ALWAYS` `INVALID_ONLY` `NEVER`
validate	boolean	Whether to validate input to only allow values returned by the datasource.
useApiSearch	boolean	If true, the datasource should use the api to filter the results instead of client-side filtering.
fullContext	boolean	Whether this datasource expects full setting payload as the context.

The `Precondition` object

A precondition for visibility of a property.

Element	Type	Description
property	string	The property to be evaluated.
type	string	The type of the precondition. The element can hold these values `AND` `EQUALS` `IN` `NOT` `NULL` `OR` `REGEX_MATCH`
pattern	string	The Regular expression which is matched against the property. Only applicable to properties of the `REGEX_MATCH` type.
precondition	Precondition	A precondition for visibility of a property.
expectedValue	object	The expected value of the property. Only applicable to properties of the `EQUALS` type.
preconditions	Precondition[]	A list of child preconditions to be evaluated. Only applicable to properties of the `AND` and `OR` types.
expectedValues	object[]	A list of valid values of the property. Only applicable to properties of the `IN` type.

The `ComplexConstraint` object

A constraint on the values accepted for a complex settings property.

Element	Type	Description
properties	string[]	A list of properties (defined by IDs) that are used to check the constraint.
type	string	The type of the constraint. The element can hold these values `CUSTOM_VALIDATOR_REF` `GREATER_THAN` `GREATER_THAN_OR_EQUAL` `LESS_THAN` `LESS_THAN_OR_EQUAL` `PROPERTY_COUNT_RANGE` `UNKNOWN`
minimumPropertyCount	integer	The minimum number of properties that must be set.
maximumPropertyCount	integer	The maximum number of properties that can be set.
customValidatorId	string	The ID of a custom validator.
customMessage	string	A custom message for invalid values.

Response body JSON model

json
{
  "dynatrace": "1",
  "schemaId": "builtin:container.built-in-monitoring-rule",
  "displayName": "Built-in container monitoring rules",
  "description": "Dynatrace disables monitoring of containers that do not run any applications",
  "documentation": "string",
  "schemaGroups": [
    "group:some.1",
    "group:some.2"
  ],
  "version": "1.4.2",
  "multiObject": true,
  "ordered": true,
  "maxObjects": 10,
  "allowedScopes": [
    "host",
    "application"
  ],
  "enums": {},
  "types": {},
  "properties": {},
  "constraints": [
    {
      "properties": [
        "string"
      ],
      "type": "CUSTOM_VALIDATOR_REF",
      "minimumPropertyCount": 1,
      "maximumPropertyCount": 2,
      "customValidatorId": "my-min-max",
      "customMessage": "string"
    }
  ],
  "metadata": {},
  "uiCustomization": {
    "table": {
      "columns": [
        {
          "type": "cell-color-picker",
          "displayName": "Color",
          "builtinColumnRef": "summary",
          "propertyRef": "apiColor"
        }
      ],
      "emptyState": {
        "text": "string"
      }
    },
    "tabs": {
      "groups": [
        {
          "properties": [
            "string"
          ],
          "displayName": "string",
          "description": "string"
        }
      ]
    },
    "callback": {
      "buttons": [
        {
          "displayName": "string",
          "description": "string",
          "identifier": "string",
          "insertAfter": "string"
        }
      ]
    },
    "expandable": {
      "displayName": "string",
      "sections": [
        {
          "properties": [
            "string"
          ],
          "displayName": "string",
          "description": "string",
          "expanded": true
        }
      ],
      "expanded": true
    }
  }
}

Settings API - GET a schema

Authentication

Parameters

Response

Response codes

Response body objects

The SchemaDefinitionRestDto object

The EnumType object

The EnumValue object

The SchemaType object

The PropertyDefinition object

The Constraint object

The Item object

The UiCustomization object

The UiTableCustomization object

The UiTableColumnCustomization object

The UiEmptyStateCustomization object

The UiTabsCustomization object

The UiTabGroupCustomization object

The UiCallbackCustomization object

The UiButtonCustomization object

The UiExpandableCustomization object

The UiExpandableSectionCustomization object

The DatasourceDefinition object

The Precondition object

The ComplexConstraint object