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

GETManagedDynatrace for Governmenthttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/{schemaId}
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/{schemaId}
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/{schemaId}

Authentication

To execute this request, you need an access token with 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.

schemaGroupsstring[]

Names of the groups, which the schema belongs to.

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.

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.

keyPropertystring

Name of the key property in this schema.

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.

metadataobject

Metadata of the setting.

deletionConstraintsDeletionConstraint[]

Constraints limiting the values to be deleted.

uiCustomizationUiCustomization

Customization for UI elements

The EnumType object

Definition of an enum property.

ElementTypeDescription
itemsEnumValue[]

A list of allowed values of the enum.

enumClassstring

An existing Java enum class that holds the 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.

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.

displayNamestring

The display name of the value.

iconstring

The icon of the value.

valueobject

The allowed value of the enum.

descriptionstring

A short description of the value.

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.

versionInfostring

A short description of the version.

versionstring

The version of the type.

propertiesobject

Definition of properties that can be persisted.

constraintsComplexConstraint[]

A list of constraints limiting the values to be accepted.

documentationstring

An extended description and/or links to documentation.

displayNamestring

The display name of the property.

descriptionstring

A short description of the property.

The PropertyDefinition object

Configuration of a property in a settings schema.

ElementTypeDescription
itemsItem

An item of a collection property.

referencedTypestring

The type referenced by the property value

uiCustomizationUiCustomization

Customization for UI elements

documentationstring

An extended description and/or links to documentation.

maxObjectsinteger

The maximum number of objects in a collection property.

Has the value of 1 for singletons.

datasourceDatasourceDefinition

Configuration of a datasource for a property.

minObjectsinteger

The minimum number of objects in a collection property.

modificationPolicystring

Modification policy of the property.

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

A precondition for visibility of a property.

subTypestring

The subtype of the property's value.

displayNamestring

The display name of the property.

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.

typeobject

The type of the property's value.

descriptionstring

A short description of the property.

metadataobject

Metadata of the property.

constraintsConstraint[]

A list of constraints limiting the values to be accepted.

nullableboolean

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

The Item object

An item of a collection property.

ElementTypeDescription
referencedTypestring

The type referenced by the item's value.

uiCustomizationUiCustomization

Customization for UI elements

documentationstring

An extended description and/or links to documentation.

datasourceDatasourceDefinition

Configuration of a datasource for a property.

subTypestring

The subtype of the item's value.

displayNamestring

The display name of the item.

typeobject

The type of the item's value.

descriptionstring

A short description of the item.

metadataobject

Metadata of the items.

constraintsConstraint[]

A list of constraints limiting the values to be accepted.

The UiCustomization object

Customization for UI elements

ElementTypeDescription
expandableUiExpandableCustomization

UI customization for expandable section

tabsUiTabsCustomization

UI customization for tabs

callbackUiCallbackCustomization

UI customization options for defining custom callbacks

tableUiTableCustomization

Customization for UI tables

The UiExpandableCustomization object

UI customization for expandable section

ElementTypeDescription
expandedboolean

Defines if the item should be expanded by default

displayNamestring

The display name

sectionsUiExpandableSectionCustomization[]

A list of sections

The UiExpandableSectionCustomization object

Expandable section customization for UI

ElementTypeDescription
expandedboolean

Defines if the section should be expanded by default

displayNamestring

The display name

propertiesstring[]

A list of properties

descriptionstring

The description

The UiTabsCustomization object

UI customization for tabs

ElementTypeDescription
groupsUiTabGroupCustomization[]

A list of groups

The UiTabGroupCustomization object

Tab group customization for UI

ElementTypeDescription
displayNamestring

The display name

propertiesstring[]

A list of properties

descriptionstring

The description

The UiCallbackCustomization object

UI customization options for defining custom callbacks

ElementTypeDescription
buttonsUiButtonCustomization[]

UI customization for defining buttons that call functions when pressed

The UiButtonCustomization object

UI customization for defining a button that calls a function when pressed

ElementTypeDescription
insertobject

The position where the button should be shown in the UI

displayNamestring

The label of the button

identifierstring

The identifier of the function to be called when the button is pressed

descriptionstring

The description to be shown in a tooltip when hovering over the button

The UiTableCustomization object

Customization for UI tables

ElementTypeDescription
emptyStateUiEmptyStateCustomization

UI customization for empty state in a table

columnsUiTableColumnCustomization[]

A list of columns for the UI table

The UiEmptyStateCustomization object

UI customization for empty state in a table

ElementTypeDescription
textstring

The text to be shown in the empty state

The UiTableColumnCustomization object

Customization for UI table columns

ElementTypeDescription
propertyRefstring

The referenced property for this column.

builtinColumnRefstring

The ui specific builtin column-implementation for this column.

displayNamestring

The display name for this column.

typestring

The ui specific type for this column.

The DatasourceDefinition object

Configuration of a datasource for a property.

ElementTypeDescription
resetValuestring

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

The element can hold these values
  • ALWAYS
  • INVALID_ONLY
  • NEVER
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.

identifierstring

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

The Constraint object

A constraint on the values accepted for a settings property.

ElementTypeDescription
maxLengthinteger

The maximum allowed length of string values.

minLengthinteger

The minimum required length of string values.

uniquePropertiesstring[]

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

customMessagestring

A custom message for invalid values.

customValidatorIdstring

The ID of a custom validator.

maximumnumber

The maximum allowed value.

minimumnumber

The minimum allowed value.

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.

The Precondition object

A precondition for visibility of a property.

ElementTypeDescription
preconditionsPrecondition[]

A list of child preconditions to be evaluated.

Only applicable to properties of the AND and OR types.

expectedValueobject

The expected value of the property.

Only applicable to properties of the EQUALS type.

expectedValuesobject[]

A list of valid values of the property.

Only applicable to properties of the IN type.

preconditionPrecondition

A precondition for visibility of a property.

propertystring

The property to be evaluated.

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.

The ComplexConstraint object

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

ElementTypeDescription
maximumPropertyCountinteger

The maximum number of properties that can be set.

minimumPropertyCountinteger

The minimum number of properties that must be set.

customMessagestring

A custom message for invalid values.

customValidatorIdstring

The ID of a custom validator.

propertiesstring[]

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

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

The DeletionConstraint object

A constraint on the values that are going to be deleted.

ElementTypeDescription
customMessagestring

A custom message for invalid values.

customValidatorIdstring

The ID of a custom validator.

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" ], "keyProperty": "keyProperty", "enums": {}, "types": {}, "properties": {}, "constraints": [ { "maximumPropertyCount": 2, "minimumPropertyCount": 1, "customMessage": "string", "customValidatorId": "my-min-max", "properties": [ "string" ], "type": "CUSTOM_VALIDATOR_REF" } ], "metadata": {}, "deletionConstraints": [ { "customMessage": "string", "customValidatorId": "my-min-max" } ], "uiCustomization": { "expandable": { "expanded": true, "displayName": "string", "sections": [ { "expanded": true, "displayName": "string", "properties": [ "string" ], "description": "string" } ] }, "tabs": { "groups": [ { "displayName": "string", "properties": [ "string" ], "description": "string" } ] }, "callback": { "buttons": [ { "insert": {}, "displayName": "string", "identifier": "string", "description": "string" } ] }, "table": { "emptyState": { "text": "string" }, "columns": [ { "propertyRef": "apiColor", "builtinColumnRef": "summary", "displayName": "Color", "type": "cell-color-picker" } ] } } }