Jump to

• Request
• Response

Get fallout events

get

/topology/v2/fallout/events

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

Request

Query Parameters

• action: string
  The action of the Fallout Event to filter by
• errorcode: string
  The error code of the Fallout Event to filter by
• eventtype: string
  The event type of the Fallout Event to filter by
• limit: integer(int32)
  The number of items to return
• offset: integer(int32)
  The number of items to skip before starting to collect the result set

  Default Value: 0
• state: string
  The state of the Fallout Event to filter by

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Fallout Event with given entityId

Body ()

Root Schema : FalloutEvent

Type: object

Show Source

• action: string
• createdDate: string (date)
• createdUser: string
• entityId: integer (int64)
• errorCode: string
• errorDescription: string
• event: string
• eventHeaders: string
• eventType: string
• lastModifiedDate: string (date)
• lastModifiedUser: string
• origEvent: object origEvent
• sourceSystemId: string
• state: string

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

Nested Schema : origEvent

Type: object

Examples

Select an example Response

204 Response

No fallout events found

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

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