• Home
  • Dynatrace API
  • Environment
  • Extensions 2.0
  • Extensions
  • GET an extension schema

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.

GETManaged 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

ParameterTypeDescriptionInRequired
extensionNamestring

The name of the requested extension 2.0.

pathrequired
extensionVersionstring

The version of the requested extension 2.0

pathrequired

Response

Response codes

CodeTypeDescription
200SchemaDefinitionRestDto

Success

404ErrorEnvelope

Failed. The requested resource doesn't exist.

Response body objects

The SchemaDefinitionRestDto object

ElementTypeDescription
dynatracestring

The version of the data format.

Can be null.

schemaIdstring

The ID of the schema.

Can be null.

displayNamestring

The display name of the schema.

Can be null.

descriptionstring

A short description of the schema.

Can be null.

documentationstring

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

Can be null.

schemaGroupsstring[]

Names of the groups, which the schema belongs to.

Can be null.

versionstring

The version of the schema.

Can be null.

multiObjectboolean

Multiple (true) objects per scope are permitted or a single (false) object per scope is permitted.

Can be null.

orderedboolean

If true the order of objects has semantic significance.

Only applicable when multiObject is set to true.

Can be null.

maxObjectsinteger

The maximum amount of objects per scope.

Only applicable when multiObject is set to true.

Can be null.

allowedScopesstring[]

A list of scopes where the schema can be used.

Can be null.

enumsobject

A list of definitions of enum properties.

Can be null.

typesobject

A list of definitions of types.

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

Can be null.

propertiesobject

A list of schema's properties.

Can be null.

constraintsComplexConstraint[]

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

Can be null.

metadataobject

Metadata of the setting.

Can be null.

uiCustomizationUiCustomization

Customization for UI elements

Can be null.

The EnumType object

Definition of an enum property.

ElementTypeDescription
enumClassstring

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

Can be null.

itemsEnumValue[]

A list of allowed values of the enum.

Can be null.

typestring

The type of the property.

The element can hold these values
  • enum

Can be null.

documentationstring

An extended description and/or links to documentation.

Can be null.

displayNamestring

The display name of the property.

Can be null.

descriptionstring

A short description of the property.

Can be null.

The EnumValue object

An allowed value for an enum property.

ElementTypeDescription
enumInstancestring

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

Can be null.

displayNamestring

The display name of the value.

Can be null.

valueobject

The allowed value of the enum.

Can be null.

descriptionstring

A short description of the value.

Can be null.

iconstring

The icon of the value.

Can be null.

The SchemaType object

A list of definitions of types.

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

ElementTypeDescription
summaryPatternstring

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

Can be null.

searchPatternstring

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

Can be null.

versionInfostring

A short description of the version.

Can be null.

constraintsComplexConstraint[]

A list of constraints limiting the values to be accepted.

Can be null.

propertiesobject

Definition of properties that can be persisted.

Can be null.

versionstring

The version of the type.

Can be null.

documentationstring

An extended description and/or links to documentation.

Can be null.

displayNamestring

The display name of the property.

Can be null.

descriptionstring

A short description of the property.

Can be null.

The ComplexConstraint object

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

ElementTypeDescription
customMessagestring

A custom message for invalid values.

Can be null.

minimumPropertyCountinteger

The minimum number of properties that must be set.

Can be null.

maximumPropertyCountinteger

The maximum number of properties that can be set.

Can be null.

customValidatorIdstring

The ID of a custom validator.

Can be null.

propertiesstring[]

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

Can be null.

typestring

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

Can be null.

The PropertyDefinition object

Configuration of a property in a settings schema.

ElementTypeDescription
referencedTypestring

The type referenced by the property value

Can be null.

itemsItem

An item of a collection property.

Can be null.

documentationstring

An extended description and/or links to documentation.

Can be null.

maxObjectsinteger

The maximum number of objects in a collection property.

Has the value of 1 for singletons.

Can be null.

uiCustomizationUiCustomization

Customization for UI elements

Can be null.

modificationPolicystring

Modification policy of the property.

The element can hold these values
  • ALWAYS
  • DEFAULT
  • NEVER

Can be null.

preconditionPrecondition

A precondition for visibility of a property.

Can be null.

datasourceDatasourceDefinition

Configuration of a datasource for a property.

Can be null.

minObjectsinteger

The minimum number of objects in a collection property.

Can be null.

subTypestring

The subtype of the property's value.

Can be null.

displayNamestring

The display name of the property.

Can be null.

constraintsConstraint[]

A list of constraints limiting the values to be accepted.

Can be null.

defaultobject

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.

Can be null.

typeobject

The type of the property's value.

Can be null.

descriptionstring

A short description of the property.

Can be null.

metadataobject

Metadata of the property.

Can be null.

nullableboolean

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

Can be null.

The Item object

An item of a collection property.

ElementTypeDescription
referencedTypestring

The type referenced by the item's value.

Can be null.

documentationstring

An extended description and/or links to documentation.

Can be null.

uiCustomizationUiCustomization

Customization for UI elements

Can be null.

datasourceDatasourceDefinition

Configuration of a datasource for a property.

Can be null.

subTypestring

The subtype of the item's value.

Can be null.

displayNamestring

The display name of the item.

Can be null.

constraintsConstraint[]

A list of constraints limiting the values to be accepted.

Can be null.

typeobject

The type of the item's value.

Can be null.

descriptionstring

A short description of the item.

Can be null.

metadataobject

Metadata of the items.

Can be null.

The UiCustomization object

Customization for UI elements

ElementTypeDescription
expandableUiExpandableCustomization

UI customization for expandable section

Can be null.

tableUiTableCustomization

Customization for UI tables

Can be null.

The UiExpandableCustomization object

UI customization for expandable section

ElementTypeDescription
displayNamestring

The display name

Can be null.

sectionsUiExpandableSectionCustomization[]

A list of sections

Can be null.

The UiExpandableSectionCustomization object

Expandable section customization for UI

ElementTypeDescription
displayNamestring

The display name

Can be null.

propertiesstring[]

A list of properties

Can be null.

descriptionstring

The description

Can be null.

The UiTableCustomization object

Customization for UI tables

ElementTypeDescription
columnsUiTableColumnCustomization[]

A list of columns for the UI table

Can be null.

The UiTableColumnCustomization object

Customization for UI table columns

ElementTypeDescription
propertyRefstring

The referenced property for this column.

Can be null.

displayNamestring

The display name for this column.

Can be null.

typestring

The ui specific type for this column.

Can be null.

The DatasourceDefinition object

Configuration of a datasource for a property.

ElementTypeDescription
resetValuestring

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

The element can hold these values
  • ALWAYS
  • INVALID_ONLY
  • NEVER

Can be null.

filterPropertiesstring[]

The properties to filter the datasource options on.

Can be null.

validateboolean

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

Can be null.

fullContextboolean

Whether this datasource expects full setting payload as the context.

Can be null.

useApiSearchboolean

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

Can be null.

identifierstring

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

Can be null.

The Constraint object

A constraint on the values accepted for a settings property.

ElementTypeDescription
maxLengthinteger

The maximum allowed length of string values.

Can be null.

minLengthinteger

The minimum required length of string values.

Can be null.

customMessagestring

A custom message for invalid values.

Can be null.

uniquePropertiesstring[]

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

Can be null.

customValidatorIdstring

The ID of a custom validator.

Can be null.

maximumnumber

The maximum allowed value.

Can be null.

minimumnumber

The minimum allowed value.

Can be null.

typestring

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

Can be null.

patternstring

The regular expression pattern for valid string values.

Can be null.

The Precondition object

A precondition for visibility of a property.

ElementTypeDescription
expectedValuesobject[]

A list of valid values of the property.

Only applicable to properties of the IN type.

Can be null.

preconditionPrecondition

A precondition for visibility of a property.

Can be null.

preconditionsPrecondition[]

A list of child preconditions to be evaluated.

Only applicable to properties of the AND and OR types.

Can be null.

expectedValueobject

The expected value of the property.

Only applicable to properties of the EQUALS type.

Can be null.

propertystring

The property to be evaluated.

Can be null.

typestring

The type of the precondition.

The element can hold these values
  • AND
  • EQUALS
  • IN
  • NOT
  • NULL
  • OR
  • REGEX_MATCH

Can be null.

patternstring

The Regular expression which is matched against the property.

Only applicable to properties of the REGEX_MATCH type.

Can be null.

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": [ { "customMessage": "string", "minimumPropertyCount": 1, "maximumPropertyCount": 2, "customValidatorId": "my-min-max", "properties": [ "string" ], "type": "CUSTOM_VALIDATOR_REF" } ], "metadata": {}, "uiCustomization": { "expandable": { "displayName": "string", "sections": [ { "displayName": "string", "properties": [ "string" ], "description": "string" } ] }, "table": { "columns": [ { "propertyRef": "apiColor", "displayName": "Color", "type": "cell-color-picker" } ] } } }
Related topics
  • Extensions

    Learn about the extensions framework offered by Dynatrace.