Jump to

• Request
• Response

Get fallout events summary

get

/topology/v2/fallout/events/summary

Get a brief summary of the status of fallout events

Request

There are no request parameters for this operation.

There's no request body for this operation.

Back to Top

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

Body ()

Root Schema : FalloutEventSummary

Type: object

Show Source

• actions: array actions
• count: integer (int64)

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

Examples

Select an example Response

400 Response

The request isn't valid

Body ()

Root Schema : ErrorType

Type: object

Show Source

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

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "nullable":false,
            "type":"string"
        },
        "message":{
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "reason":{
            "nullable":false,
            "type":"string"
        },
        "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

Body ()

Root Schema : ErrorType

Type: object

Show Source

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

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "nullable":false,
            "type":"string"
        },
        "message":{
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "reason":{
            "nullable":false,
            "type":"string"
        },
        "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

Body ()

Root Schema : ErrorType

Type: object

Show Source

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

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "nullable":false,
            "type":"string"
        },
        "message":{
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "reason":{
            "nullable":false,
            "type":"string"
        },
        "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

Body ()

Root Schema : ErrorType

Type: object

Show Source

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

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

Nested Schema : message

Type: array

Show Source

• Array of: string

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

Back to Top