{"type":"api","title":"Get Recommended Action for Alarm","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/3ba2ebf1-2c82-351f-9129-0701a2a03db6","info":{"title":"APIs exposed by Alarm Rest service","description":"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":"7.1.0"},"x-parser-conf":{"overview":{"markdownPath":"reference/EMF/fault-emf-api-overview.md"}},"openapi":"3.0.1","servers":[{"url":"https://{server_ip}:30603/crosswork/alarm/v1","description":"Generated server url"}]},"spec":{"tags":["alarm-rest"],"summary":"Get Recommended Action for Alarm","operationId":"getNextStep","parameters":[{"name":"eventType","in":"query","description":"The type of event for which to retrieve the recommended action","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","description":"Details of the next steps recommended for an alarm","properties":{"defaultexplaination":{"type":"string","description":"Default explanation of the event type"},"defaultrecommendedaction":{"type":"string","description":"Default recommended action for the event type"},"erroreventype":{"type":"string","description":"The event type that caused the error"},"explaination":{"type":"string","description":"User-provided explanation for the event type"},"nextstepupdate":{"type":"integer","format":"int32","description":"Indicator for updating recommended action and explanation"},"recommendedaction":{"type":"string","description":"User-provided recommended action for the event type"}},"$$ref":"#/components/schemas/NextstepDTO"},"example":{"defaultexplaination":"The BFD session for the specified interface destination went down. The first s refers to the tunnel name. The second s refers to Sub-LSP destination. The third s refers to list of RRO addresses.","defaultrecommendedaction":"None. This is a solicited message (by logging events bfd-status configuration under tunnel interface) and is informative only.","erroreventype":"ROUTING-MPLS_TE-5-S2L_BFD_DOWN","explaination":"","nextstepupdate":0,"recommendedaction":""}}}},"403":{"description":"Authentication and Authorization errors"},"500":{"description":"operation-failed Response with error"}},"__originalOperationId":"getNextStep","method":"get","path":"/recommended-action"}}