REST API for Active Topology Automation and Service Impact Analysis

Get fallout events

get

/topology/v2/fallout/events

Retrieves all fallout events that match the search criteria specified in the query parameters.

Request

Query Parameters

action: string

The action of the fallout event to filter results by.
endCreationDate: string

The end date of the creation date range filter (format: yyyy-MM-dd)
endLastModifiedDate: string

The end date of the last modified date range filter (format: yyyy-MM-dd)
errorCode: string

The error code of the fallout event to filter results by.
eventType: string

The event type of the fallout event to filter results by.
limit: integer(int32)

the maximum number of results to return.
offset: integer(int32)

The number of items to skip before starting to return the results.

Default Value: 0
sortField: string

The field and direction to sort results. Format: field:asc|desc
startCreationDate: string

The start date of the creation date range filter (format: yyyy-MM-dd)
startLastModifiedDate: string

The start date of the last modified date range filter (format: yyyy-MM-dd)
state: string

The state of the fallout event to filter results by.
targetService: string

The target service of the fallout event to filter results by.

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

The fallout events were retrieved sucessfully.

Root Schema : FalloutEvent

Type: object

Show Source

action: string
createdDate: string (date)

Example: 2022-03-10
createdUser: string
entityId: integer (int64)
errorCode: string
errorDescription: string
event: string
eventHeaders: string
eventType: string
lastModifiedDate: string (date)

Example: 2022-03-10
lastModifiedUser: string
origEvent: object origEvent
sourceSystemId: string
state: string
targetSystemId: string

{
    "properties":{
        "entityId":{
            "format":"int64",
            "type":"integer"
        },
        "event":{
            "type":"string"
        },
        "eventType":{
            "type":"string"
        },
        "errorCode":{
            "type":"string"
        },
        "errorDescription":{
            "type":"string"
        },
        "eventHeaders":{
            "type":"string"
        },
        "origEvent":{
            "type":"object"
        },
        "sourceSystemId":{
            "type":"string"
        },
        "createdUser":{
            "type":"string"
        },
        "createdDate":{
            "example":"2022-03-10",
            "format":"date",
            "type":"string"
        },
        "lastModifiedUser":{
            "type":"string"
        },
        "lastModifiedDate":{
            "example":"2022-03-10",
            "format":"date",
            "type":"string"
        },
        "action":{
            "type":"string"
        },
        "state":{
            "type":"string"
        },
        "targetSystemId":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : origEvent

Type: object

Examples

204 Response

No fallout events 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"
}

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