{"type":"model","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/9792902d-b2cb-3a50-8089-29b3532bc5ed","info":{"title":"Crosswork Alarms and Events APIs","description":"Crosswork Alarms and Events APIs allow applications to create, update, acknowledge and clear alarms.","contact":{"name":"Crosswork Team, Cisco","email":"support@cisco.com"},"license":{"name":"Cisco Software License Agreement","url":"https://www.cisco.com/public/sw-license-agreement.html"},"version":"7.1.0"},"x-parser-conf":{"overview":{"markdownPath":"reference/INFRA/FAULT_MANAGEMENT/fault-infra-api-overview.md"}},"openapi":"3.0.1","servers":[{"url":"https://{server_ip}:30603/crosswork/alarm/v1","description":"Alarm/Alarm-Rest"}]},"spec":{"title":"alarmsV2AlarmResponseQuery","type":"object","description":"Alarm Query Response","properties":{"alarms":{"type":"array","description":"An array of alarmsV2AlarmResponse objects","items":{"title":"Alarm Response","type":"object","description":"Alarm Response","properties":{"eventName":{"type":"string","description":"The name of the event related to the alarm. Type can be System or network or device"},"type":{"type":"string","enum":["system","network","device"],"example":"system","description":"The type of alarm"},"notificationDeliveryMechanism":{"type":"string","description":"The mechanism used to deliver notifications"},"deviceUUID":{"type":"string","nullable":true,"description":"The UUID of the device related to the alarm"},"created":{"type":"string","description":"The timestamp when the alarm was created"},"updated":{"type":"string","description":"The timestamp when the alarm was last updated"},"alarmCategory":{"type":"string","description":"The category of the alarm"},"acknowledge":{"type":"boolean","description":"Whether the alarm has been acknowledged"},"alarmId":{"type":"string","description":"The unique identifier for the alarm"},"displayName":{"type":"string","description":"A user-friendly display name for the alarm"},"description":{"type":"string","description":"The description of the alarm"},"applicationSpecificID":{"type":"string","description":"An application-specific identifier for the alarm. State can be CRITICAL/MAJOR/MINOR/WARNING/INFORMATION/CLEARED"},"state":{"type":"string","enum":["CRITICAL","MAJOR","MINOR","WARNING","INFORMATION","CLEARED"],"example":"MAJOR","description":"The current state of the alarm"},"source":{"type":"string","description":"The source from which the alarm originated"},"notes":{"type":"string","description":"Any notes associated with the alarm"},"generatedBy":{"type":"string","description":"The entity that generated the alarm"},"deviceTimestamp":{"type":"string","nullable":true,"description":"The timestamp on the device when the alarm was generated"},"total":{"type":"string","format":"int64","description":"The total number of related items or events"}},"$$ref":"#/components/schemas/alarmsV2AlarmResponse"}},"total":{"type":"string","description":"The total number of alarms returned in the response"}},"$$ref":"#/components/schemas/alarmsV2AlarmResponseQuery"}}