Settings API - GET a schema
Gets parameters of the specified settings schema.
The request produces an application/json
payload.
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 an access token with Read settings (settings.read
) scope. 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 | Type | Description |
---|---|---|
200 | Schema | Success |
403 | Error | Failed. Forbidden. |
404 | Error | Failed. The specified schema doesn't exist. |
Response body objects
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. Can be |
schemaGroups | string[] | Names of the groups, which the schema belongs to. Can be |
version | string | The version of the schema. |
multiObject | boolean | Multiple ( |
ordered | boolean | If Only applicable when multiObject is set to Can be |
maxObjects | integer | The maximum amount of objects per scope. Only applicable when multiObject is set to |
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 | Complex | A list of constrains limiting the values to be accepted by the schema. Can be |
metadata | object | Metadata of the setting. Can be |
uiCustomization | Ui | Customization for UI elements Can be |
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. Can be |
items | Enum | 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. Can be |
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. Can be |
icon | string | The icon of the value. Can be |
displayName | string | The display name of the value. |
value | object | The allowed value of the enum. |
description | string | A short description of the value. Can be |
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. |
searchPattern | string | The pattern for the summary search(for example, "Alert after X minutes.") of the configuration in the UI. Can be |
versionInfo | string | A short description of the version. Can be |
properties | object | Definition of properties that can be persisted. |
version | string | The version of the type. |
constraints | Complex | A list of constraints limiting the values to be accepted. Can be |
documentation | string | An extended description and/or links to documentation. |
displayName | string | The display name of the property. Can be |
description | string | A short description of the property. |
The PropertyDefinition
object
Configuration of a property in a settings schema.
Element | Type | Description |
---|---|---|
referencedType | string | The type referenced by the property value Can be |
documentation | string | An extended description and/or links to documentation. Can be |
maxObjects | integer | The maximum number of objects in a collection property. Has the value of |
uiCustomization | Ui | Customization for UI elements Can be |
datasource | Datasource | Configuration of a datasource for a property. Can be |
minObjects | integer | The minimum number of objects in a collection property. Can be |
modificationPolicy | string | Modification policy of the property. Can be |
precondition | Precondition | A precondition for visibility of a property. Can be |
items | Item | An item of a collection property. Can be |
displayName | string | The display name of the property. Can be |
subType | string | The subtype of the property's value. Can be |
default | object | The default value to be used when no value is provided. If a non-singleton has the value of Can be |
type | object | The type of the property's value. |
description | string | A short description of the property. Can be |
metadata | object | Metadata of the property. Can be |
constraints | Constraint[] | A list of constraints limiting the values to be accepted. Can be |
nullable | boolean | The value can ( |
The UiCustomization
object
Customization for UI elements
Element | Type | Description |
---|---|---|
expandable | Ui | UI customization for expandable section Can be |
table | Ui | Customization for UI tables Can be |
The UiExpandableCustomization
object
UI customization for expandable section
Element | Type | Description |
---|---|---|
displayName | string | The display name Can be |
sections | Ui | A list of sections Can be |
The UiExpandableSectionCustomization
object
Expandable section customization for UI
Element | Type | Description |
---|---|---|
displayName | string | The display name |
properties | string[] | A list of properties |
description | string | The description Can be |
The UiTableCustomization
object
Customization for UI tables
Element | Type | Description |
---|---|---|
columns | Ui | A list of columns for the UI table Can be |
The UiTableColumnCustomization
object
Customization for UI table columns
Element | Type | Description |
---|---|---|
propertyRef | string | The referenced property for this column. Can be |
builtinColumnRef | string | The ui specific builtin column-implementation for this column. Can be |
displayName | string | The display name for this column. Can be |
type | string | The ui specific type for this column. Can be |
The DatasourceDefinition
object
Configuration of a datasource for a property.
Element | Type | Description |
---|---|---|
filterProperties | string[] | The properties to filter the datasource options on. |
validate | boolean | Whether to validate input to only allow values returned by the datasource. |
fullContext | boolean | Whether this datasource expects full setting payload as the context. |
useApiSearch | boolean | If true, the datasource should use the api to filter the results instead of client-side filtering. |
resetValue | string | When to reset datasource value in the UI on filter change. Can be |
identifier | string | The identifier of a custom data source of the property's value. |
The Precondition
object
A precondition for visibility of a property.
Element | Type | Description |
---|---|---|
expectedValue | object | The expected value of the property. Only applicable to properties of the Can be |
expectedValues | object[] | A list of valid values of the property. Only applicable to properties of the Can be |
preconditions | Precondition[] | A list of child preconditions to be evaluated. Only applicable to properties of the Can be |
precondition | Precondition | A precondition for visibility of a property. Can be |
property | string | The property to be evaluated. Can be |
type | string | The type of the precondition. |
pattern | string | The Regular expression which is matched against the property. Only applicable to properties of the Can be |
The Item
object
An item of a collection property.
Element | Type | Description |
---|---|---|
referencedType | string | The type referenced by the item's value. Can be |
documentation | string | An extended description and/or links to documentation. Can be |
uiCustomization | Ui | Customization for UI elements Can be |
datasource | Datasource | Configuration of a datasource for a property. Can be |
displayName | string | The display name of the item. Can be |
subType | string | The subtype of the item's value. Can be |
type | object | The type of the item's value. |
description | string | A short description of the item. Can be |
metadata | object | Metadata of the items. Can be |
constraints | Constraint[] | A list of constraints limiting the values to be accepted. Can be |
The Constraint
object
A constraint on the values accepted for a settings property.
Element | Type | Description |
---|---|---|
maxLength | integer | The maximum allowed length of string values. Can be |
minLength | integer | The minimum required length of string values. Can be |
customMessage | string | A custom message for invalid values. Can be |
customValidatorId | string | The ID of a custom validator. Can be |
uniqueProperties | string[] | A list of properties for which the combination of values must be unique. Can be |
minimum | number | The minimum allowed value. Can be |
maximum | number | The maximum allowed value. Can be |
type | string | The type of the constraint. |
pattern | string | The regular expression pattern for valid string values. Can be |
The ComplexConstraint
object
A constraint on the values accepted for a complex settings property.
Element | Type | Description |
---|---|---|
customMessage | string | A custom message for invalid values. Can be |
customValidatorId | string | The ID of a custom validator. Can be |
minimumPropertyCount | integer | The minimum number of properties that must be set. Can be |
maximumPropertyCount | integer | The maximum number of properties that can be set. Can be |
properties | string[] | A list of properties (defined by IDs) that are used to check the constraint. Can be |
type | string | The type of the constraint. |
Response body JSON model
{
"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"
}
]
}
}
}