На странице:

Получение списка макрокоманд

GET http://IP-адрес:порт/префикс/macro/list/

ПараметрОбязательныйОписание
exclude_autoНет

Получение списка макрокоманд без автоматических правил (см. Автоматические правила)

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

GET http://127.0.0.1:80/macro/list/?exclude_auto

Пример ответа:

{
	"macroCommands" : 
	[
		{
			"id" : "4fd9420e-0d22-4684-9f0a-3514240cc1ac",
			"name" : "Name 2"
		},
		{
			"id" : "0d1e05e6-8b4b-4be7-bc44-fcdf2cde4135",
			"name" : "Name 1"
		}
	]
}
ПараметрОписание
idОтображает ID макрокоманды
nameОтображает имя макрокоманды

Пример запроса с получением списка макрокоманд с автоматическими правилами:

GET http://127.0.0.1/v1/logic_service/macros

Пример ответа:

[
    {
        "guid": "0667120b-46af-407b-ae79-4603c119652e",
        "name": "19.0.Камера: 1.Детектор движения",
        "mode": {
            "enabled": true,
            "user_role": "",
            "is_add_to_menu": false,
            "autorule": {
                "zone_ap": "hosts/Server1/DeviceIpint.19/SourceEndpoint.video:0:0",
                "only_if_armed": false,
                "timezone_id": "00000000-0000-0000-0000-000000000000"
            }
        },
        "conditions": {},
        "rules": {}
    },
    {
        "guid": "4fd9420e-0d22-4684-9f0a-3514240cc1ac",
        "name": "Макрокоманда1",
        "mode": {
            "enabled": true,
            "user_role": "",
            "is_add_to_menu": false,
            "common": {}
        },
        "conditions": {},
        "rules": {}
    },
    {
        "guid": "0d1e05e6-8b4b-4be7-bc44-fcdf2cde4135",
        "name": "Макрокоманда2",
        "mode": {
            "enabled": true,
            "user_role": "",
            "is_add_to_menu": false,
            "continuous": {
                "server": "Server1",
                "timezone_id": "00000000-0000-0000-0000-000000000000",
                "heartbeat_ms": 30000,
                "random": true
            }
        },
        "conditions": {},
        "rules": {}
    }
]
ПараметрОписание
modeСодержит общую информацию о макрокоманде
is_add_to_menu

Содержит информацию о том, добавлена ли макрокоманда в меню:

  • true – добавлена;
  • false – не добавлена

Выполнение макрокоманды 

GET http://IP-адрес:порт/префикс/macro/execute/{id}

id – идентификатор из списка макрокоманд.

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

GET http://127.0.0.1:80/macro/execute/941f88d1-b512-4189-84a6-7d274892dd95

Возможные коды ошибок при выполнении команд:

Код ошибкиОписание
400Неправильно сформированный запрос
500Внутренняя ошибка Сервера
404Некорректно сформированный идентификатор (только для команды execute)
  • No labels

Предыдущая страница Экспорт  Переключение состояния виртуального датчика (HttpListener) Следующая страница