AlarmService Resource

POST /v1/alarm/search/count

Request Body
media type data type
application/json AlarmQuery (JSON)
Response Body
media type data type description
application/json AlarmHitCount (JSON)

Example

Request
POST /v1/alarm/search/count
Content-Type: application/json
Accept: application/json

                
{
  "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::vin::present", "wcu::info::vin::not_present" ],
  "severityRegex" : "warning|error",
  "severities" : [ "info", "error" ],
  "includeClosedAlarms" : false,
  "includeHitCount" : false,
  "limit" : 100,
  "page" : 1,
  "orderBy" : "resource",
  "sortOrder" : "asc"
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "count" : 12345
}

POST /v1/alarm/search/results

Request Body
media type data type
application/json AlarmQuery (JSON)
Response Body
media type data type description
application/json AlarmResult (JSON)

Example

Request
POST /v1/alarm/search/results
Content-Type: application/json
Accept: application/json

                
{
  "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::state::shelved::connect", "wcu::info::start_switch::ext" ],
  "severityRegex" : "warning|error",
  "severities" : [ "warning", "warning" ],
  "includeClosedAlarms" : false,
  "includeHitCount" : false,
  "limit" : 100,
  "page" : 1,
  "orderBy" : "resource",
  "sortOrder" : "asc"
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "hitCount" : 12345,
  "page" : 12345,
  "limit" : 12345,
  "alarms" : [ {
    "id" : 12345,
    "category" : "wcu::info::uptime::excessive",
    "date" : "...",
    "message" : "...",
    "severity" : "info",
    "source" : "..."
  }, {
    "id" : 12345,
    "category" : "wcu::info::time::wrong",
    "date" : "...",
    "message" : "...",
    "severity" : "warning",
    "source" : "..."
  } ]
}