{"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":"alarmsV2GetAlarmsReq","type":"object","description":"Request Alarms proto, FilterCondition for alarms","required":["filterParams"],"properties":{"filterParams":{"title":"FilterParams for alarms","type":"object","description":"FilterParams for alarms","required":["type","alarmCategory"],"properties":{"type":{"type":"string","description":"The type of alarms to filter by","enum":["system","network","device"],"example":"system"},"alarmId":{"type":"string","description":"The unique identifier of the alarm to filter by"},"alarmCategory":{"type":"string","description":"The category of alarms to filter by"},"state":{"type":"string","enum":["critical","major","minor","warning","information","cleared"],"example":"major","description":"The state of the alarms to filter by"},"description":{"type":"string","description":"A description to filter alarms by"},"source":{"type":"string","description":"The source of alarms to filter by"},"generatedBy":{"type":"string","description":"The entity that generated the alarms to filter by"},"displayName":{"type":"string","description":"The display name to filter alarms by"},"eventName":{"type":"string","description":"The event name to filter alarms by"}},"$$ref":"#/components/schemas/FilterParams"},"filterCondition":{"type":"string","enum":["and","or"],"example":"and","description":"The condition to apply for filtering alarms"},"openAlarmsOnly":{"type":"boolean","default":false,"description":"Whether to only include open alarms"},"sortParams":{"type":"string","example":"updated.DESC/ASC","description":"The parameters to sort the alarms by"},"range":{"type":"string","default":"0-100","description":"The range of alarms to return"}},"$$ref":"#/components/schemas/alarmsV2GetAlarmsReq"}}