AlarmQuery Data Type

Query used for performing alarm searches.

Properties
name data type constraints description
sourceRegex string   AlarmSources matching the provided regular expression.
sources array of string   A distinct list of AlarmSource. Provided sources must be of format car::<vin>, task::<taskID>::wcu::<wcuID> or wcu::<wcuID>.
from string   Created after or equal to this timestamp. Provided timestamp must be of format 2025-10-14T05:44:30Z
to string   Created before or equal to this timestamp. Provided timestamp must be of format 2025-10-14T05:44:30Z
messageRegex string   Message matching the provided regular expression.
categoryRegex string   Categories matching the provided regular expression. See AlarmCategory for full category pattern.
categories array of AlarmCategory   A distinct list of AlarmCategory.
severityRegex string   Severities matching the provided regular expression. See AlarmSeverity for all possible severites.
severities array of AlarmSeverity   A distinct list of AlarmSeverity.
includeClosedAlarms boolean required boolean If closed alarms should be included. Default is false.
includeHitCount boolean required boolean Set to true to always include the total number of results in the AlarmResult as the number in each fetch is limited by getLimit. Default value is false
limit number required int The number of results to return for each page. Default and maximum value is 100.
page number required int Increase the page number to be able to fetch all results if getHitCount or getCount returned more than 100. Default value is 1.
orderBy AlarmOrderBy   Determines the sorting of the results.
sortOrder AlarmSortOrder   Determines whether the results are sorted in ascending or descending order according to the field returned by getOrderBy.

Example

{
  "sourceRegex" : "wcu::wcu1|wcu::wcu2",
  "sources" : [ "wcu::m2m_wcu_2_53_1", "task::123456::wcu::m2m_wcu_2_53_1" ],
  "from" : "2025-10-14T05:44:30Z",
  "to" : "2025-10-14T06:44:30Z",
  "messageRegex" : "certificate",
  "categoryRegex" : "wcu::state",
  "categories" : [ "wcu::info::cert::present", "file::mdf::time::backward" ],
  "severityRegex" : "warning|error",
  "severities" : [ "fatal", "warning" ],
  "includeClosedAlarms" : false,
  "includeHitCount" : false,
  "limit" : 100,
  "page" : 1,
  "orderBy" : "resource",
  "sortOrder" : "asc"
}