{"type":"model","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/181eb68a-7ae6-3fee-8588-bdd2b4e91d68","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":"1.0.0"},"x-parser-conf":{"overview":{"markdownPath":"reference/INFRA/FAULT_MANAGEMENT/fault-infra-deprecated-api-overview.md"}},"openapi":"3.0.1","servers":[{"url":"https://{server_ip}:30603/crosswork/alarms/v1","description":"Alarms"}]},"spec":{"title":"alarmsEventUpdate","type":"object","description":"Event structure used to update alarms in the Alarm Center.","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":"Identifier for the service originating the event."},"origin_app_id":{"title":"The origin app id of this event","type":"string","description":"Identifier for the application originating the event."},"object_id":{"title":"The object/model identifier of the faulting event","type":"string","description":"The identifier of the object 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 descriptive text to be displayed in the user interface."},"event_type":{"title":"Event Type for correlation","type":"integer","format":"int32","description":"The type of the event, used for correlation purposes."},"Timestamp":{"type":"string","description":"The time this event was created. Will be filled by the client lib.","format":"int64"},"EventSeverity":{"title":"Event/Alarm Severity","type":"string","default":"InvalidSeverity","enum":["InvalidSeverity","Clear","Info","Warning","Minor","Major","Critical"],"description":"The severity level of the event or alarm.","$$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":"Additional parameters for the event."},"CreateBy":{"type":"string","description":"Who created the event, if the user acknowledges the alarm then the source is the same but the creator is not..."},"EventCategory":{"title":"Defines the Category of the Event/Alarm","type":"string","enum":["System","Network","Security","External"],"example":"System","description":"Updates the category of the event or alarm.","$$ref":"#/components/schemas/alarmsCategoryUpdate"},"Flagging":{"title":"If the event is a flagging event, e.g. raise an alarm","type":"boolean","description":"Indicates if this event is a flagging event."},"alarm_id":{"title":"Alarm ID","type":"string","description":"The identifier for the associated alarm."},"event_case":{"title":"Event case","type":"integer","format":"int32","description":"The case or scenario associated with the event."}},"$$ref":"#/components/schemas/alarmsEventUpdate"}}