Получение схемы расширения

Материал из Документация Ключ-АСТРОМ
Версия от 15:45, 15 сентября 2022; RGolovanov (обсуждение | вклад)
(разн.) ← Предыдущая | Текущая версия (разн.) | Следующая → (разн.)

Функция получает схему указанной версии расширения Extensions 2.0.

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

GET Managed https://{your-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/{extensionVersion}/schema
SaaS https://{your-environment-id}.live.AstromKey.com/api/v2/extensions/{extensionName}/{extensionVersion}/schema
Окружающая среда АктивногоШлюза https://{your-activegate-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/{extensionVersion}/schema

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

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

Параметры

Параметр Тип Описание In Необходимость
extensionName string Имя запрошенного расширения 2.0. path требуется
extensionVersion string Версия запрашиваемого расширения 2.0 path требуется

Ответ

Коды ответов

Код Тип Описание
200 SchemaDefinitionRestDto Успех
404 ErrorEnvelope Не удалось. Запрошенный ресурс не существует.

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

Объект _ ResponseBody

Элемент Тип Описание
AstromKey string Версия формата данных.
schemaId string Идентификатор схемы.
displayName string Отображаемое имя схемы.
description string Краткое описание схемы.
documentation string Расширенное описание схемы и/или ссылки на документацию.

Может быть null.

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

Может быть null.

version string Версия схемы.
multiObject boolean Допускается несколько ( true) объектов на область или один ( false) объект на область.
ordered boolean Если trueпорядок объектов имеет семантическое значение.

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

Может быть null.

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

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

allowedScopes string[] Список областей, в которых можно использовать схему.
enums object Список определений свойств перечисления.
types object Список определений типов.

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

properties object Список свойств схемы.
constraints ComplexConstraint[] Список ограничений, ограничивающих значения, принимаемые схемой.

Может быть null.

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

Может быть null.

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

Может быть null.

Объект EnumType

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

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

Может быть null.

items EnumValue[] Список допустимых значений перечисления.
type string Тип свойства.

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

  • enum
documentation string Расширенное описание и/или ссылки на документацию.
displayName string Отображаемое имя свойства.

Может быть null.

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

Объект EnumValue

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

Элемент Тип Описание
enumInstance string Имя значения в существующем классе перечисления Java.

Может быть null.

icon string Значок значения.

Может быть null.

value object Допустимое значение перечисления.
displayName string Отображаемое имя значения.
description string Краткое описание стоимости.

Может быть null.

Объект SchemaType

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

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

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

Может быть null.

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

Может быть null.

version string Версия типа.
properties object Определение свойств, которые могут быть сохранены.
constraints ComplexConstraint[] Список ограничений, ограничивающих допустимые значения.

Может быть null.

documentation string Расширенное описание и/или ссылки на документацию.
displayName string Отображаемое имя свойства.

Может быть null.

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

Объект PropertyDefinition

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

Элемент Тип Описание
referencedType string Тип, на который ссылается значение свойства

Может быть null.

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

Может быть null.

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

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

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

Может быть null.

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

Может быть null.

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

Может быть null.

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

Может быть null.

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

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

  • ALWAYS
  • DEFAULT
  • NEVER

Может быть null.

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

Может быть null.

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

Может быть null.

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

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

Может быть null.

type object Тип значения свойства.
displayName string Отображаемое имя свойства.

Может быть null.

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

Может быть null.

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

Может быть null.

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

Может быть null.

nullable boolean Значение может ( true) или не может ( false) быть null.

Объект UiCustomization

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

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

Может быть null.

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

Может быть null.

Объект UiExpandableCustomization

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

Элемент Тип Описание
displayName string Отображаемое имя

Может быть null.

sections UiExpandableSectionCustomization[] Список разделов

Может быть null.

Объект UiExpandableSectionCustomization

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

Элемент Тип Описание
properties string[] Список свойств
displayName string Отображаемое имя
description string Описание

Может быть null.

Объект UiTableCustomization

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

Элемент Тип Описание
columns UiTableColumnCustomization[] Список столбцов для таблицы пользовательского интерфейса

Может быть null.

Объект UiTableColumnCustomization

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

Элемент Тип Описание
builtinColumnRef string Индивидуальная встроенная реализация столбца пользовательского интерфейса для этого столбца.

Может быть null.

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

Может быть null.

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

Может быть null.

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

Может быть null.

Объект Precondition

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

Элемент Тип Описание
expectedValue object Ожидаемая стоимость объекта.

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

Может быть null.

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

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

Может быть null.

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

Может быть null.

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

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

Может быть null.

property string Объект оценки.

Может быть null.

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

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

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

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

Может быть null.

Объект DatasourceDefinition

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

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

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

  • ALWAYS
  • INVALID_ONLY
  • NEVER

Может быть null.

свойства фильтра string[] Свойства для фильтрации параметров источника данных.
подтверждать boolean Следует ли проверять ввод, чтобы разрешить только значения, возвращаемые источником данных.
полныйконтекст boolean Ожидает ли этот источник данных полную настройку полезной нагрузки в качестве контекста.
useApiSearch boolean Если это правда, источник данных должен использовать API для фильтрации результатов вместо фильтрации на стороне клиента.
идентификатор string Идентификатор пользовательского источника данных значения свойства.

Объект Item

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

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

Может быть null.

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

Может быть null.

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

Может быть null.

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

Может быть null.

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

Может быть null.

type object Тип значения элемента.
displayName string Отображаемое имя элемента.

Может быть null.

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

Может быть null.

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

Может быть null.

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

Может быть null.

Объект Constraint

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

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

Может быть null.

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

Может быть null.

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

Может быть null.

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

Может быть null.

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

Может быть null.

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

Может быть null.

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

Может быть null.

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

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

  • CUSTOM_VALIDATOR_REF
  • LENGTH
  • NOT_BLANK
  • NOT_EMPTY
  • NO_WHITESPACE
  • PATTERN
  • RANGE
  • REGEX
  • TRIMMED
  • UNIQUE
  • UNKNOWN
pattern srting Шаблон регулярного выражения для допустимых строковых значений.

Может быть null.

Объект ComplexConstraint

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

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

Может быть null.

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

Может быть null.

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

Может быть null.

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

Может быть null.

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

Может быть null.

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

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

  • CUSTOM_VALIDATOR_REF
  • GREATER_THAN
  • GREATER_THAN_OR_EQUAL
  • LESS_THAN
  • LESS_THAN_OR_EQUAL
  • PROPERTY_COUNT_RANGE
  • UNKNOWN

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

{
  "AstromKey": "1",
  "schemaId": "builtin:container.built-in-monitoring-rule",
  "displayName": "Built-in container monitoring rules",
  "description": "AstromKey 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"
        }
      ]
    }
  }
}