Описание параметров схемы
PaginationMetadata
Метаданные постраничной навигации.
| Имя поля | Обязательное | Тип | Описание | Пример |
|---|---|---|---|---|
|
Да |
|
Общее количество записей |
|
|
Да |
|
Количество возвращаемых элементов в запросе |
|
|
Да |
|
Общее количество страниц |
|
|
Да |
|
Номер текущей страницы |
|
|
Да |
|
Признак наличия следующей страницы |
|
|
Да |
|
Признак наличия предыдущей страницы |
|
SpecificationsFilterRequest
Список фильтров для спецификаций конфигураций.
| Имя поля | Обязательное | Тип | Описание | Пример |
|---|---|---|---|---|
Да |
|
Имя, которое отображается в пользовательском интерфейсе |
|
|
Нет |
|
Описание формулы |
|
SpecificationsResponse
Список спецификаций конфигураций.
| Имя поля | Обязательное | Тип | Описание | Пример |
|---|---|---|---|---|
Да |
Список спецификаций конфигураций |
|||
Да |
Метаданные постраничной навигации |
SpecificationCreateRequest
Параметры для создания спецификации.
| Имя поля | Обязательное | Тип | Описание | Пример |
|---|---|---|---|---|
Да |
|
Имя формулы |
|
|
Да |
|
Имя, которое отображается в пользовательском интерфейсе |
|
|
Нет |
|
Описание формулы |
|
|
Нет |
|
Имя конфигурационного файла формулы (при переопределении параметров) |
||
Нет |
Список атрибутов формулы |
Specification
Представление спецификации конфигурации.
| Имя поля | Обязательное | Тип | Описание | Пример |
|---|---|---|---|---|
Да |
|
Идентификатор спецификации конфигурации |
|
|
Да |
|
Имя формулы |
|
|
Да |
|
Имя, которое отображается в пользовательском интерфейсе |
|
|
Нет |
|
Описание формулы |
|
|
Нет |
|
Имя конфигурационного файла формулы (при переопределении параметров) |
||
Нет |
Список атрибутов формулы |
Id
Идентификатор спецификации конфигурации.
FormulaName
Имя формулы.
DisplayName
Имя, которое отображается в пользовательском интерфейсе.
Description
Описание формулы.
PillarConfigName
Имя конфигурационного файла формулы (при переопределении параметров).
PillarProperty
Атрибуты формулы, доступные для переопределения.
| Имя поля | Обязательное | Тип | Описание | Пример |
|---|---|---|---|---|
|
Да |
|
Ключ атрибута с полным путем |
|
|
Да |
|
Значение атрибута |
|
|
Нет |
|
Описание атрибута |
|
FormulaImportResult
Результат импорта формулы.
| Имя поля | Обязательное | Тип | Описание | Пример |
|---|---|---|---|---|
|
Да |
|
Количество файлов, которые не удалось загрузить |
|
|
Да |
|
BasicError
Информация об ошибке.
| Имя поля | Обязательное | Тип | Описание | Пример |
|---|---|---|---|---|
Да |
|
Код ошибки. Допустимые значения:
|
|
|
|
Да |
|
Сообщение об ошибки |
|
ErrorCode
Код ошибки. Допустимые значения:
-
object_already_exists— объект уже существует; -
object_not_found— объект не найден; -
validation_failed— ошибка валидации; -
authorization_failed— ошибка авторизации; -
internal_error— внутренняя ошибка.
ExtendedError
Подробное сообщение об ошибке.
| Имя поля | Обязательное | Тип | Описание | Пример |
|---|---|---|---|---|
Да |
|
Код ошибки. Допустимые значения:
|
|
|
|
Да |
|
Сообщение об ошибке |
|