REST API for Active Topology Automator

Update a fallout event

put

/topology/v2/fallout/events/eid/{eid}

Updates the fallout event's event attribute that matches eid. Has be resubmitted later

Request

Path Parameters

eid(required): string

Supported Media Types

application/json

Root Schema : schema

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

Response

Supported Media Types

application/json

200 Response

Fallout event updated successfully

Root Schema : schema

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

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

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