Handle alarms - Crosswork Network Controller 7.1 APIs

{"type":"api","title":"Handle alarms","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/675abc36-cffe-3586-8c87-12cc4a16cabc","info":{"title":"RESTCONF Fault APIs - Deprecated","description":"RESTCONF Fault APIs exposed by Alarm Rest service.","contact":{"name":"Crosswork Team, Cisco","email":"support@cisco.com"},"license":{"name":"Cisco Software License Agreement","url":"http://www.cisco.com/public/sw-license-agreement.html"},"version":"1.0.0"},"tags":[{"name":"RESTCONF APIs","description":"Points to note: \nThe actual response will,\n- Have namespace prefixed in the attribute name\n- Not have attributes whose values are null\n- Have the attribute names \"-\" separated in some cases\n- Have additional section with firstIndex and lastIndex attributes"}],"x-parser-conf":{"overview":{"markdownPath":"reference/EMF/fault-restconf-deprecated-api-overview.md"}},"openapi":"3.1.0","servers":[{"url":"https://{server_ip}:30603/restconf/data/v1","description":"Generated server url"}]},"spec":{"tags":["RESTCONF APIs"],"deprecated":true,"summary":"Handle alarms","description":"Supported Actions : Ack/UnAck/Clear","operationId":"setAlarm","requestBody":{"description":"Alarm request","content":{"application/json":{"schema":{"type":"object","description":"Alarm object for request api","xml":{"name":"alarm-request","namespace":"urn:cisco:params:xml:ns:yang:alarms:v1","prefix":"p"},"properties":{"alarm-list":{"type":"object","xml":{"name":"alarm-list","prefix":"p"},"description":"Wrapper of alarm request object","properties":{"alarm":{"type":"array","description":"List of alarm request object","items":{"type":"object","xml":{"name":"alarm","prefix":"p"},"description":"Alarm object for request api","properties":{"alarm-identifier":{"xml":{"prefix":"p"},"type":"object","description":"A complex type to uniquely identify an alarm","properties":{"entityTag":{"type":"string","description":"Generic tag"},"eventIdentifier":{"type":"string","description":"Unique event ID derived from trap ID","xml":{"name":"event-identifier","prefix":"ns5"}},"resourceObjectRef":{"type":"string","description":"fdn","xml":{"name":"resource-object-ref","prefix":"ns5"}},"probableCause":{"type":"string","description":"Probable cause","xml":{"name":"probable-cause","prefix":"ns5"}},"any":{"type":"array","description":"Generic array","items":{"type":"object"}}},"$$ref":"#/components/schemas/AlarmIdentifier"},"uuid":{"type":"string","description":"Alarm uuid"},"type":{"type":"string","description":"Alarm type"},"perceived-severity":{"type":"string","description":"Severity of an alarm, including the cleared state","enum":["CLEARED","INDETERMINATE","MINOR","WARNING","MAJOR","CRITICAL"]},"action-performed":{"type":"string","description":"Indicates if the alarm is Acknowledges, De-acknowledged, Delete. It indicates operator actions","enum":["ALARM_CLEAR","ALARM_ACKNOWLEDGE","ALARM_UNACKNOWLEDGE","ALARM_CLOSE","ALARM_DELETE","ALARM_ANOTATE","ALARM_ACTION_UNKNOWN"]},"note-list":{"type":"object","xml":{"name":"note-list","prefix":"p"},"description":"Note list for request object","properties":{"text":{"type":"string","description":"Note text"}},"$$ref":"#/components/schemas/NoteListForRequest"}},"$$ref":"#/components/schemas/AlarmForRequest"}}},"$$ref":"#/components/schemas/AlarmListForRequest"}},"$$ref":"#/components/schemas/AlarmRequest"},"examples":{"example":{"summary":"Sample request","value":{"alm.alarm-request":{"alm.alarm-list":{"alm.alarm":[{"alm.alarm-identifier":{"alm.event-identifier":"5","alm.probable-cause":"OSPFv3-5-ADJCHG_DOWN"},"alm.type":"device","alm.alarm-id":"5","alm.perceived-severity":"major","alm.action-performed":"alarm-unacknowledge","alm.owner":"","alm.probable-cause":"5","alm.note-list":{"alm.text":"test nbi"}}]}}},"$$ref":"#/components/examples/AlarmHandlingRequestJson"}}},"application/xml":{"schema":{"type":"object","description":"Alarm object for request api","xml":{"name":"alarm-request","namespace":"urn:cisco:params:xml:ns:yang:alarms:v1","prefix":"p"},"properties":{"alarm-list":{"type":"object","xml":{"name":"alarm-list","prefix":"p"},"description":"Wrapper of alarm request object","properties":{"alarm":{"type":"array","description":"List of alarm request object","items":{"type":"object","xml":{"name":"alarm","prefix":"p"},"description":"Alarm object for request api","properties":{"alarm-identifier":{"xml":{"prefix":"p"},"type":"object","description":"A complex type to uniquely identify an alarm","properties":{"entityTag":{"type":"string","description":"Generic tag"},"eventIdentifier":{"type":"string","description":"Unique event ID derived from trap ID","xml":{"name":"event-identifier","prefix":"ns5"}},"resourceObjectRef":{"type":"string","description":"fdn","xml":{"name":"resource-object-ref","prefix":"ns5"}},"probableCause":{"type":"string","description":"Probable cause","xml":{"name":"probable-cause","prefix":"ns5"}},"any":{"type":"array","description":"Generic array","items":{"type":"object"}}},"$$ref":"#/components/schemas/AlarmIdentifier"},"uuid":{"type":"string","description":"Alarm uuid"},"type":{"type":"string","description":"Alarm type"},"perceived-severity":{"type":"string","description":"Severity of an alarm, including the cleared state","enum":["CLEARED","INDETERMINATE","MINOR","WARNING","MAJOR","CRITICAL"]},"action-performed":{"type":"string","description":"Indicates if the alarm is Acknowledges, De-acknowledged, Delete. It indicates operator actions","enum":["ALARM_CLEAR","ALARM_ACKNOWLEDGE","ALARM_UNACKNOWLEDGE","ALARM_CLOSE","ALARM_DELETE","ALARM_ANOTATE","ALARM_ACTION_UNKNOWN"]},"note-list":{"type":"object","xml":{"name":"note-list","prefix":"p"},"description":"Note list for request object","properties":{"text":{"type":"string","description":"Note text"}},"$$ref":"#/components/schemas/NoteListForRequest"}},"$$ref":"#/components/schemas/AlarmForRequest"}}},"$$ref":"#/components/schemas/AlarmListForRequest"}},"$$ref":"#/components/schemas/AlarmRequest"},"examples":{"example":{"summary":"Sample request","value":{"alarm-list":{"alarm":[{"alarm-identifier":{"p:event-identifier":"5","p:probable-cause":"OSPFv3-5-ADJCHG_DOWN"},"p:type":"device","p:alarm-id":"5","p:perceived-severity":"major","p:action-performed":"alarm-unacknowledge","p:owner":"","p:probable-cause":"5","note-list":{"p:text":"test nbi"}}]}},"$$ref":"#/components/examples/AlarmHandlingRequestXml"}}}},"required":true},"responses":{"200":{"description":"Success with response message-body","content":{"application/json":{"schema":{"type":"object","description":"Alarm response for handle alarm api","xml":{"name":"alarm-response","namespace":"urn:cisco:params:xml:ns:yang:alarms:v1","prefix":"ns14"},"properties":{"alarmlist":{"type":"object","xml":{"name":"alarm-list","prefix":"p"},"description":"Wrapper of alarm request object","properties":{"alarm":{"type":"array","description":"List of alarm request object","items":{"type":"object","xml":{"name":"alarm","prefix":"p"},"description":"Alarm object for request api","properties":{"alarm-identifier":{"xml":{"prefix":"p"},"type":"object","description":"A complex type to uniquely identify an alarm","properties":{"entityTag":{"type":"string","description":"Generic tag"},"eventIdentifier":{"type":"string","description":"Unique event ID derived from trap ID","xml":{"name":"event-identifier","prefix":"ns5"}},"resourceObjectRef":{"type":"string","description":"fdn","xml":{"name":"resource-object-ref","prefix":"ns5"}},"probableCause":{"type":"string","description":"Probable cause","xml":{"name":"probable-cause","prefix":"ns5"}},"any":{"type":"array","description":"Generic array","items":{"type":"object"}}},"$$ref":"#/components/schemas/AlarmIdentifier"},"uuid":{"type":"string","description":"Alarm uuid"},"type":{"type":"string","description":"Alarm type"},"perceived-severity":{"type":"string","description":"Severity of an alarm, including the cleared state","enum":["CLEARED","INDETERMINATE","MINOR","WARNING","MAJOR","CRITICAL"]},"action-performed":{"type":"string","description":"Indicates if the alarm is Acknowledges, De-acknowledged, Delete. It indicates operator actions","enum":["ALARM_CLEAR","ALARM_ACKNOWLEDGE","ALARM_UNACKNOWLEDGE","ALARM_CLOSE","ALARM_DELETE","ALARM_ANOTATE","ALARM_ACTION_UNKNOWN"]},"note-list":{"type":"object","xml":{"name":"note-list","prefix":"p"},"description":"Note list for request object","properties":{"text":{"type":"string","description":"Note text"}},"$$ref":"#/components/schemas/NoteListForRequest"}},"$$ref":"#/components/schemas/AlarmForRequest"}}},"$$ref":"#/components/schemas/AlarmListForRequest"}},"$$ref":"#/components/schemas/AlarmResponse"},"examples":{"example":{"summary":"Sample request","value":{"alm.alarm-response":{"alm.alarm-list":[]}},"$$ref":"#/components/examples/AlarmHandlingResponseJson"}}},"application/xml":{"schema":{"type":"object","description":"Alarm response for handle alarm api","xml":{"name":"alarm-response","namespace":"urn:cisco:params:xml:ns:yang:alarms:v1","prefix":"ns14"},"properties":{"alarmlist":{"type":"object","xml":{"name":"alarm-list","prefix":"p"},"description":"Wrapper of alarm request object","properties":{"alarm":{"type":"array","description":"List of alarm request object","items":{"type":"object","xml":{"name":"alarm","prefix":"p"},"description":"Alarm object for request api","properties":{"alarm-identifier":{"xml":{"prefix":"p"},"type":"object","description":"A complex type to uniquely identify an alarm","properties":{"entityTag":{"type":"string","description":"Generic tag"},"eventIdentifier":{"type":"string","description":"Unique event ID derived from trap ID","xml":{"name":"event-identifier","prefix":"ns5"}},"resourceObjectRef":{"type":"string","description":"fdn","xml":{"name":"resource-object-ref","prefix":"ns5"}},"probableCause":{"type":"string","description":"Probable cause","xml":{"name":"probable-cause","prefix":"ns5"}},"any":{"type":"array","description":"Generic array","items":{"type":"object"}}},"$$ref":"#/components/schemas/AlarmIdentifier"},"uuid":{"type":"string","description":"Alarm uuid"},"type":{"type":"string","description":"Alarm type"},"perceived-severity":{"type":"string","description":"Severity of an alarm, including the cleared state","enum":["CLEARED","INDETERMINATE","MINOR","WARNING","MAJOR","CRITICAL"]},"action-performed":{"type":"string","description":"Indicates if the alarm is Acknowledges, De-acknowledged, Delete. It indicates operator actions","enum":["ALARM_CLEAR","ALARM_ACKNOWLEDGE","ALARM_UNACKNOWLEDGE","ALARM_CLOSE","ALARM_DELETE","ALARM_ANOTATE","ALARM_ACTION_UNKNOWN"]},"note-list":{"type":"object","xml":{"name":"note-list","prefix":"p"},"description":"Note list for request object","properties":{"text":{"type":"string","description":"Note text"}},"$$ref":"#/components/schemas/NoteListForRequest"}},"$$ref":"#/components/schemas/AlarmForRequest"}}},"$$ref":"#/components/schemas/AlarmListForRequest"}},"$$ref":"#/components/schemas/AlarmResponse"},"examples":{"example":{"summary":"Sample request","value":{"ns14:alarm-list":null},"$$ref":"#/components/examples/AlarmHandlingResponseXml"}}}}},"400":{"description":"Bad Request - Invalid request"},"401":{"description":"Unauthorized. The request has not been applied because it lacks valid authentication credentials for the target resource."},"403":{"description":"Forbidden. The server recognizes the authentication credentials, but the client is not authorized to perform this request."},"500":{"description":"Internal Server Error - operation-failed"}},"method":"put","path":"/cisco-alarm:handle-alarm"}}