event/alarm management

Events/AlarmList

Request the list of active alarms.

Request

• Filter - string - the filter expression; optional, default is no filter, Event Filter Syntax for OPC UA Interface
• Sort - string - the property to sort the alarms; optional, default is "Time"
• SortDescending - boolean - true to sort in descending (reverse) order; optional, default false
• StartOffset - integer - the number of the first entry to return; optional, default is 0
• StartTime - string - the timestamp of the first entry to return; optional, StartOffset is used if not given
• MaxResults - integer - maximum number of results to return
• Properties - array of string - list of properties to return; Path elements are separated by .; the last path element may be an attribute name prefixed by @

Response

• Results - array of object - the results of the operation; values are the requested properties
• MaxResults - integer - the number of results currently present in the server

Example

in:
{
 "function": "Events/AlarmList",
 "id": "some-text-or-number",
 "data": {
  "Filter": "GreaterThan(Attribute(Severity), Literal(UInt16, 100))",
  "Sort": "Severity",
  "SortDescending": false,
  "StartOffset": 0,
  "StartTime": "2023-11-29 00:00:00",
  "MaxResults": 50,
  "Properties": [
   "@NodeId", "EventId", "Time", "Message", "Severity", ...
  ]
 }
}
out:
{
 "function": "Events/AlarmList",
 "id": "some-text-or-number",
 "status": 0,
 "data": {
  "Results": [
   {
    "@NodeId": "ns=1;s=...",
    "EventId": {42, 7, 19, ...}
    "Time": "2023-11-29 00:00:00",
    "Message": "Something happened",
    "Severity": 500,
    ...
   }
  ],
  "MaxResults": 523
 }
}

Events/EventList

Request the list of recently received events.

Request

• Filter - string - the filter expression; optional, default is no filter, Event Filter Syntax for OPC UA Interface
• Sort - string - the property to sort the alarms; optional, default is "Time"
• SortDescending - boolean - true to sort in descending (reverse) order; optional, default false
• StartOffset - integer - the number of the first entry to return; optional, default is 0
• StartTime - string - the timestamp of the first entry to return; optional, StartOffset is used if not given
• MaxResults - integer - maximum number of results to return
• Properties - array of string - list of properties to return; Path elements are separated by .; the last path element may be an attribute name prefixed by @

Response

• Results - array of object - the results of the operation; values are the requested properties
• MaxResults - integer - the number of results currently present in the server

Example

in:
{
 "function": "Events/EventList",
 "id": "some-text-or-number",
 "data": {
  "Filter": "GreaterThan(Attribute(Severity), Literal(UInt16, 100))",
  "Sort": "Severity",
  "SortDescending": false,
  "StartOffset": 0,
  "StartTime": "2023-11-29 00:00:00",
  "MaxResults": 50,
  "Properties": [
   "EventId", "Time", "Message", "Severity", ...
  ]
 }
}
out:
{
 "function": "Events/EventList",
 "id": "some-text-or-number",
 "status": 0,
 "data": {
  "Results": [
   {
    "EventId": {42, 7, 19, ...}
    "Time": "2023-11-29 00:00:00",
    "Message": "Something happened",
    "Severity": 500,
    ...
   }
  ],
  "MaxResults": 523
 }
}

Events/AlarmAck

Acknowledges an alarm.

Request

• ConditionId - string - the Node ID of the condition that should be acknowledged; request it by including "@NodeId" in the Properties list of Events/Alarms
• EventId - array of integer - the Event ID of the condition that should be acknowledged; request it by including "EventId" in the Properties list of Events/Alarms
• Comment - string - a comment to send along with the acknowledge command; optional

Response

empty

Example

in:
{
 "function": "Events/AlarmAck",
 "id": "some-text-or-number",
 "data": {
  "ConditionId": "...",
  "EventId": {42, 7, 19, ...},
  "Comment": ""
 }
}
out:
{
 "function": "Events/AlarmAck",
 "id": "some-text-or-number",
 "status": 0,
 "data": {}
}

Events/AlarmConfirm

Confirms an alarm.

Request

• ConditionId - string - the Node ID of the condition that should be confirmed; request it by including "@NodeId" in the Properties list of Events/Alarms
• EventId - array of integer - the Event ID of the condition that should be confirmed; request it by including "EventId" in the Properties list of Events/Alarms
• Comment - string - a comment to send along with the confirm command; optional

Response

empty

Example

in:
{
 "function": "Events/AlarmConfirm",
 "id": "some-text-or-number",
 "data": {
  "EventId": {42, 7, 19, ...},
  "Comment": ""
 }
}
out:
{
 "function": "Events/AlarmConfirm",
 "id": "some-text-or-number",
 "status": 0,
 "data": {}
}

Events/AddComment

Adds a comment to a condition event.

Request

• ConditionId - string - the Node ID of the condition that the comment should be added to; request it by including "@NodeId" in the Properties list of Events/Alarms
• EventId - array of integer - the Event ID of the condition that the comment should be added to; request it by including "EventId" in the Properties list of Events/Alarms
• Comment - string - the comment to set

Response

empty

Example

in:
{
 "function": "Events/AddComment",
 "id": "some-text-or-number",
 "data": {
  "EventId": {42, 7, 19, ...},
  "Comment": ""
 }
}
out:
{
 "function": "Events/AddComment",
 "id": "some-text-or-number",
 "status": 0,
 "data": {}
}

Events/CreateAlarmCount

Create a handle to be notified when the number of active alarms changes.

Request

• Filter - string - the filter expression; optional, default is no filter, Event Filter Syntax for OPC UA Interface
• ClientHandle - integer - client-side handle, used for routing answers and events

Response

• ClientHandle - integer - client-side handle from request
• ServerHandle - integer - server-side handle

Event

After creating the handle, "AlarmCountChanged" events arrive to notify of changes to the number of active alarms.

• ClientHandle - integer - client-side handle from request
• AlarmCount - integer - number of active alarms that match the filter

Example

in:
{
 "function": "Events/CreateAlarmCount",
 "id": "some-text-or-number",
 "data": {
  "Filter": "GreaterThan(Attribute(Severity), Literal(UInt16, 100))",
  "ClientHandle": 42
 }
}
out:
{
 "function": "Events/CreateAlarmCount",
 "id": "some-text-or-number",
 "status": 0,
 "data": {
  "ClientHandle": 42
 }
}
event:
{
 "event": "AlarmCountChanged",
 "data": {
  "ClientHandle": 42,
  "AlarmCount": 2
 }
}

Events/DeleteAlarmCount

Delete an active alarm handle created by Events/CreateAlarmCount.

Request

• ServerHandle - integer - server-side handle as returned by CreateAlarmCount

Response

No data.

Example

in:
{
 "function": "Events/DeleteAlarmCount",
 "id": "some-text-or-number",
 "data": {
  "ServerHandle": 42
 }
}
out:
{
 "function": "Events/DeleteAlarmCount",
 "id": "some-text-or-number",
 "status": 0,
 "data": {}
}

Events/BrowseTypes

Browse event types.

Request

• Path - string - the root path for the browse operation; empty or missing for root list; usually, all events are under "Types.EventTypes"
• StartOffset - integer - the start offset of the browse operation; missing value is treated as 0
• MaxResults - integer - maximum number of results; missing value uses a default value

Response

• Results - array of object - results
  • Name - string - the item name; to use it, prepend the requested path and a '.' character
  • Comment - string - optional; the item comment
  • NodeId - string - the Node ID of the type
• Blocked - boolean - true if more results exist (and can be requested with a higher StartOffset)

Example

in:
{
 "function": "Events/BrowseTypes",
 "id": "some-text-or-number",
 "data": {
  "Path": "...",
  "StartOffset": 0,
  "MaxResults": 50
 }
}
out:
{
 "function": "Events/BrowseTypes",
 "id": "some-text-or-number",
 "status": 0,
 "data": {
  "Results": [
   { "Name": "abc", "NodeId": "ns=1;s=..." }, ...
  ],
  "Blocked": false
 }
}

Events/BrowseProperties

Browse event properties.

Request

• Path - string - the path of the event type to fetch the properties for
• Recursive - boolean - true to include all properties from the parent types; optional, default false
• StartOffset - integer - the start offset of the browse operation; missing value is treated as 0
• MaxResults - integer - maximum number of results; missing value uses a default value

Response

• Results - array of object - results
  • Name - string - the item name; to use it, prepend the requested path and a '.' character
  • Comment - string - optional; the item comment
  • NodeId - string - the Node ID of the property
  • Mandatory - boolean - optional; true if the property is mandatory; default false = optional
• Blocked - boolean - true if more results exist (and can be requested with a higher StartOffset)

Example

in:
{
 "function": "Events/BrowseProperties",
 "id": "some-text-or-number",
 "data": {
  "Path": "...",
  "Recursive": true,
  "StartOffset": 0,
  "MaxResults": 50
 }
}
out:
{
 "function": "Events/BrowseProperties",
 "id": "some-text-or-number",
 "status": 0,
 "data": {
  "Results": [
   { "Name": "abc" }, ...
  ],
  "Blocked": false
 }
}

Events/ReadHistoryEvent

Reads historical events.

Request

• NotifierName - string - the notifier name (= browse path)
• StartTime - string - the ISO8601 timestamp of the first value to return
• EndTime - string - the ISO8601 timestamp of the last value to return
• ValueCount - integer - the number of values to return
• Properties - array of string - the list of event properties to retuen
• Filter - string - the filter expression; optional, default is no filter, Event Filter Syntax for OPC UA Interface

Notes:

• At least 2 of StartTime, EndTime, ValueCount must be given
• If StartTime > EndTime or StartTime is missing, values are returned in reverse order

Response

• Quality - integer - read quality, see Quality values, conforming to OPC
• Blocked - boolean - true if more values exist but could not be returned because of memory limits or ValueCount
• Events - array of object - the returned events; values are the requested properties

Example

in:
{
 "function": "Events/ReadHistoryEvent",
 "id": "some-text-or-number",
 "data": {
  "NotifierName": "...",
  "StartTime": "2020-01-01T00:00:00Z",
  "EndTime": "2020-02-01T00:00:00Z",
  "Properties": [
   "Message", "Severity", ...
  ],
  "Filter": "GreaterThan(Attribute(Severity), Literal(UInt16, 100))"
 }
}
out:
{
 "function": "Events/ReadHistoryEvent",
 "id": "some-text-or-number",
 "status": 0,
 "data": {
  "Events": [
   {
    "Message": "Something happened",
    "Severity": 150
   },...
  ]
 }
}

Events/SetDefaultEventProperties

Sets the list of event properties requested by default.

Request

• Properties - array of string - properties list

Response

Empty.

Example

in:
{
 "function": "Events/SetDefaultEventProperties",
 "id": "some-text-or-number",
 "data": {
  "Properties": [
   "Message", "Severity",...
  ]
 }
}
out:
{
 "function": "Events/SetDefaultEventProperties",
 "id": "some-text-or-number",
 "status": 0,
 "data": {
 }
}

Events/GetDefaultEventProperties

Gets the list of event properties requested by default.

Request

Empty.

Response

• Properties - array of string - properties list

Example

in:
{
 "function": "Events/GetDefaultEventProperties",
 "id": "some-text-or-number",
 "data": {
 }
}
out:
{
 "function": "Events/GetDefaultEventProperties",
 "id": "some-text-or-number",
 "status": 0,
 "data": {
  "Properties": [
   "Message", "Severity",...
  ]
 }
}