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	Managed	`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 Read extension monitoring configurations (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	SchemaDefinitionRestDto	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 (`true`) objects per scope are permitted or a single (`false`) object per scope is permitted.
ordered	boolean	If `true` the order of objects has semantic significance. Only applicable when multiObject is set to `true`.
maxObjects	integer	The maximum amount of objects per scope. Only applicable when multiObject is set to `true`.
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	ComplexConstraint[]	A list of constrains limiting the values to be accepted by the schema.
metadata	object	Metadata of the setting.
uiCustomization	UiCustomization	Customization for UI elements

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	EnumValue[]	A list of allowed values of the enum.
type	string	The type of the property. The element can hold these values `enum`
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.
displayName	string	The display name of the value.
icon	string	The icon of the value.
value	object	The allowed value of the enum.
description	string	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.

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.
version	string	The version of the type.
versionInfo	string	A short description of the version.
constraints	ComplexConstraint[]	A list of constraints limiting the values to be accepted.
properties	object	Definition of properties that can be persisted.
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
minimumPropertyCount	integer	The minimum number of properties that must be set.
maximumPropertyCount	integer	The maximum number of properties that can be set.
customMessage	string	A custom message for invalid values.
customValidatorId	string	The ID of a custom validator.
properties	string[]	A list of properties (defined by IDs) that are used to check the constraint.
type	string	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 `PropertyDefinition` object

Configuration of a property in a settings schema.

Element	Type	Description
referencedType	string	The type referenced by the property value
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 `1` for singletons.
uiCustomization	UiCustomization	Customization for UI elements
datasource	DatasourceDefinition	Configuration of a datasource for a property.
minObjects	integer	The minimum number of objects in a collection property.
modificationPolicy	string	Modification policy of the property. The element can hold these values `ALWAYS` `DEFAULT` `NEVER`
precondition	Precondition	A precondition for visibility of a property.
items	Item	An item of a collection property.
displayName	string	The display name of the property.
subType	string	The subtype of the property's value.
constraints	Constraint[]	A list of constraints limiting the values to be accepted.
default	object	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.
type	object	The type of the property's value.
description	string	A short description of the property.
metadata	object	Metadata of the property.
nullable	boolean	The value can (`true`) or can't (`false`) be `null`.

The `UiCustomization` object

Customization for UI elements

Element	Type	Description
tabs	UiTabsCustomization	UI customization for tabs
expandable	UiExpandableCustomization	UI customization for expandable section
table	UiTableCustomization	Customization for UI tables

The `UiTabsCustomization` object

UI customization for tabs

Element	Type	Description
groups	UiTabGroupCustomization[]	A list of groups

The `UiTabGroupCustomization` object

Tab group customization for UI

Element	Type	Description
displayName	string	The display name
properties	string[]	A list of properties
description	string	The description

The `UiExpandableCustomization` object

UI customization for expandable section

Element	Type	Description
expanded	boolean	Defines if the item should be expanded by default
displayName	string	The display name
sections	UiExpandableSectionCustomization[]	A list of sections

The `UiExpandableSectionCustomization` object

Expandable section customization for UI

Element	Type	Description
expanded	boolean	Defines if the section should be expanded by default
displayName	string	The display name
properties	string[]	A list of properties
description	string	The description

The `UiTableCustomization` object

Customization for UI tables

Element	Type	Description
emptyState	UiEmptyStateCustomization	UI customization for empty state in a table
columns	UiTableColumnCustomization[]	A list of columns for the UI table

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 `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.
displayName	string	The display name for this column.
type	string	The ui specific type for this column.

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. The element can hold these values `ALWAYS` `INVALID_ONLY` `NEVER`
filterProperties	string[]	The properties to filter the datasource options on.
useApiSearch	boolean	If true, the datasource should use the api to filter the results instead of client-side filtering.
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.
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 `EQUALS` type.
expectedValues	object[]	A list of valid values of the property. Only applicable to properties of the `IN` type.
preconditions	Precondition[]	A list of child preconditions to be evaluated. Only applicable to properties of the `AND` and `OR` types.
precondition	Precondition	A precondition for visibility of a property.
property	string	The property to be evaluated.
type	string	The type of the precondition. The element can hold these values `AND` `EQUALS` `IN` `NOT` `NULL` `OR` `REGEX_MATCH`
pattern	string	The Regular expression which is matched against the property. Only applicable to properties of the `REGEX_MATCH` type.

The `Item` object

An item of a collection property.

Element	Type	Description
referencedType	string	The type referenced by the item's value.
documentation	string	An extended description and/or links to documentation.
uiCustomization	UiCustomization	Customization for UI elements
datasource	DatasourceDefinition	Configuration of a datasource for a property.
displayName	string	The display name of the item.
subType	string	The subtype of the item's value.
constraints	Constraint[]	A list of constraints limiting the values to be accepted.
type	object	The type of the item's value.
description	string	A short description of the item.
metadata	object	Metadata of the items.

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.
minLength	integer	The minimum required length of string values.
uniqueProperties	string[]	A list of properties for which the combination of values must be unique.
customMessage	string	A custom message for invalid values.
customValidatorId	string	The ID of a custom validator.
maximum	number	The maximum allowed value.
minimum	number	The minimum allowed value.
type	string	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`
pattern	string	The regular expression pattern for valid string values.

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

Extensions 2.0 API - GET an extension schema

Authentication

Parameters

Response

Response codes

Response body objects

The SchemaDefinitionRestDto object

The EnumType object

The EnumValue object

The SchemaType object

The ComplexConstraint object

The PropertyDefinition object

The UiCustomization object

The UiTabsCustomization object

The UiTabGroupCustomization object

The UiExpandableCustomization object

The UiExpandableSectionCustomization object

The UiTableCustomization object

The UiEmptyStateCustomization object

The UiTableColumnCustomization object

The DatasourceDefinition object

The Precondition object

The Item object

The Constraint object