Settings API - GET a schema

Gets parameters of the specified settings schema.

The request produces an application/json payload.

Early Adopter

This request is an Early Adopter release and may be changed in non-compatible way.

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 Read settings (settings.read) permission assigned to your API token. 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	optional
schemaVersion	string	The version of the required schema. If not set, the most recent version is returned.	query	required

Parameter

Type

Description

Required

schemaId

string

The ID of the required schema.

path

optional

schemaVersion

string

The version of the required schema.

If not set, the most recent version is returned.

query

required

Response

Response codes

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

Response body objects

The `SchemaDefinitionRestDto` object

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

The `EnumType` object

Definition of an enum property.

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

The `EnumValue` object

An allowed value for an enum property.

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

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

The `ComplexConstraint` object

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

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

The `PropertyDefinition` object

Configuration of a property in a settings schema.

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

The `Item` object

An item of a collection property.

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

The `UiCustomization` object

Customization for UI elements

Element	Type	Description	Required
table	UiTableCustomization	Customization for UI tables	optional

The `UiTableCustomization` object

Customization for UI tables

Element	Type	Description	Required
columns	UiTableColumnCustomization[]	A list of columns for the UI table	optional

The `UiTableColumnCustomization` object

Customization for UI table columns

Element	Type	Description	Required
propertyRef	string	The referenced property for this column.	optional
type	string	The ui specific type for this column.	optional
displayName	string	The display name for this column.	optional

The `DatasourceDefinition` object

Configuration of a datasource for a property.

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

The `Constraint` object

A constraint on the values accepted for a settings property.

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

The `Precondition` object

A precondition for visibility of a property.

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

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

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

The PropertyDefinition object

The Item object

The UiCustomization object

The UiTableCustomization object

The UiTableColumnCustomization object

The DatasourceDefinition object

The Constraint object

The Precondition object

Response body JSON model

The `SchemaDefinitionRestDto` object

The `EnumType` object

The `EnumValue` object

The `SchemaType` object

The `ComplexConstraint` object

The `PropertyDefinition` object

The `Item` object

The `UiCustomization` object

The `UiTableCustomization` object

The `UiTableColumnCustomization` object

The `DatasourceDefinition` object

The `Constraint` object

The `Precondition` object