Список доступных действий с объектом, находящимся в определённом состоянии

Список действий запрашивается не по классу объекта, а берётся из контекста конкретного объекта, т.к. возможны различные права пользователя на объекты одного и того же класса. Работа с полученным списком описана в разделе Отсылка команд на сервер.

Общий формат запроса:

GET http://IP-адрес:порт/web2/secure/configuration/{objectClass}:{id}/state/actions/

Параметры запроса:

Параметр	Обязательный	Описание
objectClass	Да	Название класса объектов
id	Да	Идентификатор объекта

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

GET http://127.0.0.1:8085/web2/secure/configuration/GRAY:2/state/actions/

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

XML

<actions>
    <action>
        <description>Disarm</description>
        <hidden>false</hidden>
        <id>DISARM</id>
    </action>
    <action>
        <description>Arm</description>
        <hidden>false</hidden>
        <id>ARM</id>
    </action>
    <action>
        <description>Classify alarm</description>
        <hidden>false</hidden>
        <id>CONFIRM</id>
    </action>
</actions>

Если состояние объекта не предусматривает никаких действий, то xml будет таким:

<actions/>

JSON

[
    {
        "id": "DISARM",
        "description": "Disarm",
        "hidden": false,
        "react": {
            "sourceType": "MACRO",
            "sourceId": "DISARM",
            "action": "RUN",
            "params": {},
            "name": "React",
            "version": 1
        }
    },
    {
        "id": "ARM",
        "description": "Arm",
        "hidden": false,
        "react": {
            "sourceType": "MACRO",
            "sourceId": "ARM",
            "action": "RUN",
            "params": {},
            "name": "React",
            "version": 1
        }
    },
    {
        "id": "CONFIRM",
        "description": "Classify alarm",
        "hidden": false,
        "react": {
            "sourceType": "MACRO",
            "sourceId": "CONFIRM",
            "action": "RUN",
            "params": {},
            "name": "React",
            "version": 1
        }
    }
]

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

Параметр	Описание
description	Текстовое описание реакции
hidden	true – реакция не отображается в интерфейсе (на карте, в макрокомандах и т.д.) false – реакция отображается в интерфейсе
id	Системное название реакции
Блок "react" в ответе JSON
sourceType	Тип объекта, который может запустить действие.
sourceId	Системное название реакции
action	Действие над объектом sourceType
params	Доступные параметры реакции
name	Тип действия: Event или React
version	Версия

Page tree

Документация для версии Интеллект 4.13. Документация на другие версии также доступна.