8.5.29 FaultList

A FaultList message carries the list of active faults and warnings which are pending at a given M&C. The backend updates this list whenever a fault changes at this M&C but at a maximum rate of one message per second.

To subscribe for the FaultList message, a /api/v1/subscribe API call must be made for the message ID {M&C-Name}.SYSTEM.faultListwhere {M&C-Name} is the name / ID of the M&C of interest.

Data Model (extends Message)

Key Type Value
id String The message ID. This is always the message ID described above. (see Message)
type String The message type (always FAULTLIST, see Message).
time String Timestamp in format 'YYYY-MM-DDTHH:MM.SSZ', see Message).
faults Array An array of FaultInfo objects representing list of actually pending faults and warnings at the given M&C.