• Home
  • Dynatrace API
  • Environment
  • Settings
  • Schemas
  • GET a schema

Settings API - GET a schema

Gets parameters of the specified settings schema.

The request produces an application/json payload.

GETManaged 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

ParameterTypeDescriptionInRequired
schemaIdstring

The ID of the required schema.

pathrequired
schemaVersionstring

The version of the required schema.

If not set, the most recent version is returned.

queryoptional

Response

Response codes

CodeTypeDescription
200SchemaDefinitionRestDto

Success

403ErrorEnvelope

Failed. Forbidden.

404ErrorEnvelope

Failed. The specified schema doesn't exist.

Response body objects

The SchemaDefinitionRestDto object

ElementTypeDescription
dynatracestring

The version of the data format.

schemaIdstring

The ID of the schema.

displayNamestring

The display name of the schema.

descriptionstring

A short description of the schema.

documentationstring

An extended description of the schema and/or links to documentation.

Can be null.

schemaGroupsstring[]

Names of the groups, which the schema belongs to.

Can be null.

versionstring

The version of the schema.

multiObjectboolean

Multiple (true) objects per scope are permitted or a single (false) object per scope is permitted.

orderedboolean

If true the order of objects has semantic significance.

Only applicable when multiObject is set to true.

Can be null.

maxObjectsinteger

The maximum amount of objects per scope.

Only applicable when multiObject is set to true.

allowedScopesstring[]

A list of scopes where the schema can be used.

enumsobject

A list of definitions of enum properties.

typesobject

A list of definitions of types.

A type is a complex property that contains its own set of subproperties.

propertiesobject

A list of schema's properties.

constraintsComplexConstraint[]

A list of constrains limiting the values to be accepted by the schema.

Can be null.

metadataobject

Metadata of the setting.

Can be null.

uiCustomizationUiCustomization

Customization for UI elements

Can be null.

The EnumType object

Definition of an enum property.

ElementTypeDescription
enumClassstring

An existing Java enum class that holds the allowed values of the enum.

Can be null.

itemsEnumValue[]

A list of allowed values of the enum.

typestring

The type of the property.

The element can hold these values
  • enum
documentationstring

An extended description and/or links to documentation.

displayNamestring

The display name of the property.

Can be null.

descriptionstring

A short description of the property.

The EnumValue object

An allowed value for an enum property.

ElementTypeDescription
enumInstancestring

The name of the value in an existing Java enum class.

Can be null.

iconstring

The icon of the value.

Can be null.

displayNamestring

The display name of the value.

valueobject

The allowed value of the enum.

descriptionstring

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.

ElementTypeDescription
summaryPatternstring

The pattern for the summary (for example, "Alert after X minutes.") of the configuration in the UI.

searchPatternstring

The pattern for the summary search(for example, "Alert after X minutes.") of the configuration in the UI.

Can be null.

versionInfostring

A short description of the version.

Can be null.

propertiesobject

Definition of properties that can be persisted.

versionstring

The version of the type.

constraintsComplexConstraint[]

A list of constraints limiting the values to be accepted.

Can be null.

documentationstring

An extended description and/or links to documentation.

displayNamestring

The display name of the property.

Can be null.

descriptionstring

A short description of the property.

The PropertyDefinition object

Configuration of a property in a settings schema.

ElementTypeDescription
referencedTypestring

The type referenced by the property value

Can be null.

documentationstring

An extended description and/or links to documentation.

Can be null.

maxObjectsinteger

The maximum number of objects in a collection property.

Has the value of 1 for singletons.

uiCustomizationUiCustomization

Customization for UI elements

Can be null.

datasourceDatasourceDefinition

Configuration of a datasource for a property.

Can be null.

minObjectsinteger

The minimum number of objects in a collection property.

Can be null.

modificationPolicystring

Modification policy of the property.

The element can hold these values
  • ALWAYS
  • DEFAULT
  • NEVER

Can be null.

preconditionPrecondition

A precondition for visibility of a property.

Can be null.

itemsItem

An item of a collection property.

Can be null.

displayNamestring

The display name of the property.

Can be null.

subTypestring

The subtype of the property's value.

Can be null.

defaultobject

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.

typeobject

The type of the property's value.

descriptionstring

A short description of the property.

Can be null.

metadataobject

Metadata of the property.

Can be null.

constraintsConstraint[]

A list of constraints limiting the values to be accepted.

Can be null.

nullableboolean

The value can (true) or can't (false) be null.

The UiCustomization object

Customization for UI elements

ElementTypeDescription
expandableUiExpandableCustomization

UI customization for expandable section

Can be null.

tableUiTableCustomization

Customization for UI tables

Can be null.

The UiExpandableCustomization object

UI customization for expandable section

ElementTypeDescription
displayNamestring

The display name

Can be null.

sectionsUiExpandableSectionCustomization[]

A list of sections

Can be null.

The UiExpandableSectionCustomization object

Expandable section customization for UI

ElementTypeDescription
displayNamestring

The display name

propertiesstring[]

A list of properties

descriptionstring

The description

Can be null.

The UiTableCustomization object

Customization for UI tables

ElementTypeDescription
columnsUiTableColumnCustomization[]

A list of columns for the UI table

Can be null.

The UiTableColumnCustomization object

Customization for UI table columns

ElementTypeDescription
propertyRefstring

The referenced property for this column.

Can be null.

builtinColumnRefstring

The ui specific builtin column-implementation for this column.

Can be null.

displayNamestring

The display name for this column.

Can be null.

typestring

The ui specific type for this column.

Can be null.

The DatasourceDefinition object

Configuration of a datasource for a property.

ElementTypeDescription
filterPropertiesstring[]

The properties to filter the datasource options on.

validateboolean

Whether to validate input to only allow values returned by the datasource.

fullContextboolean

Whether this datasource expects full setting payload as the context.

useApiSearchboolean

If true, the datasource should use the api to filter the results instead of client-side filtering.

resetValuestring

When to reset datasource value in the UI on filter change.

The element can hold these values
  • ALWAYS
  • INVALID_ONLY
  • NEVER

Can be null.

identifierstring

The identifier of a custom data source of the property's value.

The Precondition object

A precondition for visibility of a property.

ElementTypeDescription
expectedValueobject

The expected value of the property.

Only applicable to properties of the EQUALS type.

Can be null.

expectedValuesobject[]

A list of valid values of the property.

Only applicable to properties of the IN type.

Can be null.

preconditionsPrecondition[]

A list of child preconditions to be evaluated.

Only applicable to properties of the AND and OR types.

Can be null.

preconditionPrecondition

A precondition for visibility of a property.

Can be null.

propertystring

The property to be evaluated.

Can be null.

typestring

The type of the precondition.

The element can hold these values
  • AND
  • EQUALS
  • IN
  • NOT
  • NULL
  • OR
  • REGEX_MATCH
patternstring

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.

ElementTypeDescription
referencedTypestring

The type referenced by the item's value.

Can be null.

documentationstring

An extended description and/or links to documentation.

Can be null.

uiCustomizationUiCustomization

Customization for UI elements

Can be null.

datasourceDatasourceDefinition

Configuration of a datasource for a property.

Can be null.

displayNamestring

The display name of the item.

Can be null.

subTypestring

The subtype of the item's value.

Can be null.

typeobject

The type of the item's value.

descriptionstring

A short description of the item.

Can be null.

metadataobject

Metadata of the items.

Can be null.

constraintsConstraint[]

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.

ElementTypeDescription
maxLengthinteger

The maximum allowed length of string values.

Can be null.

minLengthinteger

The minimum required length of string values.

Can be null.

customMessagestring

A custom message for invalid values.

Can be null.

customValidatorIdstring

The ID of a custom validator.

Can be null.

uniquePropertiesstring[]

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

Can be null.

minimumnumber

The minimum allowed value.

Can be null.

maximumnumber

The maximum allowed value.

Can be null.

typestring

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
patternstring

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.

ElementTypeDescription
customMessagestring

A custom message for invalid values.

Can be null.

customValidatorIdstring

The ID of a custom validator.

Can be null.

minimumPropertyCountinteger

The minimum number of properties that must be set.

Can be null.

maximumPropertyCountinteger

The maximum number of properties that can be set.

Can be null.

propertiesstring[]

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

Can be null.

typestring

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" } ] } } }