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

Response

Response codes

Code Description
200

Success
404

Failed. The specified schema doesn't exist.

Response body

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.
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.
version string

The version of the type.
versionInfo string

A short description of the version.
properties object

Definition of properties that can be persisted.
constraints ComplexConstraint[]

A list of constraints limiting the values to be accepted.
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 ComplexConstraint object

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

Element Type Description
customValidatorId string

The ID of a custom validator.
minimumPropertyCount integer

The minimum number of properties that must be set.
maximumPropertyCount integer

The maximum number of properties that can be set.
customMessage string

A custom message for invalid values.
properties string[]

A list of properties (defined by IDs) that are used to check the constraint.
type string

The type of the constraint.

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
precondition Precondition
minObjects integer

The minimum number of objects in a collection property.
maxObjects integer

The maximum number of objects in a collection property.

Has the value of 1 for singletons.
documentation string

An extended description and/or links to documentation.
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.

The Precondition object

A precondition for visibility of a property.

Element Type Description
preconditions Precondition[]

A list of child preconditions to be evaluated.

Only applicable to properties of the AND and OR types.
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.
precondition Precondition
property string

The property to be evaluated.
type string

The type of the precondition.

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.
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.
constraints Constraint[]

A list of constraints limiting the values to be accepted.
subType string

The subtype of the item's value.

The Constraint object

A constraint on the values accepted for a settings property.

Element Type Description
uniqueProperties string[]

A list of properties for which the combination of values must be unique.
maxLength integer

The maximum allowed length of string values.
minLength integer

The minimum required length of string values.
customValidatorId string

The ID of a custom validator.
customMessage string

A custom message for invalid values.
maximum number

The maximum allowed value.
minimum number

The minimum allowed value.
type string

The type of the constraint.
pattern string

The regular expression pattern for valid string values.

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.
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.