{"type":"api","title":"Add Note to Alarms","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":{"tags":["Alarm"],"summary":"Add Note to Alarms","description":"Alarm category type can be system/network/device","operationId":"alarmNote","requestBody":{"content":{"application/json":{"schema":{"title":"Acknowledge/UnAcknowledge/Notes Alarm Request","type":"object","description":"v2 Notes Alarm Request","properties":{"alarmId":{"type":"string","description":"The unique identifier for the alarm"},"note":{"type":"string","description":"A note related to the alarm"},"type":{"type":"string","description":"Alarm category type can be system/network/device","enum":["system","network","device"],"example":"system"}},"$$ref":"#/components/schemas/alarmsV2NoteClearAlarmReq"},"example":{"alarmId":"92234f57-2530-4a96-879f-22e2a9e9201e","note":"testNote","type":"system"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"title":"Acknowledge/UnAcknowledge/Notes Alarm Response","type":"object","description":"Acknowledge/UnAcknowledge/Notes Alarm Response","properties":{"state":{"type":"string","description":"The state of the alarm after the operation"},"Message":{"type":"string","description":"A message related to the alarm operation"},"alarmid":{"type":"string","description":"The unique identifier for the alarm"}},"$$ref":"#/components/schemas/alarmsV2AcknowledgeAlarmResp"},"example":{"state":"Success","alarmId":"92234f57-2530-4a96-879f-22e2a9e9201e","Message":"admin"}}}},"403":{"description":"Authentication and Authorization errors"},"500":{"description":"operation-failed Response with error"}},"__originalOperationId":"alarmNote","method":"put","path":"/note"}}