Settings API - GET a schema
Gets parameters of the specified settings schema.
The request produces an application/json payload.
| GET | SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/{schemaId} |
| Environment ActiveGateCluster ActiveGate | https://{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
The ID of the required schema.
The version of the required schema.
If not set, the most recent version is returned.
Response
Response codes
Response body objects
The SchemaDefinitionRestDto object
A list of scopes where the schema can be used.
A list of constrains limiting the values to be accepted by the schema.
A short description of the schema.
The display name of the schema.
An extended description of the schema and/or links to documentation.
The version of the data format.
A list of definitions of enum properties.
Name of the key property in this schema.
The maximum amount of objects per scope.
Only applicable when multiObject is set to true.
Metadata of the setting.
Multiple (true) objects per scope are permitted or a single (false) object per scope is permitted.
If true the order of objects has semantic significance.
Only applicable when multiObject is set to true.
A list of schema's properties.
Constraints limiting the values as a whole to be accepted in this configuration element.
Names of the groups, which the schema belongs to.
The ID of the schema.
Table column definitions for use in the ui.
A list of definitions of types.
A type is a complex property that contains its own set of subproperties.
The version of the schema.
The ComplexConstraint object
A constraint on the values accepted for a complex settings property.
Defines if modification of any property triggers secret resubmission check.
A custom message for invalid values.
The ID of a custom validator.
The maximum number of properties that can be set.
The minimum number of properties that must be set.
A list of properties (defined by IDs) that are used to check the constraint.
Whether to skip validation on a change made from the UI.
The type of the constraint.
CUSTOM_VALIDATOR_REFGREATER_THANGREATER_THAN_OR_EQUALLESS_THANLESS_THAN_OR_EQUALPROPERTY_COUNT_RANGESECRET_RESUBMISSIONUNKNOWN
The DeletionConstraint object
A constraint on the values that are going to be deleted.
A custom message for invalid values.
The ID of a custom validator.
The EnumType object
Definition of an enum property.
A short description of the property.
The display name of the property.
An extended description and/or links to documentation.
An existing Java enum class that holds the allowed values of the enum.
The type of the property.
enum
The EnumValue object
An allowed value for an enum property.
A short description of the value.
The display name of the value.
The name of the value in an existing Java enum class.
The icon of the value.
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.
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.
A short description of the property.
The display name of the property.
An extended description and/or links to documentation.
Defines if value is allowed to be modified when secret properties are not
The maximum number of objects in a collection property.
Has the value of 1 for singletons.
Metadata of the property.
Pattern with references to properties to create a new value.
The minimum number of objects in a collection property.
Modification policy of the property.
ALWAYSDEFAULTNEVER
The value can (true) or can't (false) be null.
The type referenced by the property value
The subtype of the property's value.
The type of the property's value.
The Constraint object
A constraint on the values accepted for a settings property.
A custom message for invalid values.
The ID of a custom validator.
The maximum allowed length of string values.
The maximum allowed value.
The minimum required length of string values.
The minimum allowed value.
The regular expression pattern for valid string values.
Whether to skip validation on a change made from the UI.
The type of the constraint.
CUSTOM_VALIDATOR_REFLENGTHNOT_BLANKNOT_EMPTYNO_WHITESPACEPATTERNRANGEREGEXTRIMMEDUNIQUEUNKNOWN
A list of properties for which the combination of values must be unique.
The DatasourceDefinition object
Configuration of a datasource for a property.
The properties to filter the datasource options on.
Whether this datasource expects full setting payload as the context.
The identifier of a custom data source of the property's value.
When to reset datasource value in the UI on filter change.
ALWAYSINVALID_ONLYNEVER
If true, the datasource should use the api to filter the results instead of client-side filtering.
Whether to validate input to only allow values returned by the datasource.
The Item object
An item of a collection property.
A short description of the item.
The display name of the item.
An extended description and/or links to documentation.
Metadata of the items.
The type referenced by the item's value.
The subtype of the item's value.
The type of the item's value.
The UiCustomization object
Customization for UI elements
The UiCallbackCustomization object
UI customization options for defining custom callbacks
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
The description to be shown in a tooltip when hovering over the button
The label of the button
The identifier of the function to be called when the button is pressed
The position where the button should be shown in the UI
FIRSTLAST
The UiExpandableCustomization object
UI customization for expandable section
The display name
Defines if the item should be expanded by default
The UiExpandableSectionCustomization object
Expandable section customization for UI
The description
The display name
Defines if the section should be expanded by default
A list of properties
The UiTableCustomization object
Customization for UI tables
The UiTableColumnCustomization object
Customization for UI table columns
The ui specific builtin column-implementation for this column.
The referenced column from the 'tableColumns' property of the schema for this column.
The display name for this column.
The id for this column used for filtering. Required for conflicting or pathed columns - otherwise the ref is used.
The referenced property for this column.
The ui specific type for this column.
The width this column should take up on the table.
The UiTableColumnItemCustomization object
Customization for UI table column items
The display name of this item.
The icon of this item.
The value of this item.
The UiEmptyStateCustomization object
UI customization for empty state in a table
The text to be shown in the empty state
The UiTabsCustomization object
UI customization for tabs
The UiTabGroupCustomization object
Tab group customization for UI
The description
The display name
A list of properties
The Precondition object
A precondition for visibility of a property.
The expected value of the property.
Only applicable to properties of the EQUALS type.
A list of valid values of the property.
Only applicable to properties of the IN type.
The Regular expression which is matched against the property.
Only applicable to properties of the REGEX_MATCH type.
A list of child preconditions to be evaluated.
Only applicable to properties of the AND and OR types.
The property to be evaluated.
The type of the precondition.
ANDEQUALSINNOTNULLORREGEX_MATCH
The SchemaConstraintRestDto object
A custom message for invalid values.
The ID of a custom validator.
Whether to skip validation on a change made from the UI.
The type of the schema constraint.
CUSTOM_VALIDATOR_REFMULTI_SCOPE_CUSTOM_VALIDATOR_REFMULTI_SCOPE_UNIQUEUNIQUEUNKNOWN
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.
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.
A short description of the property.
The display name of the property.
An extended description and/or links to documentation.
Definition of properties that can be persisted.
The pattern for the summary search(for example, "Alert after X minutes.") of the configuration in the UI.
The pattern for the summary (for example, "Alert after X minutes.") of the configuration in the UI.
Type of the reference type.
object
The version of the type.
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"}