{"type":"api","title":"Update 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":"Update Recommended Action for Alarm","description":"Supported Actions : Update Alarm Recommended Action\n\nPayload attributes: \n\u003cb\u003edefaultexplaination\u003c/b\u003e: string (Default explanation of eventtype for example 'The BFD session can not be created or modified due to lack of resources') \n\u003cb\u003edefaultrecommendedaction\u003c/b\u003e: string (Default recommended action of eventtype for example 'Remove other BFD sessions to free resources for this session') \n\u003cb\u003eerroreventype\u003c/b\u003e: string (for example 'L2-BFD-6-SESSION_NO_RESOURCES') \n\u003cb\u003enextstepupdate\u003c/b\u003e: integer ( for example 1 to update recommended action and explaination) \n\u003cb\u003eexplaination\u003c/b\u003e: string (user provided explanation for eventype) \n\u003cb\u003erecommendedaction\u003c/b\u003e: string (user provided explanation for eventype)","operationId":"updateRecommendedAction","parameters":[{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"Update details for the next steps recommended for an alarm","properties":{"erroreventype":{"type":"string","description":"The event type that caused the error"},"explaination":{"type":"string","description":"User-provided explanation for the event type"},"recommendedaction":{"type":"string","description":"User-provided recommended action for the event type"}},"$$ref":"#/components/schemas/NextstepDTOUpdate"},"example":{"erroreventype":"ROUTING-MPLS_TE-5-S2L_BFD_DOWN","explaination":"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.","recommendedaction":"This is a solicited message (by logging events bfd-status configuration under tunnel interface and is informative only."}}},"required":true},"responses":{"200":{"description":"OK","content":{}},"403":{"description":"Authentication and Authorization errors"},"500":{"description":"operation-failed Response with error"}},"__originalOperationId":"updateRecommendedAction","method":"post","path":"/recommended-action"}}