REST API for Active Topology Automation and Service Impact Analysis

Return default filter chips for fallout events

post

/topology/v2/fallout/events/filters

Returns predefined filter options such as state, target system, action, event type, and date range. These values are used to populate UI filter chips.

Request

There are no request parameters for this operation.

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

filters: object filters

Additional Properties Allowed: additionalProperties

{
    "properties":{
        "filters":{
            "additionalProperties":{
            },
            "type":"object"
        }
    },
    "type":"object"
}

Nested Schema : filters

Type: object

Additional Properties Allowed

Show Source

{
    "additionalProperties":{
    },
    "type":"object"
}

Response

Supported Media Types

application/json

200 Response

Successfully fetched filter options.

Root Schema : FalloutEventFilterResponse

Type: object

Show Source

hasMore: boolean
items: array items
totalResults: integer (int64)

{
    "properties":{
        "totalResults":{
            "format":"int64",
            "type":"integer"
        },
        "hasMore":{
            "type":"boolean"
        },
        "items":{
            "items":{
                "$ref":"#/components/schemas/FalloutEventFilterItem"
            },
            "type":"array"
        }
    },
    "type":"object"
}

Nested Schema : items

Type: array

Show Source

Array of: object FalloutEventFilterItem

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

Nested Schema : FalloutEventFilterItem

Type: object

Show Source

filter: string
filterLabel: string
label: string
metadata: object FalloutEventFilterDateMetadata
plugin: string
value: string

{
    "properties":{
        "filter":{
            "type":"string"
        },
        "plugin":{
            "type":"string"
        },
        "filterLabel":{
            "type":"string"
        },
        "label":{
            "type":"string"
        },
        "value":{
            "type":"string"
        },
        "metadata":{
            "$ref":"#/components/schemas/FalloutEventFilterDateMetadata"
        }
    },
    "type":"object"
}

Nested Schema : FalloutEventFilterDateMetadata

Type: object

Show Source

attributeName: string
gte: string
lte: string

{
    "properties":{
        "attributeName":{
            "type":"string"
        },
        "gte":{
            "type":"string"
        },
        "lte":{
            "type":"string"
        }
    },
    "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

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

404 Response

The requested resource not found

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