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

GET /command?type=generateexternalevent : Генерация события из внешней системы🔗

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

Предупреждение

Доступно в Macroscop версии 2.1 и выше.

Важно

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

Примечание

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

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

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

Для создания в журнале системы события с типом Событие из внешней системы используется тип запроса generateexternalevent.

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

GET http://localhost:8080/command?type=generateexternalevent&login=root&password=&channelid=20d9884f-ae8c-45d3-ac5a-505ec258f01b&systemname=TestSystem&information=record&eventcode=5

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

Параметр

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

Описание

channelid

—

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

systemname

—

Название внешней системы

information

—

Строка с информацией о событии

eventcode

—

Числовой код события

Примечание

Данный запрос предназначен преимущественно для реализации базовой интеграции с любой сторонней системой, не поддерживаемой Macroscop, включая собственные разработки. Значения параметров systemname, information и eventcode могут быть любыми.

Примеры отображения событий в клиентских приложениях🔗

В журнале событий приложения Macroscop Клиент данное событие будет выглядеть следующим образом:

../../../_images/event-in-client.png

Также на эти события можно назначать действия в сценариях (посредством приложения Macroscop Конфигуратор):

../../../_images/set-event-in-configurator.png ../../../_images/event-settings-in-configurator.png

Связанные ссылки