Webex · Schema

Alarm

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
id string A unique identifier for the alarm.
created string The date and time the alarm was raised.
severity object The severity level of the alarm: - `critical` - `error` - `warning` - `alert`
title string The title of the alarm.
description string A description of the alarm.
hybridConnectorId string The ID of the connector the alarm is raised on.
View JSON Schema on GitHub

JSON Schema

webex-alarm-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Alarm",
  "title": "Alarm",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "example": "Y2lZY76123af234bbYY",
      "description": "A unique identifier for the alarm."
    },
    "created": {
      "type": "string",
      "example": "2017-09-15T15:53:00Z",
      "description": "The date and time the alarm was raised."
    },
    "severity": {
      "$ref": "#/components/schemas/AlarmSeverity",
      "description": "The severity level of the alarm:\n\n- `critical`\n\n- `error`\n\n- `warning`\n\n- `alert`"
    },
    "title": {
      "type": "string",
      "example": "Something is wrong",
      "description": "The title of the alarm."
    },
    "description": {
      "type": "string",
      "example": "More detail about something being wrong",
      "description": "A description of the alarm."
    },
    "hybridConnectorId": {
      "type": "string",
      "example": "Y2lZY76123af234bb",
      "description": "The ID of the connector the alarm is raised on."
    }
  }
}