Описание параметров схемы

BasicError

Информация об ошибке.

Имя поля Обязательное Тип Описание Пример

code

Да

string

Код ошибки. Включает параметр ErrorCode. Допустимые значения:

  • object_already_exists — объект уже существует;

  • object_not_found — объект не найден;

  • validation_failed — ошибка валидации;

  • authorization_failed — ошибка авторизации;

  • internal_error — внутренняя ошибка

validation_failed

message

Да

string

Сообщение об ошибке

Template contains not resolved variables

CategoryCreateRequest

Параметры для создания категории конфигураций.

Имя поля Обязательное Тип Описание Пример

id

Да

string

Идентификатор категории конфигураций (макс. длина: 64). Включает параметр CategoryId

Network_Browser123

name

Да

string

Название категории конфигураций (макс. длина: 255). Включает параметр CategoryName

Офис

description

Нет

string

Описание категории конфигураций (макс. длина: 64). Включает параметр CategoryDescription

Категория программ для работы в сети Интернет

color

Да

string

Цвет в формате HEX (макс. длина: 6). Включает параметр HexColor

00ff00

iconCode

Да

string

Код изображения для категории (макс. длина: 255). Включает параметр IconCode

ms_office_icon

CategoryDescription

Описание категории конфигураций.

Тип: string.

Пример: Категория программ для работы в сети Интернет.

CategoryId

Идентификатор категории конфигураций (макс. длина: 64).

Тип: string.

Шаблон: [A-Za-z0-9_\-]+.

Пример: Network_Browser123.

CategoriesListResponse

Список категорий конфигураций.

Имя поля Обязательное Тип Описание Пример

categories

Да

Список категорий конфигураций. Включает параметры CategoryResponse

meta

Да

Категории конфигураций. Включает параметры PaginationMetadata

CategoryName

Название категории конфигураций (макс. длина: 255).

Тип: string.

Пример: Офис.

CategoryResponse

Перечень параметров категории конфигураций.

Имя поля Обязательное Тип Описание Пример

id

Да

string

Идентификатор категории конфигураций (макс. длина: 64). Шаблон: [A-Za-z0-9_\-]+. Включает параметр CategoryId

Network_Browser123

name

Да

string

Название категории конфигураций (макс. длина: 255). Включает параметр CategoryName

Офис

description

Нет

string

Описание категории конфигураций (макс. длина: 64). Включает параметр CategoryDescription

Категория программ для работы в сети Интернет

color

Да

string

Цвет в формате HEX. Шаблон: [A-Fa-f0-9]+. Включает параметр HexColor

00ff00

iconCode

Да

string

Код изображения для категории (макс. длина: 255). Включает параметр IconCode

ms_office_icon

createdAt

Нет

string

Дата создания

2023-08-27T09:37:40.000Z

updatedAt

Нет

string

Дата последнего изменения

2023-08-27T09:37:40.000Z

CategoryUpdateRequest

Параметры для обновления категории конфигураций.

Имя поля Обязательное Тип Описание Пример

name

Да

string

Название категории конфигураций (макс. длина: 255). Включает параметр CategoryName

Офис

description

Нет

string

Описание категории конфигураций (макс. длина: 64). Включает параметр CategoryDescription

Категория программ для работы в сети Интернет

color

Да

string

Цвет в формате HEX. Шаблон: [A-Fa-f0-9]+ (макс. длина: 6). Включает параметр HexColor

00ff00

iconCode

Да

string

Код изображения для категории (макс. длина: 255). Включает параметр IconCode

ms_office_icon

ConfigurationIconPath

Путь/ссылка на изображение иконки относительно сервиса хранения мультимедиа-контента.

Тип: string.

Пример: icons/123321-7cb06ef0-87ab-4a60-b20e-33c2d9725a09-open-office.png.

ConfigurationImagesPaths

Список путей/ссылок на прикрепленные к ПО изображения относительно сервиса хранения мультимедиа-контента.

Тип: string.

Пример: images/123321-7cb06ef0-87ab-4a60-b20e-33c2d9725a09-open-office-screen03.jpg.

ConfigVersionChangelog

Описание обновления.

Тип: string.

Пример: Changelog 23-5-0:.

ConfigVersionCreteRequest

Тело запроса на создание версии конфигурации.

Имя поля Обязательное Тип Описание Пример

displayName

Да

string

Имя версии, которое отображается в пользовательском интерфейсе. Включает параметр ConfigVersionDisplayName

23.5.0

releaseDate

Да

string

Дата релиза версии. Включает параметр ConfigVersionReleaseDate

Рекомендуется указывать дату, не совпадающую с датами других выпущенных версий. При совпадении дат система может не определить создаваемую версию как более новую, и в магазине приложений не предложит обновить версию для данного ПО (см. раздел «Установка/обновление/удаление ПО»)

2023-05-19

softwareRequirements

Да

string

Системные требования для установки версии. Включает параметр ConfigVersionSoftwareRequirements

Оперативная память - Минимум 512 МБ

formulaName

Да

string

Имя формулы. Включает параметр ConfigVersionFormulaName

yandex-browser

pillarProperty

Нет

Конфигурация (pillar) с переопределяемыми параметрами формулы в JSON-формате. Включает параметры pillarProperty

features

Нет

string

Особенности установки — информационное сообщение, которое пользователь должен увидеть в окне подтверждения установки. Включает параметр ConfigVersionFeatures

Яндекс браузер 23.5.0

changelog

Нет

string

Описание обновления. Включает параметр ConfigVersionChangelog

yandex-browser

ConfigVersionDisplayName

Имя версии, которое отображается в пользовательском интерфейсе (мин. длина: 1; макс. длина: 255).

Тип: string.

Пример: 23.5.0.

ConfigVersionFeatures

Особенности установки — информационное сообщение, которое пользователь должен увидеть в окне подтверждения установки.

Тип: string.

Пример: Яндекс браузер 23.5.0.

ConfigVersionFilterRequest

Фильтры для запроса на получение версий конфигураций.

Имя поля Обязательное Тип Описание Пример

name

Нет

string

Фильтр для контекстного поиска по имени версии

23.5

createdBy

Нет

string

Автор создания. Включает параметр CreatedBy

vivanov@domain.local

updatedBy

Нет

string

Автор последнего изменения. Включает параметр UpdatedBy

vivanov@domain.local

showOnlyActive

Нет

boolean

Флаг отображения неактивных версий конфигураций при выводе списка

true

ConfigVersionFormulaName

Имя формулы (мин. длина: 1; макс. длина: 255).

Тип: string.

Пример: yandex-browser.

ConfigVersionListResponse

Список версий конфигурации.

Имя поля Обязательное Тип Описание Пример

versions

Да

Список версий конфигурации. Включает параметры ConfigVersionResponse

meta

Да

Метаданные постраничной навигации. Включает параметры PaginationMetadata

ConfigVersionReleaseDate

Дата релиза версии.

Тип: string(date).

Пример: 2023-05-19.

ConfigVersionResponse

Версия конфигурации.

Имя поля Обязательное Тип Описание Пример

id

Да

integer(int64)

Идентификатор версии конфигурации

1234

createdAt

Нет

string

Дата создания. Включает параметр CreatedDate

2023-08-27T09:37:40.000Z

updatedAt

Нет

string

Дата последнего изменения. Включает параметр UpdatedDate

2023-08-27T09:37:40.000Z

createdBy

Нет

string

Автор создания. Включает параметр CreatedBy

vivanov@domain.local

updatedBy

Нет

string

Автор последнего изменения. Включает параметр UpdatedBy

vivanov@domain.local

configurationId

Да

string

Идентификатор конфигурации (макс. длина: 255). Включает параметр ConfigurationId

5467

displayName

Да

string

Имя версии, которое отображается в пользовательском интерфейсе (мин. длина: 1; макс. длина: 255). Включает параметр ConfigVersionDisplayName

23.5.0

releaseDate

Да

string

Дата релиза версии. Включает параметр ConfigVersionReleaseDate

2023-05-19

softwareRequirements

Да

string

Системные требования для установки версии (мин. длина: 1; макс. длина: 2048). Включает параметр ConfigVersionSoftwareRequirements

Оперативная память - Минимум 512 МБ

formulaName

Да

string

Имя формулы (мин. длина: 1; макс. длина: 255). Включает параметр ConfigVersionFormulaName

yandex-browser

pillarProperty

Нет

Конфигурация (pillar) с переопределяемыми параметрами формулы в JSON-формате. Включает параметры pillarProperty

features

Нет

string

Особенности установки — информационное сообщение, которое пользователь должен увидеть в окне подтверждения установки. Включает параметр ConfigVersionFeatures

Яндекс браузер 23.5.0

changelog

Нет

string

Описание обновления. Включает параметр ConfigVersionChangelog

yandex-browser

isActive

Нет

boolean

Флаг активности версии конфигурации

true

ConfigVersionSoftwareRequirements

Системные требования для установки версии — минимум 512 МБ (мин. длина: 1; макс. длина: 2048).

Тип: string.

Пример: Оперативная память.

ConfigVersionUpdateRequest

Тело запроса на обновление версии конфигурации.

Имя поля Обязательное Тип Описание Пример

displayName

Да

string

Имя версии, которое отображается в пользовательском интерфейсе (мин. длина: 1; макс. длина: 255). Включает параметр ConfigVersionDisplayName

23.5.0

releaseDate

Да

string

Дата релиза версии. Включает параметр ConfigVersionReleaseDate

2023-05-19

softwareRequirements

Да

string

Системные требования для установки версии (мин. длина: 1; макс. длина: 2048). Включает параметр ConfigVersionSoftwareRequirements

Оперативная память — минимум 512 МБ

formulaName

Да

string

Имя формулы (мин. длина: 1; макс. длина: 255). Включает параметр ConfigVersionFormulaName

yandex-browser

pillarProperty

Нет

Конфигурация (pillar) с переопределяемыми параметрами формулы в JSON-формате. Включает параметры pillarProperty

features

Нет

string

Особенности установки — информационное сообщение, которое пользователь должен увидеть в окне подтверждения установки. Включает параметр ConfigVersionFeatures

Яндекс браузер 23.5.0

changelog

Нет

string

Описание обновления. Включает параметр ConfigVersionChangelog

yandex-browser

CreatedBy

Автор создания.

Тип: string.

Пример: vivanov@domain.local.

СreatedDate

Дата создания.

Тип: string.

Пример: 2023-08-27T09:37:40.000Z.

DefaultVersion

Идентификатор актуальной версии (версии по умолчанию) данного ПО.

Тип: integer(int64).

Мин. знаение: 1.

Пример: 1234.

Description

Описание конфигурации.

Тип: string.

Пример: Браузер от компании Яндекс

ConfigurationDisplayName

Название конфигурации, которое отображается в пользовательском интерфейсе (макс. длина: 255).

Тип: string.

Пример: Яндекс браузер.

ErrorCode

Код ошибки.

Тип: string.

Допустимые значения:

  • object_already_exists — объект уже существует;

  • object_not_found — объект не найден;

  • validation_failed — ошибка валидации;

  • authorization_failed — ошибка авторизации;

  • internal_error — внутренняя ошибка.

ExtendedError

Подробное сообщение об ошибке.

Имя поля Обязательное Тип Описание Пример

code

Да

Код ошибки. Включает параметр ErrorCode. Допустимые значения:

  • object_already_exists — объект уже существует;

  • object_not_found — объект не найден;

  • validation_failed — ошибка валидации;

  • authorization_failed — ошибка авторизации;

  • internal_error — внутренняя ошибка

validation_failed

message

Да

string

Сообщение об ошибке

Template contains not resolved variables

FileUrl

Относительный URL для загрузки файла.

Тип: string (макс. длина: 255).

Пример: images/open_office_aa-bb-00-11-ee.jpg.

FileSize

Размер загруженного файла в байтах.

Тип: integer(int32).

Пример: 512000.

FormulaImportResult

Результат импорта формулы.

Имя поля Обязательное Тип Описание Пример

ignoredFilesCount

Да

integer

Количество файлов, которые не удалось загрузить

3

errors

Да

string

FormulaName

Название формулы (макс. длина: 255).

Тип: string.

Пример: yandex-browser.

FullDescription

Подробное описание конфигурации.

Тип: string.

Пример: Браузер от компании Яндекс.(…​).

Guide

Инструкция.

Тип: string.

Пример: Если вы не сделали его основным, при его запуске может появляться окно Сделать этот браузер основным? Чтобы окно больше не показывалось, включите опцию Больше не спрашивать и нажмите Не сейчас.

HexColor

Цвет в формате HEX (макс. длина: 6).

Тип: string.

Шаблон: [A-Fa-f0-9]+.

Пример: 00ff00.

IconCode

Код изображения для категории (макс. длина: 255).

Тип: string.

Пример: ms_office_icon.

IsApplication

Флаг, который определяет, является ли конфигурация приложением для отображения в магазине ПО.

Тип: boolean.

Пример: true.

PaginationMetadata

Метаданные постраничной навигации.

Имя поля Обязательное Тип Описание Пример

totalRecords

Да

integer

Общее количество записей

1729

pageSize

Да

integer

Количество возвращаемых элементов в запросе

20

totalPages

Да

integer

Общее количество страниц

87

currentPage

Да

integer

Номер текущей страницы

2

hasNext

Да

boolean

Признак наличия следующей страницы

true

hasPrev

Да

boolean

Признак наличия предыдущей страницы

true

PillarProperty

Конфигурация (pillar) с переопределяемыми параметрами формулы в JSON-формате.

ConfigurationCreateRequest

Параметры для создания конфигурации.

Имя поля Обязательное Тип Описание Пример

displayName

Да

Имя, которое отображается в пользовательском интерфейсе (макс. длина: 255). Включает параметр ConfigurationDisplayName

Яндекс браузер

description

Нет

string

Описание конфигурации. Включает параметр Description

Браузер от компании Яндекс

fullDescription

Нет

string

Подробное описание конфигурации. Включает параметр FullDescription

Браузер от компании Яндекс.(…​)

guide

Нет

string

Инструкция. Включает параметр Guide

Если вы не сделали его основным, при его запуске может появляться окно Сделать этот браузер основным? Чтобы окно больше не отображалось, включите опцию Больше не спрашивать и нажмите Не сейчас.

isApplication

Да

Флаг, который указывает, является ли конфигурация приложением для отображения в магазине ПО. Включает параметр IsApplication

tags

Нет

string

Тэг конфигурации для классификации и быстрого поиска (макс. длина: 255). Включает параметр Tag

Сертификаты банка

categories

Нет

string

Категории конфигураций. Включает параметр CategoryId

Network_Browser123

iconPath

Нет

string

Путь/ссылка на изображение иконки относительно сервиса хранения мультимедиа-контента. Включает параметр ConfigurationIconPath

icons/123321-7cb06ef0-87ab-4a60-b20e-33c2d9725a09-open-office.png

imagesPaths

Нет

string

Список путей/ссылок на прикрепленные к ПО изображения относительно сервиса хранения мультимедиа-контента. Включает параметр ConfigurationImagesPaths

images/123321-7cb06ef0-87ab-4a60-b20e-33c2d9725a09-open-office-screen03.jpg]

ConfigurationsFilterRequest

Список фильтров для конфигураций.

Имя поля Обязательное Тип Описание Пример

displayName

Нет

string

Имя, которое отображается в пользовательском интерфейсе (макс. длина: 255). Включает параметр ConfigurationDisplayName

Яндекс браузер

description

Нет

string

Описание формулы. Включает параметр Description

Formula to install web browser developed by Yandex.

category

Нет

string

Идентификатор категории конфигураций (макс. длина: 64). Шаблон: [A-Za-z0-9_\-]+

Network_Browser123

tag

Нет

string

Тэг конфигурации для классификации и быстрого поиска (макс. длина: 255). Включает параметр Tag

Сертификаты банка

isApplication

Нет

Флаг, который указывает, является ли конфигурация приложением для отображения в магазине ПО. Включает параметр IsApplication

createdAtStartDate

Нет

string

Дата создания, начало интервала, включительно

2023-08-27T09:37:40.000Z

createdAtEndDate

Нет

string

Дата создания, конец интервала, включительно

2023-08-27T09:37:40.000Z

createdBy

Нет

string

Автор создания. Включает параметр CreatedBy

vivanov@domain.local

updatedBy

Нет

string

Автор последнего изменения. Включает параметр UpdatedBy

vivanov@domain.local

showOnlyActive

Нет

boolean

Флаг отображения неактивных версий конфигураций при выводе списка

true

ConfigurationId

Идентификатор конфигурации.

Макс. длина: 255.

Тип: integer(int64).

Пример: 5467.

ConfigurationListResponse

Список конфигураций.

Имя поля Обязательное Тип Описание Пример

configurations

Да

Список конфигураций. Включает параметры ConfigurationResponse

meta

Да

Метаданные постраничной навигации. Включает параметры meta

ConfigurationResponse

Перечень параметров конфигурации.

Имя поля Обязательное Тип Описание Пример

id

Да

integer(int64)

Идентификатор конфигурации (макс. длина: 255). Включает параметр ConfigurationId

5467

displayName

Да

string

Имя, которое отображается в пользовательском интерфейсе (макс. длина: 255). Включает параметр ConfigurationDisplayName

Яндекс браузер

description

Нет

string

Описание формулы. Включает параметр Description

Formula to install web browser developed by Yandex.

fullDescription

Нет

string

Подробное описание конфигурации. Включает параметр FullDescription

Браузер от компании Яндекс.(…​)

guide

Нет

string

Инструкция. Включает параметр Guide

Если вы не сделали его основным, при его запуске может появляться окно Сделать этот браузер основным? Чтобы окно больше не отображалось, включите опцию Больше не спрашивать и нажмите Не сейчас.

isApplication

Да

Флаг, который указывает, является ли конфигурация приложением для отображения в магазине ПО. Включает параметр IsApplication

tags

Нет

string

Тэг конфигурации для классификации и быстрого поиска (макс. длина: 255). Включает параметр Tag

Сертификаты банка

categories

Нет

категории конфигураций. Включает параметр CategoryId

createdAt

Нет

string

Дата создания

2023-08-27T09:37:40.000Z

updatedAt

Нет

string

Дата последнего изменения

2023-08-27T09:37:40.000Z

createdBy

Нет

string

Автор создания. Включает параметр CreatedBy

vivanov@domain.local

updatedBy

Нет

string

Автор последнего изменения. Включает параметр UpdatedBy

vivanov@domain.local

iconPath

Нет

Путь/ссылка на изображение иконки относительно сервиса хранения мультимедиа контента Включает параметры ConfigurationIconPath

imagesPaths

Нет

Список путей/ссылок на прикрепленные к ПО изображения относительно сервиса хранения мультимедиа-контента. Включает параметры ConfigurationImagesPaths

defaultVersion

Нет

integer(int64)

Идентификатор актуальной версии (версии по умолчанию) данного ПО (мин. значение: 1). Включает параметры DefaultVersion

isActive

Нет

boolean

Флаг активности версии конфигурации

true

ConfigurationUpdateRequest

Параметры для обновления конфигурации.

Имя поля Обязательное Тип Описание Пример

displayName

Да

string

Имя, которое отображается в пользовательском интерфейсе (макс. длина: 255). Включает параметр ConfigurationDisplayName

Яндекс браузер

description

Нет

string

Описание формулы. Включает параметр Description

Formula to install web browser developed by Yandex.

fullDescription

Нет

string

Подробное описание конфигурации. Включает параметр FullDescription

Браузер от компании Яндекс.(…​)

guide

Нет

string

Инструкция. Включает параметр Guide

Если вы не сделали его основным, при его запуске может появляться окно Сделать этот браузер основным? Чтобы окно больше не отображалось, включите опцию Больше не спрашивать и нажмите Не сейчас.

isApplication

Да

Флаг, который указывает, является ли конфигурация приложением для отображения в магазине ПО. Включает параметр IsApplication

tags

Нет

string

Тэг конфигурации для классификации и быстрого поиска (макс. длина: 255). Включает параметр Tag

Сертификаты банка

categories

Да

категории конфигураций. Включает параметр CategoryId

iconPath

Нет

Путь/ссылка на изображение иконки относительно сервиса хранения мультимедиа контента Включает параметры ConfigurationIconPath

imagesPaths

Нет

Список путей/ссылок на прикрепленные к ПО изображения относительно сервиса хранения мультимедиа-контента. Включает параметры ConfigurationImagesPaths

defaultVersion

Нет

integer(int64)

Идентификатор актуальной версии (версии по умолчанию) данного ПО (мин. значение: 1). Включает параметры DefaultVersion

Tag

Тэг конфигурации для классификации и быстрого поиска (макс. длина: 255).

Тип: string.

Пример: Сертификаты банка.

TagsListResponse

Список тегов конфигураций.

Имя поля Обязательное Тип Описание Пример

tags

Нет

string

Тэг конфигурации для классификации и быстрого поиска (макс. длина: 255). Включает параметр Tag

Сертификаты банка

meta

Да

Категории конфигураций. Включает параметры PaginationMetadata

UpdatedBy

Автор последнего изменения.

Тип: string.

Пример: vivanov@domain.local.

UpdatedDate

Дата последнего изменения.

Тип: string.

Пример: 2023-08-27T09:37:40.000Z.

UploadMultimediaResponse

Результат успешной загрузки файла.

Имя поля Обязательное Тип Описание Пример

fileUrl

Да

string

Относительный URL для загрузки файла (макс. длина: 255). Включает параметр FileUrl

images/open_office_aa-bb-00-11-ee.jpg

fileSize

Да

integer(int32)

Размер загруженного файла в байтах. Включает параметр FileSize

512000