⌂ > 🛠 Конфигурационный REST API > ⇄ Путь
PUT /configure/channels/{channel-id}/shelffullness : Изменение настроек модуля Наполненность полок🔗
Примечание
Доступно в версии Macroscop 4.6 и выше.
Предупреждение
Доступно только в лицензиях Enterprise и ULTRA.
Данный запрос может выполняться только пользователем с максимальными правами, то есть входящим в группу Старшие администраторы.
Важно
Во всех примерах указан локальный хост (localhost). При отправке реальных запросов замените его на адрес и порт сервера, на который отправляете запрос.
Параметры🔗
Параметр |
Описание |
Версия |
|---|---|---|
Enabled |
Включён ли модуль. Допустимые значения: true — включён, false — выключен |
bool |
ChannelSettings |
Настройки модуля Наполненность полок специфичные для конкретной камеры |
class |
.Shelves |
Массив полок. Добавление и первоначальная конфигурация должны осуществляться в конфигураторе. REST API позволяет только конфигурировать некоторые параметры уже добавленных зон и удалять зоны (если зоны с соответствующем id не представлены в теле PUT-запроса, они будут удалены) |
class[] |
Примечание
Некоторые параметры необязательны для отправки PUT-запроса. Если для параметра не указано значение по умолчанию, он является обязательным. При отсутствии изменений система сохраняет текущее значение параметров.
Описание параметра ChannelSettings.Shelves[i]:
Параметр |
Описание |
Версия |
|---|---|---|
Id |
Идентификатор зоны, по которому можно конфигурировать остальные её параметры. Строка, содержащая идентификатор в формате GUID |
GUID |
Name |
Название зоны. Непустая строка |
string |
FullnessThreshold |
Пороговое значение наполненности полки в процентах для генерации события. Допустимые значения: "Threshold20" - 20%; "Threshold40" - 40%; "Threshold60" - 60%; "Threshold80" - 80%. |
enum |
CheckInterval |
Интервал между проверками наполненности полки. Допустимые значения: "CheckInterval5Sec" - 5 секунд; "CheckInterval10Sec" - 10 секунд; "CheckInterval15Sec" - 15 секунд; "CheckInterval30Sec" - 30 секунд; "CheckInterval60Sec" - 60 секунд. |
enum |
Пример запроса🔗
PUT http://localhost:8080/configure/channels/81060b4d-7f0c-47af-8ec1-124dc79fd750/shelffullness