Handle alarms - Crosswork Network Controller 7.1 APIs

{"type":"api","title":"Handle alarms","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/06d8249a-a613-365c-b954-9663df823fd7","info":{"title":"RESTCONF Fault APIs","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-api-overview.md"}},"openapi":"3.1.0","servers":[{"url":"https://{server_ip}:30603/crosswork/alarm/restconf/data/v2","description":"Generated server url"}]},"spec":{"tags":["RESTCONF APIs"],"summary":"Handle alarms","description":"Supported Actions : Ack/UnAck/Clear \n\nPayload attributes: \n\u003cb\u003euuid\u003c/b\u003e: string (for example '782d1ece-3c36-4c45-9110-b527c1bdceed') \n\u003cb\u003etype\u003c/b\u003e: string (possible values [device,network,system]) \n\u003cb\u003eperceived-severity\u003c/b\u003e: string (possible values [cleared,indeterminate,minor,warning,major,critical]) \n\u003cb\u003eaction-performed\u003c/b\u003e: string (possible values [alarm-clear,alarm-acknowledge,alarm-unacknowledge]) \n\u003cb\u003enote-list -\u003e text\u003c/b\u003e: string 'alarm note for the handle alarm operation'","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":{"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 payload","value":{"alm.alarm-request":{"alm.alarm-list":{"alm.alarm":[{"alm.uuid":"782d1ece-3c36-4c45-9110-b527c1bdceed","alm.perceived-severity":"critical","alm.action-performed":"alarm-acknowledge","alm.type":"device","alm.note-list":{"alm.text":"clear for testing 03082024"}}]}}},"$$ref":"#/components/examples/AlarmHandlePayloadJson"}}},"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":{"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 payload","value":{"alarm-list":{"alarm":[{"p:uuid":"782d1ece-3c36-4c45-9110-b527c1bdceed","p:perceived-severity":"critical","p:action-performed":"alarm-acknowledge","p:type":"device","note-list":{"p:text":"clear for testing 03082024"}}]}},"$$ref":"#/components/examples/AlarmHandlePayloadXml"}}}},"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":{"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":{"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":{"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":"/alarm:handle-alarm"}}