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 the 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	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	Description
200	Success
404	Failed. The specified schema doesn't exist.

Response body

Response parametersJSON model

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.

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.
constraints	ComplexConstraint[]	A list of constraints limiting the values to be accepted.
version	string	The version of the type.
versionInfo	string	A short description of the version.
properties	object	Definition of properties that can be persisted.
documentation	string	An extended description and/or links to documentation.
displayName	string	The display name of the property.
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
items	Item
documentation	string	An extended description and/or links to documentation.
maxObjects	integer	The maximum number of objects in a collection property. Has the value of `1` for singletons.
datasource	DatasourceDefinition
minObjects	integer	The minimum number of objects in a collection property.
precondition	Precondition
constraints	Constraint[]	A list of constraints limiting the values to be accepted.
subType	string	The subtype of the property's value.
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.
nullable	boolean	The value can (`true`) or can't (`false`) be `null`.

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.
expectedValues	object[]	A list of valid values of the property. Only applicable to properties of the `IN` type.
preconditions	Precondition[]	A list of child preconditions to be evaluated. Only applicable to properties of the `AND` and `OR` types.
precondition	Precondition
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

The Item object

An item of a collection property.

Element	Type	Description
referencedType	string	The type referenced by the item's value.
documentation	string	An extended description and/or links to documentation.
datasource	DatasourceDefinition
constraints	Constraint[]	A list of constraints limiting the values to be accepted.
subType	string	The subtype of the item's value.
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.

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

The DatasourceDefinition object

Configuration of a datasource for a property.

Element	Type	Description
validate	boolean	Whether to validate input to only allow values returned by the datasource.
filterProperties	string[]	The properties to filter the datasource options on.
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.
identifier	string	The identifier of a custom data source of the property's value.

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.
maximumPropertyCount	integer	The maximum number of properties that can be set.
customValidatorId	string	The ID of a custom validator.
minimumPropertyCount	integer	The minimum number of properties that must be set.
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

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.
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.
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.
icon	string	The icon of the value.
value	object	The allowed value of the enum.
displayName	string	The display name of the value.
description	string	A short description of the value.

    {
  "dynatrace": "1",
  "schemaId": "builtin:anomaly.infrastructure",
  "displayName": "Anomaly detection for infrastructure",
  "description": "Dynatrace automatically detects infrastructure-related performance anomalies such as high CPU saturation, memory outages, and low disk-space conditions",
  "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",
      "maximumPropertyCount": 2,
      "customValidatorId": "my-min-max",
      "minimumPropertyCount": 1,
      "properties": [
        "string"
      ],
      "type": "CUSTOM_VALIDATOR_REF"
    }
  ],
  "metadata": {}
}