Запрос событий с применением фильтров
запрос: /entek/api/events_filtered
Запрос для получения событий по фильтрам, которые передаются в теле запроса в формате JSON. Тело запроса может содержать следующие параметры:
|
параметр
|
назначение
|
приоритет
|
|
db_guids
|
guid БД, из которой будут запрашиваться события
|
при отсутствии параметра или указании неверного guid данные берутся из БД назначенной по умолчанию
|
|
groups
|
массив с названиями групп событий
|
обязательно задать
|
|
station_id
|
номер станции
|
необязательный параметр
|
|
controllers
|
массив целочисленных идентификаторов контроллеров
|
необязательный параметр
|
|
time_begin
|
время начала запрашиваемого интервала
|
при отсутствии интервала задать last_evt_count
|
|
time_end
|
время окончания запрашиваемого интервала
|
при отсутствии интервала задать last_evt_count
|
|
last_evt_count
|
количество последних событий
|
необязательный параметр
|
|
sort_mode_asc
|
логический параметр использования сортировки
|
необязательный параметр
|
|
actual_alarms
|
логический параметр передачи актуальных алармов
|
необязательный параметр
|
|
filters
|
массив идентификаторов пользовательских фильтров из БД параметров
|
необязательный параметр
|
|
columns
|
список названий стандартных полей, которые должны содержаться в ответе
|
При отсутствии параметра предаются все допустимые параметры
|
|
attr_columns
|
идентификаторы аттрибутов из БД параметров
|
необязательный параметр
|
|
evt_types
|
массив целочисленных идентификаторов типов событий
|
необязательный параметр
|
Допустимые значения для параметра columns и их соответствие полям БД:
|
group_name -> from GROUP_ID JOIN GROUP_LIST.GROUP_NAME
client_id -> CLIENT_ID
event_time -> EVENT_DATE_UTC + EVENT_TIME_UTC
event_text -> EVENT_TEXT
event_number -> NUMBER
event_type -> EVENT_TYPE
comment -> COMMNENTS
user -> USER_NAME
station_id -> STATIONID
group_id -> GROUPID
passp_type -> PASSPTYPE
passp_id -> PASSPID
passp_time -> PASSPTIME
passp_val -> ALARM_VAL
alarm_priority -> ALARM_PRIORITY
alarm_ack -> ALARM_ACK
alarm_ack_user -> ALARM_ACK_USER
alarm_ack_time -> ALARM_ACK_TIME
alarm_end_time -> ALARM_END_TIME
alarm_set_val -> ALARM_SETTINGS_VALUE
passp_cipher -> DB Params или из xml конфигурации
passp_name -> DB Params или из xml конфигурации
object_name -> DB Params или из xml конфигурации
|
Ответ содержит параметр events, в котором передается массив с событиями. Также может содержаться параметр params, в котором передается массив с описанием параметров, заданными полями passp_cipher, passp_name, object_name и значения переданных атрибутов, название переменных атрибутов имеет форму "attr_<идентификатор атрибута>".
Примеры тела запроса:
|
{
"db_guids": ["1111"],
"groups": ["ALARMSMEDIUMHIGH", "DASERVERGROUP"],
"station_id": 0,
"controllers": [0],
"time_begin": "2023-12-29T00:00:00.000Z",
"time_end": "2023-12-29T17:00:00.000Z"
}
|
|
{
"db_guids": ["1111"],
"groups": ["ALARMSMEDIUMHIGH", "DASERVERGROUP"],
"station_id": 0,
"controllers": [0],
"last_evt_count": 10,
"columns": ["group_name", "event_time", "event_text"]
}
|
Пример ответов:
|
{
"events": [
{
"group_name": "DASERVERGROUP",
"client_id": "127.0.1.1",
"event_time": "2024-01-09T06:01:32",
"event_text": "StopMessagesAntraks",
"event_number": "701",
"event_type": "0",
"station_id": "0",
"passp_type": "222",
"group_id": "0",
"passp_id": "0"
},
{
"group_name": "DASERVERGROUP",
"client_id": "127.0.1.1",
"event_time": "2024-01-09T06:01:32",
"event_text": "RTP - SUCCESSFULLY call STOPPROCESS",
"event_number": "696",
"event_type": "0",
"station_id": "0",
"passp_type": "222",
"group_id": "0",
"passp_id": "0"
}
]
}
|
|
{
"events": [
{
"event_time": "2023-12-29T11:50:58",
"event_text": "Переключение аларм выше среднего - Отключено",
"passp_time": "2023-12-29T11:50:58"
},
{
"event_time": "2023-12-29T11:50:50",
"event_text": "Переключение аларм выше среднего - Включено",
"passp_time": "2023-12-29T11:50:50"
}
],
"params": [
{
"station_id": 0,
"group_id": 0,
"passp_id": 4,
"passp_type": 2,
"passp_cipher": "ТС аларм выше среднего",
"object_name": "Генератор демо-данных",
"passp_name": "Генератор демо-данных.Задача 1.Для тестирования алармов.ТС аларм выше среднего",
"attr_1": "Тестовое значение"
}
]
}
|