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 Read settings (settings.read) 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. Can be `null`.
schemaGroups	string[]	Names of the groups, which the schema belongs to. Can be `null`.
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`. Can be `null`.
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. Can be `null`.
metadata	object	Metadata of the setting. Can be `null`.
uiCustomization	UiCustomization	Customization for UI elements Can be `null`.

The `EnumType` object

Definition of an enum property.

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

The `EnumValue` object

An allowed value for an enum property.

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

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
summaryPattern	string	The pattern for the summary (for example, "Alert after X minutes.") of the configuration in the UI.
searchPattern	string	The pattern for the summary search(for example, "Alert after X minutes.") of the configuration in the UI. Can be `null`.
versionInfo	string	A short description of the version. Can be `null`.
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. Can be `null`.
documentation	string	An extended description and/or links to documentation.
displayName	string	The display name of the property. Can be `null`.
description	string	A short description of the property.

The `PropertyDefinition` object

Configuration of a property in a settings schema.

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

The `UiCustomization` object

Customization for UI elements

Element Type Description

expandable

Element	Type	Description
expandable	UiExpandableCustomization	UI customization for expandable section Can be `null`.
table	UiTableCustomization	Customization for UI tables Can be `null`.

UiExpandableCustomization

UI customization for expandable section

Can be null.

table

UiTableCustomization

Customization for UI tables

Can be null.

The `UiExpandableCustomization` object

UI customization for expandable section

Element Type Description

displayName

string

Element	Type	Description
displayName	string	The display name Can be `null`.
sections	UiExpandableSectionCustomization[]	A list of sections Can be `null`.

The display name

Can be null.

sections

UiExpandableSectionCustomization[]

A list of sections

Can be null.

The `UiExpandableSectionCustomization` object

Expandable section customization for UI

Element Type Description

displayName

string

Element	Type	Description
displayName	string	The display name
properties	string[]	A list of properties
description	string	The description Can be `null`.

The display name

properties

string[]

A list of properties

description

string

The description

Can be null.

The `UiTableCustomization` object

Customization for UI tables

Element Type Description

columns

Element	Type	Description
columns	UiTableColumnCustomization[]	A list of columns for the UI table Can be `null`.

UiTableColumnCustomization[]

A list of columns for the UI table

Can be null.

The `UiTableColumnCustomization` object

Customization for UI table columns

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

The `DatasourceDefinition` object

Configuration of a datasource for a property.

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

The `Precondition` object

A precondition for visibility of a property.

Element	Type	Description
expectedValue	object	The expected value of the property. Only applicable to properties of the `EQUALS` type. Can be `null`.
expectedValues	object[]	A list of valid values of the property. Only applicable to properties of the `IN` type. Can be `null`.
preconditions	Precondition[]	A list of child preconditions to be evaluated. Only applicable to properties of the `AND` and `OR` types. Can be `null`.
precondition	Precondition	A precondition for visibility of a property. Can be `null`.
property	string	The property to be evaluated. Can be `null`.
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. Can be `null`.

The `Item` object

An item of a collection property.

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

The `Constraint` object

A constraint on the values accepted for a settings property.

Element	Type	Description
maxLength	integer	The maximum allowed length of string values. Can be `null`.
minLength	integer	The minimum required length of string values. Can be `null`.
customMessage	string	A custom message for invalid values. Can be `null`.
customValidatorId	string	The ID of a custom validator. Can be `null`.
uniqueProperties	string[]	A list of properties for which the combination of values must be unique. Can be `null`.
minimum	number	The minimum allowed value. Can be `null`.
maximum	number	The maximum allowed value. Can be `null`.
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`
pattern	string	The regular expression pattern for valid string values. Can be `null`.

The `ComplexConstraint` object

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

Element	Type	Description
customMessage	string	A custom message for invalid values. Can be `null`.
customValidatorId	string	The ID of a custom validator. Can be `null`.
minimumPropertyCount	integer	The minimum number of properties that must be set. Can be `null`.
maximumPropertyCount	integer	The maximum number of properties that can be set. Can be `null`.
properties	string[]	A list of properties (defined by IDs) that are used to check the constraint. Can be `null`.
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`

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": [
    {
      "customMessage": "string",
      "customValidatorId": "my-min-max",
      "minimumPropertyCount": 1,
      "maximumPropertyCount": 2,
      "properties": [
        "string"
      ],
      "type": "CUSTOM_VALIDATOR_REF"
    }
  ],
  "metadata": {},
  "uiCustomization": {
    "expandable": {
      "displayName": "string",
      "sections": [
        {
          "displayName": "string",
          "properties": [
            "string"
          ],
          "description": "string"
        }
      ]
    },
    "table": {
      "columns": [
        {
          "propertyRef": "apiColor",
          "builtinColumnRef": "summary",
          "displayName": "Color",
          "type": "cell-color-picker"
        }
      ]
    }
  }
}

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 UiCustomization object

The UiExpandableCustomization object

The UiExpandableSectionCustomization object

The UiTableCustomization object

The UiTableColumnCustomization object

The DatasourceDefinition object

The Precondition object

The Item object

The Constraint object

The ComplexConstraint object

Response body JSON model

The `SchemaDefinitionRestDto` object

The `EnumType` object

The `EnumValue` object

The `SchemaType` object

The `PropertyDefinition` object

The `UiCustomization` object

The `UiExpandableCustomization` object

The `UiExpandableSectionCustomization` object

The `UiTableCustomization` object

The `UiTableColumnCustomization` object

The `DatasourceDefinition` object

The `Precondition` object

The `Item` object

The `Constraint` object

The `ComplexConstraint` object