Extensions 2.0 API - GET an extension schema
Gets the schema of the specified version of an Extensions 2.0 extension.
The request produces an application/json
payload.
GET | ManagedDynatrace for Government | https://{your-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/{extensionVersion}/schema |
SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/extensions/{extensionName}/{extensionVersion}/schema | |
Environment ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/{extensionVersion}/schema |
Authentication
To execute this request, you need an access token with extensionConfigurations.read
scope.
To learn how to obtain and use it, see Tokens and authentication.
Parameters
Parameter | Type | Description | In | Required |
---|---|---|---|---|
extensionName | string | The name of the requested extension 2.0. | path | required |
extensionVersion | string | The version of the requested extension 2.0 | path | required |
Response
Response codes
Code | Type | Description |
---|---|---|
200 | Schema | Success |
404 | ErrorEnvelope | Failed. The requested resource 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. |
schemaGroups | string[] | Names of the groups, which the schema belongs to. |
version | string | The version of the schema. |
multiObject | boolean | Multiple ( |
ordered | boolean | If Only applicable when multiObject is set to |
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. |
keyProperty | string | Name of the key property in this schema. |
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. |
metadata | object | Metadata of the setting. |
uiCustomization | Ui | Customization for UI elements |
deletionConstraints | Deletion | Constraints limiting the values to be deleted. |
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. |
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. |
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. |
value | object | The allowed value of the enum. |
displayName | string | The display name of the value. |
description | string | A short description of the value. |
icon | string | The icon 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.
Element | Type | Description |
---|---|---|
constraints | Complex | A list of constraints limiting the values to be accepted. |
versionInfo | string | A short description of the version. |
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. |
properties | object | Definition of properties that can be persisted. |
version | string | The version of the type. |
documentation | string | An extended description and/or links to documentation. |
displayName | string | The display name of the property. |
description | string | A short description of the property. |
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. |
customValidatorId | string | The ID of a custom validator. |
maximumPropertyCount | integer | The maximum number of properties that can be set. |
minimumPropertyCount | integer | The minimum number of properties that must be set. |
properties | string[] | A list of properties (defined by IDs) that are used to check the constraint. |
type | string | The type of the constraint. |
The PropertyDefinition
object
Configuration of a property in a settings schema.
Element | Type | Description |
---|---|---|
subType | string | The subtype of the property's value. |
metadata | object | Metadata of the property. |
constraints | Constraint[] | A list of constraints limiting the values to be accepted. |
nullable | boolean | The value can ( |
minObjects | integer | The minimum number of objects in a collection property. |
documentation | string | An extended description and/or links to documentation. |
maxObjects | integer | The maximum number of objects in a collection property. Has the value of |
items | Item | An item of a collection property. |
uiCustomization | Ui | Customization for UI elements |
datasource | Datasource | Configuration of a datasource for a property. |
precondition | Precondition | A precondition for visibility of a property. |
modificationPolicy | string | Modification policy of the property. |
referencedType | string | The type referenced by the property value |
default | object | The default value to be used when no value is provided. If a non-singleton has the value of |
type | object | The type of the property's value. |
displayName | string | The display name of the property. |
description | string | A short description of the property. |
The Constraint
object
A constraint on the values accepted for a settings property.
Element | Type | Description |
---|---|---|
maximum | number | The maximum allowed value. |
minimum | number | The minimum allowed value. |
pattern | string | The regular expression pattern for valid string values. |
customMessage | string | A custom message for invalid values. |
minLength | integer | The minimum required length of string values. |
maxLength | integer | The maximum allowed length of string values. |
customValidatorId | string | The ID of a custom validator. |
uniqueProperties | string[] | A list of properties for which the combination of values must be unique. |
type | string | The type of the constraint. |
The Item
object
An item of a collection property.
Element | Type | Description |
---|---|---|
subType | string | The subtype of the item's value. |
metadata | object | Metadata of the items. |
constraints | Constraint[] | A list of constraints limiting the values to be accepted. |
documentation | string | An extended description and/or links to documentation. |
uiCustomization | Ui | Customization for UI elements |
datasource | Datasource | Configuration of a datasource for a property. |
referencedType | string | The type referenced by the item's value. |
type | object | The type of the item's value. |
displayName | string | The display name of the item. |
description | string | A short description of the item. |
The UiCustomization
object
Customization for UI elements
Element | Type | Description |
---|---|---|
tabs | Ui | UI customization for tabs |
callback | Ui | UI customization options for defining custom callbacks |
expandable | Ui | UI customization for expandable section |
table | Ui | Customization for UI tables |
The UiTabsCustomization
object
UI customization for tabs
Element | Type | Description |
---|---|---|
groups | Ui | A list of groups |
The UiTabGroupCustomization
object
Tab group customization for UI
Element | Type | Description |
---|---|---|
properties | string[] | A list of properties |
displayName | string | The display name |
description | string | The description |
The UiCallbackCustomization
object
UI customization options for defining custom callbacks
Element | Type | Description |
---|---|---|
buttons | Ui | 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
Element | Type | Description |
---|---|---|
insert | object | The position where the button should be shown in the UI |
displayName | string | The label of the button |
description | string | The description to be shown in a tooltip when hovering over the button |
identifier | string | The identifier of the function to be called when the button is pressed |
The UiExpandableCustomization
object
UI customization for expandable section
Element | Type | Description |
---|---|---|
sections | Ui | A list of sections |
expanded | boolean | Defines if the item should be expanded by default |
displayName | string | The display name |
The UiExpandableSectionCustomization
object
Expandable section customization for UI
Element | Type | Description |
---|---|---|
expanded | boolean | Defines if the section should be expanded by default |
properties | string[] | A list of properties |
displayName | string | The display name |
description | string | The description |
The UiTableCustomization
object
Customization for UI tables
Element | Type | Description |
---|---|---|
columns | Ui | A list of columns for the UI table |
emptyState | Ui | UI customization for empty state in a table |
The UiTableColumnCustomization
object
Customization for UI table columns
Element | Type | Description |
---|---|---|
propertyRef | string | The referenced property for this column. |
builtinColumnRef | string | The ui specific builtin column-implementation for this column. |
type | string | The ui specific type for this column. |
displayName | string | The display name for this column. |
The UiEmptyStateCustomization
object
UI customization for empty state in a table
Element | Type | Description |
---|---|---|
text | string | The text to be shown in the empty state |
The DatasourceDefinition
object
Configuration of a datasource for a property.
Element | Type | Description |
---|---|---|
resetValue | string | When to reset datasource value in the UI on filter change. |
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. |
filterProperties | string[] | The properties to filter the datasource options on. |
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 |
---|---|---|
pattern | string | The Regular expression which is matched against the property. Only applicable to properties of the |
preconditions | Precondition[] | A list of child preconditions to be evaluated. Only applicable to properties of the |
expectedValue | object | The expected value of the property. Only applicable to properties of the |
expectedValues | object[] | A list of valid values of the property. Only applicable to properties of the |
precondition | Precondition | A precondition for visibility of a property. |
property | string | The property to be evaluated. |
type | string | The type of the precondition. |
The DeletionConstraint
object
A constraint on the values that are going to be deleted.
Element | Type | Description |
---|---|---|
customMessage | string | A custom message for invalid values. |
customValidatorId | string | The ID of a custom validator. |
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"
],
"keyProperty": "keyProperty",
"enums": {},
"types": {},
"properties": {},
"constraints": [
{
"customMessage": "string",
"customValidatorId": "my-min-max",
"maximumPropertyCount": 2,
"minimumPropertyCount": 1,
"properties": [
"string"
],
"type": "CUSTOM_VALIDATOR_REF"
}
],
"metadata": {},
"uiCustomization": {
"tabs": {
"groups": [
{
"properties": [
"string"
],
"displayName": "string",
"description": "string"
}
]
},
"callback": {
"buttons": [
{
"insert": {},
"displayName": "string",
"description": "string",
"identifier": "string"
}
]
},
"expandable": {
"sections": [
{
"expanded": true,
"properties": [
"string"
],
"displayName": "string",
"description": "string"
}
],
"expanded": true,
"displayName": "string"
},
"table": {
"columns": [
{
"propertyRef": "apiColor",
"builtinColumnRef": "summary",
"type": "cell-color-picker",
"displayName": "Color"
}
],
"emptyState": {
"text": "string"
}
}
},
"deletionConstraints": [
{
"customMessage": "string",
"customValidatorId": "my-min-max"
}
]
}