Settings API - GET a schema

Gets parameters of the specified settings schema.

The request produces an application/json payload.

GETSaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/{schemaId}
Environment ActiveGateCluster ActiveGatehttps://{your-activegate-domain}:9999/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.

4XXErrorEnvelope

Client side error.

5XXErrorEnvelope

Server side error.

Response body objects

The SchemaDefinitionRestDto object

ElementTypeDescription
allowedScopesstring[]

A list of scopes where the schema can be used.

constraintsComplexConstraint[]

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

deletionConstraintsDeletionConstraint[]

Constraints limiting the values to be deleted.

descriptionstring

A short description of the schema.

displayNamestring

The display name of the schema.

documentationstring

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

dynatracestring

The version of the data format.

enumsobject

A list of definitions of enum properties.

keyPropertystring

Name of the key property in this schema.

maxObjectsinteger

The maximum amount of objects per scope.

Only applicable when multiObject is set to true.

metadataobject

Metadata of the setting.

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.

propertiesobject

A list of schema's properties.

schemaConstraintsSchemaConstraintRestDto[]

Constraints limiting the values as a whole to be accepted in this configuration element.

schemaGroupsstring[]

Names of the groups, which the schema belongs to.

schemaIdstring

The ID of the schema.

tableColumnsobject

Table column definitions for use in the ui.

typesobject

A list of definitions of types.

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

uiCustomizationUiCustomization

Customization for UI elements

versionstring

The version of the schema.

The ComplexConstraint object

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

ElementTypeDescription
checkAllPropertiesboolean

Defines if modification of any property triggers secret resubmission check.

customMessagestring

A custom message for invalid values.

customValidatorIdstring

The ID of a custom validator.

maximumPropertyCountinteger

The maximum number of properties that can be set.

minimumPropertyCountinteger

The minimum number of properties that must be set.

propertiesstring[]

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

skipAsyncValidationboolean

Whether to skip validation on a change made from the UI.

typestring

The type of the constraint.

  • CUSTOM_VALIDATOR_REF
  • GREATER_THAN
  • GREATER_THAN_OR_EQUAL
  • LESS_THAN
  • LESS_THAN_OR_EQUAL
  • PROPERTY_COUNT_RANGE
  • SECRET_RESUBMISSION
  • 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.

The EnumType object

Definition of an enum property.

ElementTypeDescription
descriptionstring

A short description of the property.

displayNamestring

The display name of the property.

documentationstring

An extended description and/or links to documentation.

enumClassstring

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

itemsEnumValue[]

A list of allowed values of the enum.

typestring

The type of the property.

  • enum

The EnumValue object

An allowed value for an enum property.

ElementTypeDescription
descriptionstring

A short description of the value.

displayNamestring

The display name of the value.

enumInstancestring

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

iconstring

The icon of the value.

valuestring

The allowed value of the enum.

The AnyValue object

A schema representing an arbitrary value type.

The PropertyDefinition object

Configuration of a property in a settings schema.

ElementTypeDescription
constraintsConstraint[]

A list of constraints limiting the values to be accepted.

datasourceDatasourceDefinition

Configuration of a datasource for a property.

defaultstring

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.

descriptionstring

A short description of the property.

displayNamestring

The display name of the property.

documentationstring

An extended description and/or links to documentation.

forceSecretResubmissionboolean

Defines if value is allowed to be modified when secret properties are not

itemsItem

An item of a collection property.

maxObjectsinteger

The maximum number of objects in a collection property.

Has the value of 1 for singletons.

metadataobject

Metadata of the property.

migrationPatternstring

Pattern with references to properties to create a new value.

minObjectsinteger

The minimum number of objects in a collection property.

modificationPolicystring

Modification policy of the property.

  • ALWAYS
  • DEFAULT
  • NEVER
nullableboolean

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

preconditionPrecondition

A precondition for visibility of a property.

referencedTypestring

The type referenced by the property value

subTypestring

The subtype of the property's value.

typestring

The type of the property's value.

uiCustomizationUiCustomization

Customization for UI elements

The Constraint object

A constraint on the values accepted for a settings property.

ElementTypeDescription
customMessagestring

A custom message for invalid values.

customValidatorIdstring

The ID of a custom validator.

maxLengthinteger

The maximum allowed length of string values.

maximumnumber

The maximum allowed value.

minLengthinteger

The minimum required length of string values.

minimumnumber

The minimum allowed value.

patternstring

The regular expression pattern for valid string values.

skipAsyncValidationboolean

Whether to skip validation on a change made from the UI.

typestring

The type of the constraint.

  • CUSTOM_VALIDATOR_REF
  • LENGTH
  • NOT_BLANK
  • NOT_EMPTY
  • NO_WHITESPACE
  • PATTERN
  • RANGE
  • REGEX
  • TRIMMED
  • UNIQUE
  • UNKNOWN
uniquePropertiesstring[]

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

The DatasourceDefinition object

Configuration of a datasource for a property.

ElementTypeDescription
filterPropertiesstring[]

The properties to filter the datasource options on.

fullContextboolean

Whether this datasource expects full setting payload as the context.

identifierstring

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

resetValuestring

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

  • ALWAYS
  • INVALID_ONLY
  • NEVER
useApiSearchboolean

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

validateboolean

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

The Item object

An item of a collection property.

ElementTypeDescription
constraintsConstraint[]

A list of constraints limiting the values to be accepted.

datasourceDatasourceDefinition

Configuration of a datasource for a property.

descriptionstring

A short description of the item.

displayNamestring

The display name of the item.

documentationstring

An extended description and/or links to documentation.

metadataobject

Metadata of the items.

referencedTypestring

The type referenced by the item's value.

subTypestring

The subtype of the item's value.

typestring

The type of the item's value.

uiCustomizationUiCustomization

Customization for UI elements

The UiCustomization object

Customization for UI elements

ElementTypeDescription
callbackUiCallbackCustomization

UI customization options for defining custom callbacks

expandableUiExpandableCustomization

UI customization for expandable section

tableUiTableCustomization

Customization for UI tables

tabsUiTabsCustomization

UI customization for tabs

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
descriptionstring

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

displayNamestring

The label of the button

identifierstring

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

insertstring

The position where the button should be shown in the UI

  • FIRST
  • LAST

The UiExpandableCustomization object

UI customization for expandable section

ElementTypeDescription
displayNamestring

The display name

expandedboolean

Defines if the item should be expanded by default

sectionsUiExpandableSectionCustomization[]

A list of sections

The UiExpandableSectionCustomization object

Expandable section customization for UI

ElementTypeDescription
descriptionstring

The description

displayNamestring

The display name

expandedboolean

Defines if the section should be expanded by default

propertiesstring[]

A list of properties

The UiTableCustomization object

Customization for UI tables

ElementTypeDescription
columnsUiTableColumnCustomization[]

A list of columns for the UI table

emptyStateUiEmptyStateCustomization

UI customization for empty state in a table

The UiTableColumnCustomization object

Customization for UI table columns

ElementTypeDescription
builtinColumnRefstring

The ui specific builtin column-implementation for this column.

columnRefstring

The referenced column from the 'tableColumns' property of the schema for this column.

displayNamestring

The display name for this column.

idstring

The id for this column used for filtering. Required for conflicting or pathed columns - otherwise the ref is used.

itemsUiTableColumnItemCustomization[]

The possible items of this column.

propertyRefstring

The referenced property for this column.

typestring

The ui specific type for this column.

widthstring

The width this column should take up on the table.

The UiTableColumnItemCustomization object

Customization for UI table column items

ElementTypeDescription
displayNamestring

The display name of this item.

iconstring

The icon of this item.

valuestring

The value of this item.

The UiEmptyStateCustomization object

UI customization for empty state in a table

ElementTypeDescription
textstring

The text to be shown in the empty state

The UiTabsCustomization object

UI customization for tabs

ElementTypeDescription
groupsUiTabGroupCustomization[]

A list of groups

The UiTabGroupCustomization object

Tab group customization for UI

ElementTypeDescription
descriptionstring

The description

displayNamestring

The display name

propertiesstring[]

A list of properties

The Precondition object

A precondition for visibility of a property.

ElementTypeDescription
expectedValuestring

The expected value of the property.

Only applicable to properties of the EQUALS type.

expectedValues-

A list of valid values of the property.

Only applicable to properties of the IN type.

patternstring

The Regular expression which is matched against the property.

Only applicable to properties of the REGEX_MATCH type.

preconditionPrecondition

A precondition for visibility of a property.

preconditionsPrecondition[]

A list of child preconditions to be evaluated.

Only applicable to properties of the AND and OR types.

propertystring

The property to be evaluated.

typestring

The type of the precondition.

  • AND
  • EQUALS
  • IN
  • NOT
  • NULL
  • OR
  • REGEX_MATCH

The SchemaConstraintRestDto object

ElementTypeDescription
customMessagestring

A custom message for invalid values.

customValidatorIdstring

The ID of a custom validator.

skipAsyncValidationboolean

Whether to skip validation on a change made from the UI.

typestring

The type of the schema constraint.

  • CUSTOM_VALIDATOR_REF
  • MULTI_SCOPE_CUSTOM_VALIDATOR_REF
  • MULTI_SCOPE_UNIQUE
  • UNIQUE
  • UNKNOWN
uniquePropertiesstring[]

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

The TableColumn object

The definition of a table column to be used in the ui.

ElementTypeDescription
patternstring

Pattern with references to properties to create a single value for the column.

The SchemaType object

A list of definitions of types.

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

ElementTypeDescription
constraintsComplexConstraint[]

A list of constraints limiting the values to be accepted.

descriptionstring

A short description of the property.

displayNamestring

The display name of the property.

documentationstring

An extended description and/or links to documentation.

propertiesobject

Definition of properties that can be persisted.

searchPatternstring

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

summaryPatternstring

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

typestring

Type of the reference type.

  • object
versionstring

The version of the type.

versionInfostring

A short description of the version.

Response body JSON model

{
"allowedScopes": [
"host",
"application"
],
"constraints": [
{
"checkAllProperties": false,
"customMessage": "string",
"customValidatorId": "my-min-max",
"maximumPropertyCount": 2,
"minimumPropertyCount": 1,
"properties": [
"string"
],
"skipAsyncValidation": false,
"type": "CUSTOM_VALIDATOR_REF"
}
],
"deletionConstraints": [
{
"customMessage": "string",
"customValidatorId": "my-min-max"
}
],
"description": "Dynatrace disables monitoring of containers that do not run any applications",
"displayName": "Built-in container monitoring rules",
"documentation": "string",
"dynatrace": "1",
"enums": {},
"keyProperty": "keyProperty",
"maxObjects": 10,
"metadata": {},
"multiObject": true,
"ordered": true,
"properties": {},
"schemaConstraints": [
{
"customMessage": "string",
"customValidatorId": "my-min-max",
"skipAsyncValidation": false,
"type": "CUSTOM_VALIDATOR_REF",
"uniqueProperties": [
"my-prop-1",
"my-prop-2"
]
}
],
"schemaGroups": [
"group:some.1",
"group:some.2"
],
"schemaId": "builtin:container.built-in-monitoring-rule",
"tableColumns": {},
"types": {},
"uiCustomization": {
"callback": {
"buttons": [
{
"description": "string",
"displayName": "string",
"identifier": "string",
"insert": "FIRST"
}
]
},
"expandable": {
"displayName": "string",
"expanded": true,
"sections": [
{
"description": "string",
"displayName": "string",
"expanded": true,
"properties": [
"string"
]
}
]
},
"table": {
"columns": [
{
"builtinColumnRef": "summary",
"columnRef": "myCustomColumn",
"displayName": "Color",
"id": "color",
"items": [
{
"displayName": "Active",
"icon": "CRITICAL",
"value": "ACTIVE"
}
],
"propertyRef": "apiColor",
"type": "cell-color-picker",
"width": "10%"
}
],
"emptyState": {
"text": "string"
}
},
"tabs": {
"groups": [
{
"description": "string",
"displayName": "string",
"properties": [
"string"
]
}
]
}
},
"version": "1.4.2"
}