Получение схемы расширения - История изменений

IKuznetsov в 18:11, 2 января 2025

2025-01-02T18:11:58Z

← Предыдущая версия		Версия от 18:11, 2 января 2025
Строка 8:		Строка 8:
	\|-		\|-
	\|SaaS		\|SaaS
	\|<code><nowiki>https://{your-environment-id}.live.~~AstromKey~~.com/api/v2/extensions/{extensionName}/{extensionVersion}/schema</nowiki></code>		\|<code><nowiki>https://{your-environment-id}.live.AppOptima.com/api/v2/extensions/{extensionName}/{extensionVersion}/schema</nowiki></code>
	\|-		\|-
	\|Окружающая среда АктивногоШлюза		\|Окружающая среда АктивногоШлюза
Строка 63:		Строка 63:
	!Описание		!Описание
	\|-		\|-
	\|~~AstromKey~~		\|AppOptima
	\|string		\|string
	\|Версия формата данных.		\|Версия формата данных.
Строка 792:		Строка 792:
	=== JSON-модель тела ответа ===		=== JSON-модель тела ответа ===
	<{		<{
	"~~AstromKey~~": "1",		"AppOptima": "1",
	"schemaId": "builtin:container.built-in-monitoring-rule",		"schemaId": "builtin:container.built-in-monitoring-rule",
	"displayName": "Built-in container monitoring rules",		"displayName": "Built-in container monitoring rules",
	"description": "~~AstromKey~~ disables monitoring of containers that do not run any applications",		"description": "AppOptima disables monitoring of containers that do not run any applications",
	"documentation": "string",		"documentation": "string",
	"schemaGroups": [		"schemaGroups": [
Строка 849:		Строка 849:
	}		}
	}		}
	}~~</code>~~		}

IKuznetsov в 09:40, 26 декабря 2024

2024-12-26T09:40:50Z

← Предыдущая версия		Версия от 09:40, 26 декабря 2024
Строка 4:		Строка 4:
	{\| class="wikitable"		{\| class="wikitable"
	\| rowspan="3" \|GET		\| rowspan="3" \|GET
	\|~~Managed~~		\|АппОптима
	\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/{extensionVersion}/schema</nowiki></code>		\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/{extensionVersion}/schema</nowiki></code>
	\|-		\|-
Строка 791:		Строка 791:

	=== JSON-модель тела ответа ===		=== JSON-модель тела ответа ===
	<~~code>~~{		<{
	"AstromKey": "1",		"AstromKey": "1",
	"schemaId": "builtin:container.built-in-monitoring-rule",		"schemaId": "builtin:container.built-in-monitoring-rule",

RGolovanov в 15:45, 15 сентября 2022

2022-09-15T15:45:50Z

← Предыдущая версия		Версия от 15:45, 15 сентября 2022
Строка 8:		Строка 8:
	\|-		\|-
	\|SaaS		\|SaaS
	\|<code><nowiki>https://{your-environment-id}.live.~~dynatrace~~.com/api/v2/extensions/{extensionName}/{extensionVersion}/schema</nowiki></code>		\|<code><nowiki>https://{your-environment-id}.live.AstromKey.com/api/v2/extensions/{extensionName}/{extensionVersion}/schema</nowiki></code>
	\|-		\|-
	\|Окружающая среда АктивногоШлюза		\|Окружающая среда АктивногоШлюза
Строка 63:		Строка 63:
	!Описание		!Описание
	\|-		\|-
	\|~~dynatrace~~		\|AstromKey
	\|string		\|string
	\|Версия формата данных.		\|Версия формата данных.
Строка 792:		Строка 792:
	=== JSON-модель тела ответа ===		=== JSON-модель тела ответа ===
	<code>{		<code>{
	"~~dynatrace~~": "1",		"AstromKey": "1",
	"schemaId": "builtin:container.built-in-monitoring-rule",		"schemaId": "builtin:container.built-in-monitoring-rule",
	"displayName": "Built-in container monitoring rules",		"displayName": "Built-in container monitoring rules",
	"description": "~~Dynatrace~~ disables monitoring of containers that do not run any applications",		"description": "AstromKey disables monitoring of containers that do not run any applications",
	"documentation": "string",		"documentation": "string",
	"schemaGroups": [		"schemaGroups": [

ENetrebin в 06:34, 12 августа 2022

2022-08-12T06:34:39Z

← Предыдущая версия		Версия от 06:34, 12 августа 2022
Строка 1:		Строка 1:
	Функция получает схему указанной версии расширения Extensions 2.0.		Функция получает схему указанной версии расширения Extensions 2.0.

	Запрос создает <code>application/json</code>полезную нагрузку.		Запрос создает <code>application/json</code>полезную нагрузку.

ENetrebin: /* Объект _ UiCustomization */

2022-07-18T13:24:55Z

Объект _ UiCustomization

Внесённые изменения

ENetrebin: Новая страница: «Функция получает схему указанной версии расширения Extensions 2.0. Запрос создает `application/jso...»`


2022-07-18T11:47:07Z
Новая страница: «Функция получает схему указанной версии расширения Extensions 2.0.  Запрос создает <code>application/jso...»
Новая страница
Функция получает схему указанной версии расширения Extensions 2.0.



Запрос создает <code>application/json</code>полезную нагрузку.

{| class="wikitable"

| rowspan="3" |GET

|Managed

|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/{extensionVersion}/schema</nowiki></code>

|-

|SaaS

|<code><nowiki>https://{your-environment-id}.live.dynatrace.com/api/v2/extensions/{extensionName}/{extensionVersion}/schema</nowiki></code>

|-

|Окружающая среда АктивногоШлюза

|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/{extensionVersion}/schema</nowiki></code>

|}



== Аутентификация ==

Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия '''Чтение конфигураций мониторинга расширений''' ( <code>extensionConfigurations.read</code>) . Чтобы узнать, как его получить и использовать, см. раздел [[Токены и аутентификация (API)|Токены и аутентификация]] .



== Параметры ==

{| class="wikitable"

!Параметр

!Тип

!Описание

!In

!Необходимость

|-

|extensionName

|string

|Имя запрошенного расширения 2.0.

|path

|требуется

|-

|extensionVersion

|string

|Версия запрашиваемого расширения 2.0

|path

|требуется

|}



== Ответ ==



=== Коды ответов ===

{| class="wikitable"

!Код

|Тип

!Описание

|-

|200

|SchemaDefinitionRestDto

|Успех

|-

|404

|ErrorEnvelope

|Не удалось. Запрошенный ресурс не существует.

|}



=== Объекты тела ответа ===



==== Объект _ <code>ResponseBody</code> ====

{| class="wikitable"

!Элемент

!Тип

!Описание

|-

|dynatrace

|string

|Версия формата данных.

|-

|schemaId

|string

|Идентификатор схемы.

|-

|displayName

|string

|Отображаемое имя схемы.

|-

|description

|string

|Краткое описание схемы.

|-

|documentation

|string

|Расширенное описание схемы и/или ссылки на документацию.



Может быть <code>null</code>.

|-

|schemaGroups

|string[]

|Имена групп, которым принадлежит схема.



Может быть <code>null</code>.

|-

|version

|string

|Версия схемы.

|-

|multiObject

|boolean

|Допускается несколько ( <code>true</code>) объектов на область или один ( <code>false</code>) объект на область.

|-

|ordered

|boolean

|Если <code>true</code>порядок объектов имеет семантическое значение.



Применимо только в том случае, если для параметра multiObject установлено значение <code>true</code>.



Может быть <code>null</code>.

|-

|maxObjects

|integer

|Максимальное количество объектов на область действия.



Применимо только в том случае, если для параметра multiObject установлено значение <code>true</code>.

|-

|allowedScopes

|string[]

|Список областей, в которых можно использовать схему.

|-

|enums

|object

|Список определений свойств перечисления.

|-

|types

|object

|Список определений типов.



Тип — это сложное свойство, которое содержит собственный набор подсвойств.

|-

|properties

|object

|Список свойств схемы.

|-

|constraints

|ComplexConstraint[]

|Список ограничений, ограничивающих значения, принимаемые схемой.



Может быть <code>null</code>.

|-

|metadata

|object

|Метаданные настройки.



Может быть <code>null</code>.

|-

|uiCustomization

|UiCustomization

|Настройка элементов пользовательского интерфейса



Может быть <code>null</code>.

|}



==== Объект <code>EnumType</code> ====

Определение перечислимого свойства.

{| class="wikitable"

!Элемент

!Тип

!Описание

|-

|enumClass

|string

|Существующий класс перечисления Java, который содержит допустимые значения перечисления.



Может быть <code>null</code>.

|-

|items

|EnumValue[]

|Список допустимых значений перечисления.

|-

|type

|string

|Тип свойства.



Элемент может содержать эти значения



* <code>enum</code>

|-

|documentation

|string

|Расширенное описание и/или ссылки на документацию.

|-

|displayName

|string

|Отображаемое имя свойства.



Может быть <code>null</code>.

|-

|description

|string

|Краткое описание недвижимости.

|}



==== Объект <code>EnumValue</code> ====

Допустимое значение для перечислимого свойства.

{| class="wikitable"

!Элемент

!Тип

!Описание

|-

|enumInstance

|string

|Имя значения в существующем классе перечисления Java.



Может быть <code>null</code>.

|-

|icon

|string

|Значок значения.



Может быть <code>null</code>.

|-

|value

|object

|Допустимое значение перечисления.

|-

|displayName

|string

|Отображаемое имя значения.

|-

|description

|string

|Краткое описание стоимости.



Может быть <code>null</code>.

|}



==== Объект <code>SchemaType</code> ====

Список определений типов.



Тип — это сложное свойство, которое содержит собственный набор подсвойств.

{| class="wikitable"

!Элемент

!Тип

!Описание

|-

|summaryPattern

|string

|Шаблон для сводки (например, «Предупреждение через ''X'' минут») конфигурации в пользовательском интерфейсе.

|-

|searchPattern

|string

|Шаблон для сводного поиска (например, «Предупреждение через ''X'' минут») конфигурации в пользовательском интерфейсе.



Может быть <code>null</code>.

|-

|versionInfo

|string

|Краткое описание версии.



Может быть <code>null</code>.

|-

|version

|string

|Версия типа.

|-

|properties

|object

|Определение свойств, которые могут быть сохранены.

|-

|constraints

|ComplexConstraint[]

|Список ограничений, ограничивающих допустимые значения.



Может быть <code>null</code>.

|-

|documentation

|string

|Расширенное описание и/или ссылки на документацию.

|-

|displayName

|string

|Отображаемое имя свойства.



Может быть <code>null</code>.

|-

|description

|string

|Краткое описание недвижимости.

|}



==== Объект <code>PropertyDefinition</code> ====

Конфигурация свойства в схеме настроек.

{| class="wikitable"

!Элемент

!Тип

!Описание

|-

|referencedType

|string

|Тип, на который ссылается значение свойства



Может быть <code>null</code>.

|-

|documentation

|string

|Расширенное описание и/или ссылки на документацию.



Может быть <code>null</code>.

|-

|maxObjects

|integer

|Максимальное количество объектов в свойстве коллекции.



Имеет значение <code>1</code>для синглетонов.

|-

|uiCustomization

|UiCustomization

|Настройка элементов пользовательского интерфейса



Может быть <code>null</code>.

|-

|precondition

|Precondition

|Предварительное условие видимости свойства.



Может быть <code>null</code>.

|-

|datasource

|DatasourceDefinition

|Конфигурация источника данных для свойства.



Может быть <code>null</code>.

|-

|minObjects

|integer

|Минимальное количество объектов в свойстве коллекции.



Может быть <code>null</code>.

|-

|modificationPolicy

|string

|Политика модификации свойства.



Элемент может содержать эти значения



* <code>ALWAYS</code>

* <code>DEFAULT</code>

* <code>NEVER</code>



Может быть <code>null</code>.

|-

|items

|Item

|Элемент свойства коллекции.



Может быть <code>null</code>.

|-

|subType

|string

|Подтип значения свойства.



Может быть <code>null</code>.

|-

|default

|object

|Значение по умолчанию, которое будет использоваться, если значение не указано.



Если не-синглтон имеет значение <code>null</code>, это означает пустую коллекцию.



Может быть <code>null</code>.

|-

|type

|object

|Тип значения свойства.

|-

|displayName

|string

|Отображаемое имя свойства.



Может быть <code>null</code>.

|-

|description

|string

|Краткое описание недвижимости.



Может быть <code>null</code>.

|-

|metadata

|object

|Метаданные свойства.



Может быть <code>null</code>.

|-

|constraints

|Constraint[]

|Список ограничений, ограничивающих допустимые значения.



Может быть <code>null</code>.

|-

|nullable

|boolean

|Значение может ( <code>true</code>) или не может ( <code>false</code>) быть <code>null</code>.

|}



==== Объект _ <code>UiCustomization</code> ====

Настройка элементов пользовательского интерфейса

{| class="wikitable"

!Элемент

!Тип

!Описание

|-

|расширяемый

|Расширенная настройка пользовательского интерфейса

|Настройка пользовательского интерфейса для расширяемого раздела



Может быть <code>null</code>.

|-

|стол

|Настройка пользовательского интерфейса

|Настройка таблиц пользовательского интерфейса



Может быть <code>null</code>.

|}



==== Объект _ <code>UiExpandableCustomization</code> ====

Настройка пользовательского интерфейса для расширяемого раздела

{| class="wikitable"

!Элемент

!Тип

!Описание

|-

|показать имя

|нить

|Отображаемое имя



Может быть <code>null</code>.

|-

|разделы

|Настройка расширяемого раздела пользовательского интерфейса []

|Список разделов



Может быть <code>null</code>.

|}



==== Объект _ <code>UiExpandableSectionCustomization</code> ====

Настройка расширяемого раздела для пользовательского интерфейса

{| class="wikitable"

!Элемент

!Тип

!Описание

|-

|характеристики

|строка []

|Список свойств

|-

|показать имя

|нить

|Отображаемое имя

|-

|описание

|нить

|Описание



Может быть <code>null</code>.

|}



==== Объект _ <code>UiTableCustomization</code> ====

Настройка таблиц пользовательского интерфейса

{| class="wikitable"

!Элемент

!Тип

!Описание

|-

|столбцы

|Настройка столбца таблицы пользовательского интерфейса []

|Список столбцов для таблицы пользовательского интерфейса



Может быть <code>null</code>.

|}



==== Объект _ <code>UiTableColumnCustomization</code> ====

Настройка столбцов таблицы пользовательского интерфейса

{| class="wikitable"

!Элемент

!Тип

!Описание

|-

|встроенный столбецRef

|нить

|Индивидуальная встроенная реализация столбца пользовательского интерфейса для этого столбца.



Может быть <code>null</code>.

|-

|свойствоRef

|нить

|Свойство, на которое указывает ссылка, для этого столбца.



Может быть <code>null</code>.

|-

|тип

|нить

|Конкретный тип пользовательского интерфейса для этого столбца.



Может быть <code>null</code>.

|-

|показать имя

|нить

|Отображаемое имя для этого столбца.



Может быть <code>null</code>.

|}



==== Объект _ <code>Precondition</code> ====

Предварительное условие видимости свойства.

{| class="wikitable"

!Элемент

!Тип

!Описание

|-

|ожидаемое значение

|объект

|Ожидаемая стоимость объекта.



Применимо только к свойствам <code>EQUALS</code>типа.



Может быть <code>null</code>.

|-

|ожидаемые значения

|объект []

|Список допустимых значений свойства.



Применимо только к свойствам <code>IN</code>типа.



Может быть <code>null</code>.

|-

|предварительное условие

|предварительное условие

|Предварительное условие видимости свойства.



Может быть <code>null</code>.

|-

|предварительные условия

|Предварительное условие []

|Список дочерних предварительных условий для оценки.



Применимо только к свойствам типов <code>AND</code>и <code>OR</code>.



Может быть <code>null</code>.

|-

|имущество

|нить

|Объект оценки.



Может быть <code>null</code>.

|-

|тип

|нить

|Тип предварительного условия.



Элемент может содержать эти значения

|-

|шаблон

|нить

|Регулярное выражение, которое сопоставляется со свойством.



Применимо только к свойствам <code>REGEX_MATCH</code>типа.



Может быть <code>null</code>.

|}



==== Объект _ <code>DatasourceDefinition</code> ====

Конфигурация источника данных для свойства.

{| class="wikitable"

!Элемент

!Тип

!Описание

|-

|resetValue

|нить

|Когда сбрасывать значение источника данных в пользовательском интерфейсе при изменении фильтра.



Элемент может содержать эти значения



Может быть <code>null</code>.

|-

|свойства фильтра

|строка []

|Свойства для фильтрации параметров источника данных.

|-

|подтверждать

|логический

|Следует ли проверять ввод, чтобы разрешить только значения, возвращаемые источником данных.

|-

|полныйконтекст

|логический

|Ожидает ли этот источник данных полную настройку полезной нагрузки в качестве контекста.

|-

|useApiSearch

|логический

|Если это правда, источник данных должен использовать API для фильтрации результатов вместо фильтрации на стороне клиента.

|-

|идентификатор

|нить

|Идентификатор пользовательского источника данных значения свойства.

|}



==== Объект _ <code>Item</code> ====

Элемент свойства коллекции.

{| class="wikitable"

!Элемент

!Тип

!Описание

|-

|ссылочный тип

|нить

|Тип, на который ссылается значение элемента.



Может быть <code>null</code>.

|-

|документация

|нить

|Расширенное описание и/или ссылки на документацию.



Может быть <code>null</code>.

|-

|uiНастройка

|Пользовательский интерфейс

|Настройка элементов пользовательского интерфейса



Может быть <code>null</code>.

|-

|источник данных

|Определение источника данных

|Конфигурация источника данных для свойства.



Может быть <code>null</code>.

|-

|подтип

|нить

|Подтип значения элемента.



Может быть <code>null</code>.

|-

|тип

|объект

|Тип значения элемента.

|-

|показать имя

|нить

|Отображаемое имя элемента.



Может быть <code>null</code>.

|-

|описание

|нить

|Краткое описание предмета.



Может быть <code>null</code>.

|-

|метаданные

|объект

|Метаданные предметов.



Может быть <code>null</code>.

|-

|ограничения

|Ограничение []

|Список ограничений, ограничивающих допустимые значения.



Может быть <code>null</code>.

|}



==== Объект _ <code>Constraint</code> ====

Ограничение на значения, принимаемые для свойства настроек.

{| class="wikitable"

!Элемент

!Тип

!Описание

|-

|максимальная длина

|целое число

|Максимально допустимая длина строковых значений.



Может быть <code>null</code>.

|-

|минДлина

|целое число

|Минимальная требуемая длина строковых значений.



Может быть <code>null</code>.

|-

|уникальные свойства

|строка []

|Список свойств, для которых комбинация значений должна быть уникальной.



Может быть <code>null</code>.

|-

|пользовательское сообщение

|нить

|Пользовательское сообщение для недопустимых значений.



Может быть <code>null</code>.

|-

|customValidatorId

|нить

|Идентификатор пользовательского валидатора.



Может быть <code>null</code>.

|-

|максимум

|количество

|Максимально допустимое значение.



Может быть <code>null</code>.

|-

|минимум

|количество

|Минимально допустимое значение.



Может быть <code>null</code>.

|-

|тип

|нить

|Тип ограничения.



Элемент может содержать эти значения

|-

|шаблон

|нить

|Шаблон регулярного выражения для допустимых строковых значений.



Может быть <code>null</code>.

|}



==== Объект _ <code>ComplexConstraint</code> ====

Ограничение на значения, принимаемые для сложного свойства настроек.

{| class="wikitable"

!Элемент

!Тип

!Описание

|-

|пользовательское сообщение

|нить

|Пользовательское сообщение для недопустимых значений.



Может быть <code>null</code>.

|-

|customValidatorId

|нить

|Идентификатор пользовательского валидатора.



Может быть <code>null</code>.

|-

|МинимумPropertyCount

|целое число

|Минимальное количество свойств, которые необходимо установить.



Может быть <code>null</code>.

|-

|максимальное свойство

|целое число

|Максимальное количество свойств, которые можно установить.



Может быть <code>null</code>.

|-

|характеристики

|строка []

|Список свойств (определяемых идентификаторами), которые используются для проверки ограничения.



Может быть <code>null</code>.

|-

|тип

|нить

|Тип ограничения.



Элемент может содержать эти значения

|}



=== JSON-модель тела ответа ===

 <code>{

   "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": [

         {

           "properties": [

             "string"

           ],

           "displayName": "string",

           "description": "string"

         }

       ]

     },

     "table": {

       "columns": [

         {

           "builtinColumnRef": "summary",

           "propertyRef": "apiColor",

           "type": "cell-color-picker",

           "displayName": "Color"

         }

       ]

     }

   }

 }</code>

Получение схемы расширения - История изменений

IKuznetsov в 18:11, 2 января 2025

IKuznetsov в 09:40, 26 декабря 2024

RGolovanov в 15:45, 15 сентября 2022

ENetrebin в 06:34, 12 августа 2022

ENetrebin: /* Объект _ UiCustomization */

ENetrebin: Новая страница: «Функция получает схему указанной версии расширения Extensions 2.0. Запрос создает application/jso...»

ENetrebin: Новая страница: «Функция получает схему указанной версии расширения Extensions 2.0. Запрос создает `application/jso...»`