REST API for Active Topology Automator

Get fallout events summary

get

/topology/v2/fallout/events/summary

Gets a brief summary of the status of fallout events

Request

Query Parameters

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

Summary of fallout events with count of events grouped as per ACTION and STATE along with total events

Root Schema : FalloutEventSummary

Type: object

Show Source

actions: array actions
count: integer (int64)

{
    "properties":{
        "count":{
            "format":"int64",
            "type":"integer"
        },
        "actions":{
            "items":{
                "$ref":"#/components/schemas/FalloutEventActionSummary"
            },
            "type":"array"
        }
    },
    "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"
}

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

The request is unauthorized

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"
}