ENetrebin: Новая страница: «Получает параметры указанной схемы настроек. Запрос создает в качестве полезной нагруз...»

2022-10-20T12:20:19Z

Новая страница: «Получает параметры указанной схемы настроек. Запрос создает в качестве полезной нагруз...»

Новая страница

Получает параметры указанной схемы настроек.

Запрос создает в качестве полезной нагрузки <code>application/json</code> формат.
{| class="wikitable"
| rowspan="2" |GET
|Managed
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/{schemaId}</nowiki></code>
|-
|Cреда АктивногоШлюза
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/{schemaId}</nowiki></code>
|}

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

== Параметры ==
{| class="wikitable"
!Параметр
!Тип
!Описание
!In
!Необходимость
|-
|schemaId
|string
|Идентификатор требуемой схемы.
|path
|требуется
|-
|schemaVersion
|string
|Версия требуемой схемы.

Если не задано, возвращается самая последняя версия.
|query
|по желанию
|}

== Ответ ==

=== Коды ответов ===
{| class="wikitable"
!Код
|Тип
!Описание
|-
|200
|chemaDefinitionRestDto
|Успех
|-
|403
|ErrorEnvelope
|Не удалось. Запрещенный.
|-
|404
|ErrorEnvelope
|Не удалось. Указанная схема не существует.
|}

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

==== Объект <code>SchemaDefinitionRestDto</code> ====
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|astromkey
|string
|Версия формата данных.
|-
|schemaId
|string
|Идентификатор схемы.
|-
|displayName
|string
|Отображаемое имя схемы.
|-
|description
|string
|Краткое описание схемы.
|-
|documentation
|string
|Расширенное описание схемы и/или ссылки на документацию.
|-
|schemaGroups
|string[]
|Имена групп, которым принадлежит схема.
|-
|version
|string
|Версия схемы.
|-
|multiObject
|boolean
|Допускается несколько ( <code>true</code>) объектов на область или один ( <code>false</code>) объект на область.
|-
|ordered
|boolean
|Если <code>true</code>порядок объектов имеет семантическое значение.

Применимо только в том случае, если для параметра multiObject установлено значение <code>true</code>.
|-
|maxObjects
|integer
|Максимальное количество объектов на область действия.

Применимо только в том случае, если для параметра multiObject установлено значение <code>true</code>.
|-
|allowedScopes
|string[]
|Список областей, в которых можно использовать схему.
|-
|enums
|object
|Список определений свойств перечисления.
|-
|types
|object
|Список определений типов.

Тип — это сложное свойство, которое содержит собственный набор подсвойств.
|-
|properties
|object
|Список свойств схемы.
|-
|constraints
|ComplexConstraint[]
|Список ограничений, ограничивающих значения, принимаемые схемой.
|-
|metadata
|object
|Метаданные настройки.
|-
|uiCustomization
|UiCustomization
|Настройка элементов пользовательского интерфейса
|}

==== Объект <code>EnumType</code> ====
Определение перечислимого свойства.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|enumClass
|string
|Существующий класс перечисления Java, который содержит допустимые значения перечисления.
|-
|items
|EnumValue[]
|Список допустимых значений перечисления.
|-
|type
|string
|Тип свойства.

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

* <code>enum</code>
|-
|documentation
|string
|Расширенное описание и/или ссылки на документацию.
|-
|displayName
|string
|Отображаемое имя свойства.
|-
|description
|string
|Краткое описание свойства.
|}

==== Объект <code>EnumValue</code> ====
Допустимое значение для перечислимого свойства.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|enumInstance
|string
|Имя значения в существующем классе перечисления Java.
|-
|icon
|string
|Значок значения.
|-
|displayName
|string
|Отображаемое имя значения.
|-
|description
|string
|Краткое описание стоимости.
|-
|value
|object
|Допустимое значение перечисления.
|}

==== Объект <code>SchemaType</code> ====
Список определений типов.

Тип — это сложное свойство, которое содержит собственный набор подсвойств.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|summaryPattern
|string
|Шаблон для сводки (например, «Предупреждение через ''X'' минут») конфигурации в пользовательском интерфейсе.
|-
|searchPattern
|string
|Шаблон для сводного поиска (например, «Предупреждение через ''X'' минут») конфигурации в пользовательском интерфейсе.
|-
|versionInfo
|string
|Краткое описание версии.
|-
|version
|string
|Версия типа.
|-
|constraints
|ComplexConstraint[]
|Список ограничений, ограничивающих допустимые значения.
|-
|properties
|object
|Определение свойств, которые могут быть сохранены.
|-
|documentation
|string
|Расширенное описание и/или ссылки на документацию.
|-
|displayName
|string
|Отображаемое имя свойства.
|-
|description
|string
|Краткое описание недвижимости.
|}

==== Объект <code>ComplexConstraint</code> ====
Ограничение на значения, принимаемые для сложного свойства настроек.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|customValidatorId
|string
|Идентификатор пользовательского валидатора.
|-
|customMessage
|string
|Пользовательское сообщение для недопустимых значений.
|-
|minimumPropertyCount
|integer
|Минимальное количество свойств, которые необходимо установить.
|-
|maximumPropertyCount
|integer
|Максимальное количество свойств, которые можно установить.
|-
|properties
|string[]
|Список свойств (определяемых идентификаторами), которые используются для проверки ограничения.
|-
|type
|string
|Тип ограничения.

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

* <code>CUSTOM_VALIDATOR_REF</code>
* <code>GREATER_THAN</code>
* <code>GREATER_THAN_OR_EQUAL</code>
* <code>LESS_THAN</code>
* <code>LESS_THAN_OR_EQUAL</code>
* <code>PROPERTY_COUNT_RANGE</code>
* <code>UNKNOWN</code>
|}

==== Объект <code>PropertyDefinition</code> ====
Конфигурация свойства в схеме настроек.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|referencedType
|string
|Тип, на который ссылается значение свойства
|-
|documentation
|string
|Расширенное описание и/или ссылки на документацию.
|-
|maxObjects
|integer
|Максимальное количество объектов в свойстве коллекции.

Имеет значение <code>1</code>для синглетонов.
|-
|uiCustomization
|UiCustomization
|Настройка элементов пользовательского интерфейса
|-
|datasource
|DatasourceDefinition
|Конфигурация источника данных для свойства.
|-
|minObjects
|integer
|Минимальное количество объектов в свойстве коллекции.
|-
|modificationPolicy
|string
|Политика модификации свойства.

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

* <code>ALWAYS</code>
* <code>DEFAULT</code>
* <code>NEVER</code>
|-
|precondition
|Precondition
|Предварительное условие видимости свойства.
|-
|items
|Item
|Элемент свойства коллекции.
|-
|subType
|string
|Подтип значения свойства.
|-
|displayName
|string
|Отображаемое имя свойства.
|-
|description
|string
|Краткое описание недвижимости.
|-
|metadata
|object
|Метаданные свойства.
|-
|constraints
|Constraint[]
|Список ограничений, ограничивающих допустимые значения.
|-
|nullable
|boolean
|Значение может ( <code>true</code>) или не может ( <code>false</code>) быть <code>null</code>.
|-
|default
|object
|Значение по умолчанию, которое будет использоваться, если значение не указано.

Если не-синглтон имеет значение <code>null</code>, это означает пустую коллекцию.
|-
|type
|object
|Тип значения свойства.
|}

==== Объект <code>UiCustomization</code> ====
Настройка элементов пользовательского интерфейса
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|tabs
|UiTabsCustomization
|Настройка пользовательского интерфейса для вкладок
|-
|expandable
|UiExpandableCustomization
|Настройка пользовательского интерфейса для расширяемого раздела
|-
|table
|UiTableCustomization
|Настройка таблиц пользовательского интерфейса
|}

==== Объект <code>UiTabsCustomization</code> ====
Настройка пользовательского интерфейса для вкладок
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|groups
|UiTabGroupCustomization[]
|Список групп
|}

==== Объект <code>UiTabGroupCustomization</code> ====
Настройка группы вкладок для пользовательского интерфейса
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|displayName
|string
|Отображаемое имя
|-
|description
|string
|Описание
|-
|properties
|string[]
|Список свойств
|}

==== Объект <code>UiExpandableCustomization</code> ====
Настройка пользовательского интерфейса для расширяемого раздела
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|expanded
|boolean
|Определяет, должен ли элемент расширяться по умолчанию
|-
|displayName
|string
|Отображаемое имя
|-
|sections
|UiExpandableSectionCustomization[]
|Список разделов
|}

==== Объект <code>UiExpandableSectionCustomization</code> ====
Настройка расширяемого раздела для пользовательского интерфейса
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|expanded
|boolean
|Определяет, должен ли раздел расширяться по умолчанию
|-
|displayName
|string
|Отображаемое имя
|-
|description
|string
|Описание
|-
|properties
|string[]
|Список свойств
|}

==== Объект <code>UiTableCustomization</code> ====
Настройка таблиц пользовательского интерфейса
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|emptyState
|UiEmptyStateCustomization
|Настройка пользовательского интерфейса для пустого состояния в таблице
|-
|columns
|UiTableColumnCustomization[]
|Список столбцов для таблицы пользовательского интерфейса
|}

==== Объект <code>UiEmptyStateCustomization</code> ====
Настройка пользовательского интерфейса для пустого состояния в таблице
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|text
|string
|Текст, который будет отображаться в пустом состоянии
|}

==== Объект <code>UiTableColumnCustomization</code> ====
Настройка столбцов таблицы пользовательского интерфейса
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|builtinColumnRef
|string
|Индивидуальная встроенная реализация столбца пользовательского интерфейса для этого столбца.
|-
|propertyRef
|string
|Свойство, на которое указывает ссылка, для этого столбца.
|-
|displayName
|string
|Отображаемое имя для этого столбца.
|-
|type
|string
|Конкретный тип пользовательского интерфейса для этого столбца.
|}

==== Объект <code>DatasourceDefinition</code> ====
Конфигурация источника данных для свойства.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|validate
|boolean
|Следует ли проверять ввод, чтобы разрешить только значения, возвращаемые источником данных.
|-
|fullContext
|boolean
|Ожидает ли этот источник данных полную настройку полезной нагрузки в качестве контекста.
|-
|useApiSearch
|boolean
|Если это правда, источник данных должен использовать API для фильтрации результатов вместо фильтрации на стороне клиента.
|-
|filterProperties
|string[]
|Свойства для фильтрации параметров источника данных.
|-
|resetValue
|string
|Когда сбрасывать значение источника данных в пользовательском интерфейсе при изменении фильтра.

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

* <code>ALWAYS</code>
* <code>INVALID_ONLY</code>
* <code>NEVER</code>
|-
|identifier
|string
|Идентификатор пользовательского источника данных значения свойства.
|}

==== Объект <code>Precondition</code> ====
Предварительное условие видимости свойства.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|precondition
|Precondition
|Предварительное условие видимости свойства.
|-
|preconditions
|Precondition[]
|Список дочерних предварительных условий для оценки.

Применимо только к свойствам типов <code>AND</code>и <code>OR</code>.
|-
|expectedValue
|object
|Ожидаемая стоимость объекта.

Применимо только к свойствам <code>EQUALS</code>типа.
|-
|expectedValues
|object[]
|Список допустимых значений свойства.

Применимо только к свойствам <code>IN</code>типа.
|-
|pattern
|string
|Регулярное выражение, которое сопоставляется со свойством.

Применимо только к свойствам <code>REGEX_MATCH</code>типа.
|-
|property
|string
|Объект оценки.
|-
|type
|string
|Тип предварительного условия.

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

* <code>AND</code>
* <code>EQUALS</code>
* <code>IN</code>
* <code>NOT</code>
* <code>NULL</code>
* <code>OR</code>
* <code>REGEX_MATCH</code>
|}

==== Объект <code>Item</code> ====
Элемент свойства коллекции.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|referencedType
|string
|Тип, на который ссылается значение элемента.
|-
|documentation
|string
|Расширенное описание и/или ссылки на документацию.
|-
|uiCustomization
|UiCustomization
|Настройка элементов пользовательского интерфейса
|-
|datasource
|DatasourceDefinition
|Конфигурация источника данных для свойства.
|-
|subType
|string
|Подтип значения элемента.
|-
|displayName
|string
|Отображаемое имя элемента.
|-
|description
|string
|Краткое описание предмета.
|-
|metadata
|object
|Метаданные предметов.
|-
|constraints
|Constraint[]
|Список ограничений, ограничивающих допустимые значения.
|-
|type
|object
|Тип значения элемента.
|}

==== Объект <code>Constraint</code> ====
Ограничение на значения, принимаемые для свойства настроек.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|maxLength
|integer
|Максимально допустимая длина строковых значений.
|-
|minLength
|integer
|Минимальная требуемая длина строковых значений.
|-
|customValidatorId
|string
|Идентификатор пользовательского валидатора.
|-
|customMessage
|string
|Пользовательское сообщение для недопустимых значений.
|-
|uniqueProperties
|string[]
|Список свойств, для которых комбинация значений должна быть уникальной.
|-
|maximum
|number
|Максимально допустимое значение.
|-
|minimum
|number
|Минимально допустимое значение.
|-
|pattern
|string
|Шаблон регулярного выражения для допустимых строковых значений.
|-
|type
|string
|Тип ограничения.

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

* <code>CUSTOM_VALIDATOR_REF</code>
* <code>LENGTH</code>
* <code>NOT_BLANK</code>
* <code>NOT_EMPTY</code>
* <code>NO_WHITESPACE</code>
* <code>PATTERN</code>
* <code>RANGE</code>
* <code>REGEX</code>
* <code>TRIMMED</code>
* <code>UNIQUE</code>
* <code>UNKNOWN</code>
|}

=== JSON-модель тела ответа ===
<code>{
"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": [
{
"customValidatorId": "my-min-max",
"customMessage": "string",
"minimumPropertyCount": 1,
"maximumPropertyCount": 2,
"properties": [
"string"
],
"type": "CUSTOM_VALIDATOR_REF"
}
],
"metadata": {},
"uiCustomization": {
"tabs": {
"groups": [
{
"displayName": "string",
"description": "string",
"properties": [
"string"
]
}
]
},
"expandable": {
"expanded": true,
"displayName": "string",
"sections": [
{
"expanded": true,
"displayName": "string",
"description": "string",
"properties": [
"string"
]
}
]
},
"table": {
"emptyState": {
"text": "string"
},
"columns": [
{
"builtinColumnRef": "summary",
"propertyRef": "apiColor",
"displayName": "Color",
"type": "cell-color-picker"
}
]
}
}
}</code>

GET схема - История изменений

ENetrebin: Новая страница: «Получает параметры указанной схемы настроек. Запрос создает в качестве полезной нагруз...»