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}

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 identifier of the settings schema definition (e.g. builtin:anomaly.infrastructure)

path required
schemaVersion string

The version of the settings schema definition (e.g. 1.0.1). If omitted the latest known version is returned

query optional

Response

Response codes

Code Description
200

Success

404

No schema definition available for the given schemaId

Response body

The SchemaDefinition object

A schema definition which contains metadata and structure information

Element Type Description
documentation string

Extended documentation of this schema and/or links to further reading

dynatrace string

Dynatrace API level

multiObject boolean

True if this schema allows multiple objects per scope, otherwise only a single object per scope is permitted

enums object

Definitions of enums

allowedScopes string[]

Scopes for which values can be persisted

maxObjects integer

Upper limit of the number of settings objects in a single scope (only affects settings schemas where multiObject is true)

ordered boolean

Only used if multiObject is true. True if the order of items has semantic significance

version string

The version of this schema

schemaId string

The identifier of the schema

properties object

Definition of properties that can be persisted.

displayName string

The display name of the schema

constraints ContainerConstraint[]

Constraints limiting the values to be accepted in this schema

description string

Descriptive text about this schema

metadata object

Meta data assigned to the configuration element

types object

Definitions of custom types

The ComplexTypePublicRestDto object

Definitions of custom types

Element Type Description
summaryPattern string

SummaryPattern of the type.

versionInfo string

Version information

version string

Version.

constraints ContainerConstraint[]

Constraints limiting the values to be accepted in this type.

documentation string

Documentation of the type.

displayName string

Human-readable string to be displayed.

description string

Description of the type.

properties object

Definition of properties that can be persisted.

The ContainerConstraint object

Constraint used to define limitation on the accepted values for container

Element Type Description
customMessage string

Custom message for invalid values

customValidatorId string

The identifier of a custom validator

minimumPropertyCount integer

The minimum number of properties that have to be set

maximumPropertyCount integer

The maximum number of properties that can be set

properties string[]

The list of identifiers of the properties used to check the constraint

type string

Type of the container constraint.

The PropertyPublicRestDto object

Definition of a property that can be persisted.

Element Type Description
minObjects integer

The minimum number of items in a collection property

maxObjects integer

The maximum number of items in a collection property, 1 for Singletons

documentation string

Documentation of the configuration property.

precondition Precondition
referencedType string

The type referenced by the property value

items Item
default object

Factory default if no value is persisted. Null for non-singleton values means empty collection.

type object

Type of the property value.

displayName string

Human-readable string to be displayed.

constraints Constraint[]

Constraints limiting the values to be accepted.

description string

Description of the configuration property.

subType string

The subtype of the property value

nullable boolean

Indicates if property value could be null.

metaData object

Meta data assigned to the configuration property.

The Item object

Schema for a collection property item

Element Type Description
documentation string

Documentation of the configuration property.

referencedType string

The type referenced by the property value

type object

Type of the property value

displayName string

Human-readable string to be displayed

constraints Constraint[]

Constraints limiting the values to be accepted

description string

Description of the configuration property

subType string

The subtype of the property value

The Constraint object

Constraint used to define limitation on the accepted values for a configuration property

Element Type Description
customMessage string

Custom message for invalid values

maxLength integer

Maximum allowed string length

minLength integer

Minimum required string length

customValidatorId string

The identifier of a custom validator

uniqueProperties string[]

The list of properties for which the combination of values needs to be unique

minimum number

Minimum value allowed

maximum number

Maximum value allowed

type string

Type of the constraint.

pattern string

Regular expression for valid string values

The Precondition object

Precondition to define condition for visible property

Element Type Description
expectedValue object

Expected value of property (for EQUALS type).

preconditions Precondition[]

Child preconditions to evaluate (for AND/OR type).

precondition Precondition
expectedValues object[]

Valid values for property (for IN type).

property string

Property to evaluate.

type string

Type of the precondition.

The EnumType object

Definition of an enum type.

Element Type Description
enumClass string

Existing java enum class the values can be mapped to (or null if they should not be mapped).

items EnumValue[]

Allowed values defined by this enum.

documentation string

Documentation of the type.

displayName string

Human-readable string to be displayed.

description string

Description of the type.

The EnumValue object

Allowed value defined by the enum mapping

Element Type Description
enumInstance string

Name of the existing java enum value for this value.

value object

Allowable value for enum mapping.

displayName string

Human-readable display name for the value.