Situations Specific API to Facilitate The Display and Manipulation of Situations

Description

Things this API should consider (break into multiple Stories if necessary):

  • Listing situations (there may be a situations or alarms endpoint, check it first).  Is there a way to request from the API with a filter for just situations?

  • Alarms for a Situation - Again, there is an alarms and a situations API, please double check.

  • Events for an Alarm - Same as above.

  • Remove Alarm from Situation -

  • Add Alarm to a Situation

  • Create a New Situation

  • Accept or Reject an Existing Situation - This will need to result in changes to schema, so that the situation may be marked as rejected or accepted.  This will be fed back to the cloud.

Consider extending current APIs (with Jesse's guidance), so that other portions of the product can benefit, if applicable.  

I would need a new API endpoint from Alec backend with list of situations, detail of each situation and related alarm list and details:

Acceptance / Success Criteria

None

Attachments

1
  • 14 Jun 2022, 03:32 PM
62% Done
0

Lucidchart Diagrams

Activity

Show:

Benjamin Janssens June 20, 2022 at 2:01 PM

could you explain the last bullet point ? ("leave or remove unused properties")

Anya Rybalova June 17, 2022 at 8:58 PM
Edited

endpoint:  /opennms/api/v2/alarms

alarm is situation if it has relatedAlarms array

response:

  • situation list with details and list of alarms

  • ordered by severity and number of alarms (by number of critical alarms?) or maybe by eventime

  • leave or remove unused properties?

Details

Assignee

Reporter

Priority

Epic Name

PagerDuty

Created June 14, 2022 at 3:40 PM
Updated August 3, 2022 at 6:36 PM