References

Notification Action Data To

type

object

properties

  • ackRequired

The ack required flag indicates whether an acknowledgment is required for the notification.

type

boolean

  • acknowledgeData

The acknowledge data contains information required to acknowledge the notification, if acknowledgment is needed.

oneOf

#/definitions/LightAcknowledgeDataTo

#/definitions/CompleteAcknowledgeDataTo

  • eventObjectIdentifier

The event object identifier of the notification is used to identify the object that generated the notification.

#/definitions/EventObjectIdentifier

  • eventType

The event type of the notification indicates the nature of the event that triggered the notification.

type

string

  • eventValues

The event values of the notification provide additional data related to the event that triggered the notification.

type

string

  • fetchedMapData

The fetched map data contains a map of additional properties that were fetched in relation to the notification.

type

object

additionalProperties

  • fromState

The from state of the notification indicates the previous state of the event before the notification was generated.

type

string

  • initiatingDeviceIdentifier

The initiating device identifier of the notification is used to identify the device that received the notification.

#/definitions/EventObjectIdentifier

  • messageText

The message text of the notification provides additional information about the event that triggered the notification.

type

string

  • notificationClass

The notification class of the notification is used to define the instance of the notification.

type

integer

  • notifyType

The notify type of the notification indicates the method of notification delivery.

type

string

  • priority

The priority of the notification indicates the urgency or importance of the notification.

type

integer

  • processIdentifier

The process identifier of the notification is used to uniquely identify a notification in the recipient list of a notification class. It allows the system to route the notification to the appropriate process or application instance within the BACnet network.

type

integer

  • timestamp

The timestamp as text when the notification was generated on the remote device.

oneOf

#/definitions/TimestampTime

#/definitions/TimestampSequenceNumber

#/definitions/TimestampDateTime

  • timestampReceivedMs

The timestamp as milliseconds when the notification was received on OnSphere.

type

integer

  • toState

The to state of the notification indicates the current state of the event after the notification was generated.

type

string

additionalProperties

False

definitions

  • LightAcknowledgeDataTo

LIGHT

type

object

properties

  • type

type

string

enum

LIGHT

default

LIGHT

  • eventObjectIdentifier

Identifier of the BACnet object associated with the event or alarm being acknowledged. This typically refers to the object that triggered the notification. Internal fields: - instance (int): BACnet object instance number. - type (int): BACnet object type numeric code. - typeString (String): Human-readable object type name.

#/definitions/EventObjectIdentifier

  • eventStateAcknowledged

Event state being acknowledged. Corresponds to the BACnet EventState enumeration. Typical values: - 0: normal - 1: offnormal - 2: fault

type

integer

  • initiatingDeviceIdentifier

Identifier of the BACnet device that initiates the acknowledgement. This field represents a BACnet Device object (ObjectType = DEVICE, instance = deviceIdentifier). Internal fields: - instance (int): BACnet device instance number. - type (int): BACnet object type numeric code (DEVICE = 8). - typeString (String): Human-readable object type (“DEVICE”).

#/definitions/EventObjectIdentifier

  • processIdentifier

Identifier of the process performing the acknowledgement. This value is used by BACnet devices to track which process acknowledged the event.

type

integer

additionalProperties

False

  • EventObjectIdentifier

type

object

properties

  • instance

type

integer

  • type

type

integer

  • typeString

type

string

additionalProperties

False

  • CompleteAcknowledgeDataTo

COMPLETE

type

object

properties

  • type

type

string

enum

COMPLETE

default

COMPLETE

  • eventObjectIdentifier

Identifier of the BACnet object associated with the event or alarm being acknowledged. This typically refers to the object that triggered the notification. Internal fields: - instance (int): BACnet object instance number. - type (int): BACnet object type numeric code. - typeString (String): Human-readable object type name.

#/definitions/EventObjectIdentifier

  • eventStateAcknowledged

Event state being acknowledged. Corresponds to the BACnet EventState enumeration. Typical values: - 0: normal - 1: offnormal - 2: fault

type

integer

  • initiatingDeviceIdentifier

Identifier of the BACnet device that initiates the acknowledgement. This field represents a BACnet Device object (ObjectType = DEVICE, instance = deviceIdentifier). Internal fields: - instance (int): BACnet device instance number. - type (int): BACnet object type numeric code (DEVICE = 8). - typeString (String): Human-readable object type (“DEVICE”).

#/definitions/EventObjectIdentifier

  • processIdentifier

Identifier of the process performing the acknowledgement. This value is used by BACnet devices to track which process acknowledged the event.

type

integer

  • timestamp

Timestamp indicating when the notification was made. This can be represented in various formats, such as time, date-time, or sequence number.

oneOf

#/definitions/TimestampTime

#/definitions/TimestampSequenceNumber

#/definitions/TimestampDateTime

  • timestampMs

Timestamp in milliseconds since epoch (January 1, 1970) when the notification was received. This provides a precise time reference for the acknowledgement event.

type

integer

additionalProperties

False

  • TimestampTime

TIME

type

object

properties

  • type

type

string

enum

TIME

default

TIME

  • hour

type

integer

  • hundredth

type

integer

  • minute

type

integer

  • second

type

integer

additionalProperties

False

  • TimestampSequenceNumber

SEQUENCE_NUMBER

type

object

properties

  • type

type

string

enum

SEQUENCE_NUMBER

default

SEQUENCE_NUMBER

  • value

type

integer

additionalProperties

False

  • TimestampDateTime

DATETIME

type

object

properties

  • type

type

string

enum

DATETIME

default

DATETIME

  • day

type

integer

  • dayOfWeek

type

integer

  • hour

type

integer

  • hundredth

type

integer

  • minute

type

integer

  • month

type

integer

  • second

type

integer

  • year

type

integer

additionalProperties

False

Example of valid format
{
  "ackRequired" : true,
  "acknowledgeData" : {
    "type" : "COMPLETE",
    "eventObjectIdentifier" : {
      "instance" : 0,
      "type" : 2,
      "typeString" : "analog-value"
    },
    "eventStateAcknowledged" : 1,
    "initiatingDeviceIdentifier" : {
      "instance" : 123456,
      "type" : 8,
      "typeString" : "device"
    },
    "processIdentifier" : 301,
    "timestamp" : {
      "type" : "DATETIME",
      "day" : 13,
      "dayOfWeek" : 2,
      "hour" : 12,
      "hundredth" : 39,
      "minute" : 36,
      "month" : 1,
      "second" : 59,
      "year" : 126
    },
    "timestampMs" : 1767078998
  },
  "eventObjectIdentifier" : {
    "instance" : 0,
    "type" : 12,
    "typeString" : "analog-value"
  },
  "eventType" : "change-of-reliability",
  "eventValues" : "eventValues=NotificationParameters[choice=ChangeOfReliabilityNotif[reliability=over-range, statusFlags=StatusFlags [in-alarm=true, fault=true, overridden=false, out-of-service=false], propertyValues=[PropertyValue(propertyIdentifier=present-value, propertyArrayIndex=null, value=26.0, priority=null)]]]",
  "fetchedMapData" : {
    "17" : 1,
    "28" : "hello from bacnet",
    "353" : true
  },
  "fromState" : "normal",
  "initiatingDeviceIdentifier" : {
    "instance" : 123456,
    "type" : 12,
    "typeString" : "device"
  },
  "messageText" : "ToFault",
  "notificationClass" : 1,
  "notifyType" : "alarm",
  "priority" : 127,
  "processIdentifier" : 301,
  "timestamp" : {
    "type" : "DATETIME",
    "day" : 13,
    "dayOfWeek" : 2,
    "hour" : 12,
    "hundredth" : 39,
    "minute" : 36,
    "month" : 1,
    "second" : 59,
    "year" : 126
  },
  "timestampReceivedMs" : 1790584673973,
  "toState" : "fault"
}

Complete Acknowledge Data To

type

object

properties

  • type

type

string

enum

COMPLETE

default

COMPLETE

  • eventObjectIdentifier

Identifier of the BACnet object associated with the event or alarm being acknowledged. This typically refers to the object that triggered the notification. Internal fields: - instance (int): BACnet object instance number. - type (int): BACnet object type numeric code. - typeString (String): Human-readable object type name.

#/definitions/EventObjectIdentifier

  • eventStateAcknowledged

Event state being acknowledged. Corresponds to the BACnet EventState enumeration. Typical values: - 0: normal - 1: offnormal - 2: fault

type

integer

  • initiatingDeviceIdentifier

Identifier of the BACnet device that initiates the acknowledgement. This field represents a BACnet Device object (ObjectType = DEVICE, instance = deviceIdentifier). Internal fields: - instance (int): BACnet device instance number. - type (int): BACnet object type numeric code (DEVICE = 8). - typeString (String): Human-readable object type (“DEVICE”).

#/definitions/EventObjectIdentifier

  • processIdentifier

Identifier of the process performing the acknowledgement. This value is used by BACnet devices to track which process acknowledged the event.

type

integer

  • timestamp

Timestamp indicating when the notification was made. This can be represented in various formats, such as time, date-time, or sequence number.

oneOf

#/definitions/TimestampTime

#/definitions/TimestampSequenceNumber

#/definitions/TimestampDateTime

  • timestampMs

Timestamp in milliseconds since epoch (January 1, 1970) when the notification was received. This provides a precise time reference for the acknowledgement event.

type

integer

additionalProperties

False

definitions

  • EventObjectIdentifier

type

object

properties

  • instance

type

integer

  • type

type

integer

  • typeString

type

string

additionalProperties

False

  • TimestampTime

TIME

type

object

properties

  • type

type

string

enum

TIME

default

TIME

  • hour

type

integer

  • hundredth

type

integer

  • minute

type

integer

  • second

type

integer

additionalProperties

False

  • TimestampSequenceNumber

SEQUENCE_NUMBER

type

object

properties

  • type

type

string

enum

SEQUENCE_NUMBER

default

SEQUENCE_NUMBER

  • value

type

integer

additionalProperties

False

  • TimestampDateTime

DATETIME

type

object

properties

  • type

type

string

enum

DATETIME

default

DATETIME

  • day

type

integer

  • dayOfWeek

type

integer

  • hour

type

integer

  • hundredth

type

integer

  • minute

type

integer

  • month

type

integer

  • second

type

integer

  • year

type

integer

additionalProperties

False

Example of valid format
{
  "type" : "COMPLETE",
  "eventObjectIdentifier" : {
    "instance" : 0,
    "type" : 2,
    "typeString" : "analog-value"
  },
  "eventStateAcknowledged" : 1,
  "initiatingDeviceIdentifier" : {
    "instance" : 123456,
    "type" : 8,
    "typeString" : "device"
  },
  "processIdentifier" : 301,
  "timestamp" : {
    "type" : "DATETIME",
    "day" : 13,
    "dayOfWeek" : 2,
    "hour" : 12,
    "hundredth" : 39,
    "minute" : 36,
    "month" : 1,
    "second" : 59,
    "year" : 126
  },
  "timestampMs" : 1767078998
}