{"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":"alarmsEvent","type":"object","description":"An Event structure, an application/service will post this proto as an input for the Alarm Center to create Events and Alarms","properties":{"EventId":{"type":"string","description":"Generated uuid to identify uniquely the event. Will be generated by the client lib."},"origin_service_id":{"title":"The origin service id of this event","type":"string","description":"The ID of the service where the event originated"},"origin_app_id":{"title":"The origin app id of this event","type":"string","description":"The ID of the application where the event originated"},"object_id":{"title":"The object/model identifier of the faulting event","type":"string","description":"The identifier of the object or model related to the event"},"object_description":{"title":"The description of the object/model identifier as it should be shown in the GUI","type":"string","description":"A user-friendly description of the object or model"},"event_type":{"title":"Event Type for correlation","type":"integer","format":"int32","description":"The type of event, used for correlation"},"Timestamp":{"type":"string","description":"The time this event was created. Will be filled by the client lib.","format":"int64"},"EventSeverity":{"title":"Defines the Event/Alarm severity","type":"string","description":"The severity level of the event or alarm","default":"InvalidSeverity","enum":["InvalidSeverity","Clear","Info","Warning","Minor","Major","Critical"],"$$ref":"#/components/schemas/alarmsSeverity"},"Description":{"type":"string","description":"A free text, parametrized, description. Do not need to fill if there is an event type..."},"Params":{"title":"Parameters for the event case Text","type":"object","additionalProperties":{"type":"string"},"description":"Key-value pairs of parameters for the event"},"CreateBy":{"type":"string","description":"Who created the event, if the user acknowledge the alarm then the source is the same but the creator is not..."},"EventCategory":{"title":"Defines the Category of the Event/Alarm","type":"string","default":"InvalidCategory","enum":["InvalidCategory","System","Network","Audit","Security","External"],"description":"The category of the event or alarm","$$ref":"#/components/schemas/alarmsCategory"},"Flagging":{"title":"If the event is a flagging event, e.g. raise an alarm","type":"boolean","description":"Whether the event should flag an alarm"},"alarm_id":{"title":"Alarm ID","type":"string","description":"The ID of the alarm associated with this event"},"event_case":{"title":"Event case","type":"integer","format":"int32","description":"The specific case or scenario for the event"}},"$$ref":"#/components/schemas/alarmsEvent"}}