⌂ > ⎘ Открытый REST API

GET /command?type=setcell : Установка канала в ячейку сетки🔗

Доступно во всех типах лицензий.

Важно

Во всех примерах указан локальный хост (localhost). При отправке реальных запросов замените его на адрес и порт сервера, на который отправляете запрос.

Примечание

HTTP-интерфейс Macroscop позволяет не только получать сведения о системе, но и управлять некоторыми её элементами, выполняя описанные ниже CGI-запросы.

Такие запросы, за одним исключением, имеют следующий формат:

{Протокол}://{Сервер}:{Порт}/command?type={Тип}&login={Логин}&password={Пароль}&{Параметр}={Значение параметра}

Для размещения нового канала в ячейке сетки камер действующего профиля экрана используется тип запроса setcell.

Примечание

Запрос позволяет изменять сетки только для тех профилей экранов, которые были созданы непосредственно на клиентском устройстве. Изменение серверных профилей не поддерживается.

Примечание

Любые изменения сетки сохраняются автоматически в рамках действующего профиля экрана. Новый профиль при этом не создаётся.

Пример запроса🔗

GET http://localhost:8080/command?type=setcell&login=root&password=&clientip=192.168.1.2&monitor=0&cell=4&channelid=20d9884f-ae8c-45d3-ac5a-505ec258f01b&mode=archive&starttime=14.09.2023+10:10:00&speed=2

Дополнительные параметры запроса🔗

Параметр

Значение по умолчанию

Описание

clientip

—

IP адрес устройства, на котором запущено клиентское приложение Macroscop. Обязательный параметр

monitor

—

Номер монитора в действующей конфигурации клиентского приложения. Отсчёт начинается с 0. Обязательный параметр

cell

—

Номер ячейки. Отсчёт начинается с 0. Обязательный параметр

channelid

—

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

mode

realtime

Режим воспроизведения канала в ячейке. Возможные значения: realtime – воспроизведение потока реального времени, archive – воспроизведение архива

starttime

Момент получения запроса

Начальная точка воспроизведения архива. Применяется только при mode=archive

speed

1

Скорость воспроизведения архива. Применяется только при mode=archive. Возможные значения: 0,1; 0,2; 0,5; 1; 2; 5; 10; 20; 60; 120

Примечание

Значение clientip должно содержать фактический адрес клиента Macroscop. Использование localhost (127.0.0.1) вызовет ошибку даже при обращении к клиенту, установленному непосредственно на сервере.

Примечание

Параметр starttime поддерживает несколько форматов записи даты и времени:

  • Дата может записываться как с полным обозначением года («YYYY или 2023»), так и с сокращённым («YY» или «23»).

  • Для разделения числа, месяца и года в дате можно использовать как точку («.»), так и дефис («-»).

  • Допускается написание даты, начиная как с числа («DD.MM.YYYY» или «14.06.2023»), так и с года («YYYY.MM.DD» или «2023.06.14»).

  • Разделение даты и времени может осуществляться как пробелом (« ») или его кодом («%20»), так и плюсом («+»).