REST API for Active Topology Automation and Service Impact Analysis

Get fallout events summary

get

/topology/v2/fallout/events/summary

The fallout events summary was retrieved sucessfuly. Optionally, results can be grouped by one or more fields (errorCode, state, action, sourceSystemiI, targetService) using the 'groupBy' query parameter.

Request

Query Parameters

groupBy: string

Group by one or more of the following fields (comma separated): errorCode, state, action, sourceSystemId, targetService.
sourceSystemId: string

Retrieves the fallout events summary grouped by sourceSystemId.
targetService: string

Based on targetService, will get fallout events summary. Supported values for targetService are ATA, SSC & AlarmConsumer.

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Returns either a detailed summary of fallout events with counts grouped by actions and their respective states when no 'groupBy' parameter is provided, or a grouped summary based on the 'groupBy' query parameter (which can be one or more of errorcode, state, action, sourcesystemid and/or targetService).

Root Schema : schema

Match One Schema

Show Source

object FalloutEventSummary
object FalloutEventGroupSummary

{
    "oneOf":[
        {
            "$ref":"#/components/schemas/FalloutEventSummary"
        },
        {
            "$ref":"#/components/schemas/FalloutEventGroupSummary"
        }
    ]
}

Nested Schema : FalloutEventSummary

Type: object

Show Source

actions: array actions
count: integer (int64)
targetService: string

{
    "properties":{
        "count":{
            "format":"int64",
            "type":"integer"
        },
        "actions":{
            "items":{
                "$ref":"#/components/schemas/FalloutEventActionSummary"
            },
            "type":"array"
        },
        "targetService":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : FalloutEventGroupSummary

Type: object

Show Source

fallouts: array fallouts
totalCount: integer (int64)

{
    "properties":{
        "fallouts":{
            "items":{
            },
            "type":"array"
        },
        "totalCount":{
            "format":"int64",
            "type":"integer"
        }
    },
    "type":"object"
}

Nested Schema : actions

Type: array

Show Source

Array of: object FalloutEventActionSummary

{
    "items":{
        "$ref":"#/components/schemas/FalloutEventActionSummary"
    },
    "type":"array"
}

Nested Schema : FalloutEventActionSummary

Type: object

Show Source

action: string
count: integer (int64)
states: object states

Additional Properties Allowed: additionalProperties

{
    "properties":{
        "action":{
            "type":"string"
        },
        "count":{
            "format":"int64",
            "type":"integer"
        },
        "states":{
            "additionalProperties":{
                "format":"int64",
                "type":"integer"
            },
            "type":"object"
        }
    },
    "type":"object"
}

Nested Schema : states

Type: object

Additional Properties Allowed

Show Source

integer(int64)

{
    "additionalProperties":{
        "format":"int64",
        "type":"integer"
    },
    "type":"object"
}

Nested Schema : fallouts

Type: array

Show Source

Array of:

{
    "items":{
    },
    "type":"array"
}

Examples

400 Response

The request isn't valid

Root Schema : ErrorType

Type: object

Show Source

code(required): string
message: array message
reason(required): string
status: string

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string"
        },
        "reason":{
            "type":"string"
        },
        "message":{
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "status":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : message

Type: array

Show Source

Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array"
}

401 Response

You aren't authorized to make this request.

Root Schema : ErrorType

Type: object

Show Source

code(required): string
message: array message
reason(required): string
status: string

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string"
        },
        "reason":{
            "type":"string"
        },
        "message":{
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "status":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : message

Type: array

Show Source

Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array"
}

403 Response

The request is forbidden

Root Schema : ErrorType

Type: object

Show Source

code(required): string
message: array message
reason(required): string
status: string

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string"
        },
        "reason":{
            "type":"string"
        },
        "message":{
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "status":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : message

Type: array

Show Source

Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array"
}

500 Response

An Internal Server Error has occurred

Root Schema : ErrorType

Type: object

Show Source

code(required): string
message: array message
reason(required): string
status: string

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string"
        },
        "reason":{
            "type":"string"
        },
        "message":{
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "status":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : message

Type: array

Show Source

Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array"
}