Jump to

• Request
• Response

Get member events for the incident

get

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/incidents/{incidentId}/events

Returns the list of events participating in the specific incident. The events are sorted by the time of creation by default.

Request

Path Parameters

• incidentId(required): string(raw)
  ID of the incident

Query Parameters

• limit: integer(int32)
  Limits number of items returned in current call. Use the self/previous/next links from the response to fetch additional items.

  Default Value: 50
• page: string
  Identifies the set of items to be fetched; "href" element from "links" list of the response provides encoded value for this parameter. "href" element value should be used "as is" for fetching respective set of items.

  Default Value: Base64 encode value of 0 i.e MA==
• sort: string
  Sort results by supported resource attributes such as id, name, message, type, timeCreated. timeUpdated, isOpen and severity

  Example:

  severity:ASC,timeCreated:DESC

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation - Fetch all the related events to the incident

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object EventCollection
  List of event summary

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

Nested Schema : EventCollection

Type: object

List of event summary

Show Source

• count: integer (int32)
  Number of rows returned

  Example: 1
• items(required): array items
  List of the event summary
• links: object links
  Read Only: true

  URL links to paginated resource(s).

{
    "required":[
        "items"
    ],
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"Number of rows returned",
            "format":"int32",
            "example":1
        },
        "links":{
            "required":[
                "self"
            ],
            "type":"object",
            "properties":{
                "self":{
                    "$ref":"#/components/schemas/Link"
                },
                "next":{
                    "$ref":"#/components/schemas/Link"
                },
                "previous":{
                    "$ref":"#/components/schemas/Link"
                }
            },
            "description":"URL links to paginated resource(s).",
            "readOnly":true,
            "example":{
                "self":{
                    "href":"/em/api/incidents/CCB9A8BDF77C400EE053860E4B6416AA/events?page=MQ%3D%3D&limit=50"
                },
                "next":{
                    "href":"/em/api/incidents/CCB9A8BDF77C400EE053860E4B6416AA/events?page=Mg%3D%3D&limit=50"
                },
                "previous":{
                    "href":"/em/api/incidents/CCB9A8BDF77C400EE053860E4B6416AA/events?page=MA%3D%3D&limit=50"
                }
            }
        },
        "items":{
            "type":"array",
            "description":"List of the event summary",
            "items":{
                "$ref":"#/components/schemas/EventSummary"
            }
        }
    },
    "description":"List of event summary"
}

Nested Schema : items

Type: array

List of the event summary

Show Source

• Array of: object EventSummary
  Summary of an event

{
    "type":"array",
    "description":"List of the event summary",
    "items":{
        "$ref":"#/components/schemas/EventSummary"
    }
}

Nested Schema : links

Type: object

Read Only: true

URL links to paginated resource(s).

Show Source

• next: object Link
  Represents a link(could be self, previous or next)
• previous: object Link
  Represents a link(could be self, previous or next)
• self(required): object Link
  Represents a link(could be self, previous or next)

{
    "required":[
        "self"
    ],
    "type":"object",
    "properties":{
        "self":{
            "$ref":"#/components/schemas/Link"
        },
        "next":{
            "$ref":"#/components/schemas/Link"
        },
        "previous":{
            "$ref":"#/components/schemas/Link"
        }
    },
    "description":"URL links to paginated resource(s).",
    "readOnly":true,
    "example":{
        "self":{
            "href":"/em/api/incidents/CCB9A8BDF77C400EE053860E4B6416AA/events?page=MQ%3D%3D&limit=50"
        },
        "next":{
            "href":"/em/api/incidents/CCB9A8BDF77C400EE053860E4B6416AA/events?page=Mg%3D%3D&limit=50"
        },
        "previous":{
            "href":"/em/api/incidents/CCB9A8BDF77C400EE053860E4B6416AA/events?page=MA%3D%3D&limit=50"
        }
    }
}

Example:

{
    "self":{
        "href":"/em/api/incidents/CCB9A8BDF77C400EE053860E4B6416AA/events?page=MQ%3D%3D&limit=50"
    },
    "next":{
        "href":"/em/api/incidents/CCB9A8BDF77C400EE053860E4B6416AA/events?page=Mg%3D%3D&limit=50"
    },
    "previous":{
        "href":"/em/api/incidents/CCB9A8BDF77C400EE053860E4B6416AA/events?page=MA%3D%3D&limit=50"
    }
}

Nested Schema : EventSummary

Type: object

Summary of an event

Show Source

• associatedIncidentId: string (raw)
  Read Only: true

  ID of the associated incident

  Example: C4E214A1172A2F19E053860E4B645AC7
• canBeManuallyClosed: boolean
  Default Value: false

  Can a user clear this event?

  Example: true
• isOpen(required): boolean
  Is the event open?

  Example: true
• links: object links
  Read Only: true

  URL links inside details of resource.
• message(required): string
  Message of the event

  Example: CPU Utilization is 10.821%, crossed warning (5) or critical (10) threshold.
• name: string
  Name of the event

  Example: Load:cpuUtil
• nonTargetEntities: array nonTargetEntities
  Minimum Number of Items: 0

  Unique Items Required: true

  Entities other than targets which are affected by this event
• sequenceId(required): string (raw)
  Read Only: true

  ID of the event

  Example: C4E06BD206B62AB3E053860E4B64C911
• severity(required): string
  Read Only: true

  Allowed Values: [ "FATAL", "CRITICAL", "WARNING", "MINOR_WARNING", "CLEAR" ]

  Supported list of the severities

  Example: CRITICAL
• targets: array targets
  Minimum Number of Items: 0

  Unique Items Required: true

  Targets affected by this incident
• timeCreated(required): string (date-time)
  Read Only: true

  Time when the event is created

  Example: 2021-07-20T16:47:56.000Z
• timeUpdated(required): string (date-time)
  Read Only: true

  Time when the event is last updated

  Example: 2021-07-21T06:25:43.000Z
• typeDisplayName: string
  Display name of the event type

  Example: Metric Alert
• typeName: string
  Type of the event

  Example: metric_alert

{
    "required":[
        "isOpen",
        "message",
        "sequenceId",
        "severity",
        "timeCreated",
        "timeUpdated"
    ],
    "type":"object",
    "properties":{
        "sequenceId":{
            "type":"string",
            "description":"ID of the event",
            "format":"raw",
            "readOnly":true,
            "example":"C4E06BD206B62AB3E053860E4B64C911"
        },
        "name":{
            "type":"string",
            "description":"Name of the event",
            "example":"Load:cpuUtil"
        },
        "message":{
            "type":"string",
            "description":"Message of the event",
            "example":"CPU Utilization is 10.821%, crossed warning (5) or critical (10) threshold."
        },
        "typeName":{
            "type":"string",
            "description":"Type of the event",
            "example":"metric_alert"
        },
        "typeDisplayName":{
            "type":"string",
            "description":"Display name of the event type",
            "example":"Metric Alert"
        },
        "targets":{
            "minItems":0,
            "uniqueItems":true,
            "type":"array",
            "description":"Targets affected by this incident",
            "items":{
                "$ref":"#/components/schemas/Target"
            }
        },
        "nonTargetEntities":{
            "minItems":0,
            "uniqueItems":true,
            "type":"array",
            "description":"Entities other than targets which are affected by this event",
            "items":{
                "$ref":"#/components/schemas/SourceEntity"
            }
        },
        "timeCreated":{
            "type":"string",
            "description":"Time when the event is created",
            "format":"date-time",
            "readOnly":true,
            "example":"2021-07-20T16:47:56.000Z"
        },
        "timeUpdated":{
            "type":"string",
            "description":"Time when the event is last updated",
            "format":"date-time",
            "readOnly":true,
            "example":"2021-07-21T06:25:43.000Z"
        },
        "isOpen":{
            "type":"boolean",
            "description":"Is the event open?",
            "example":true
        },
        "severity":{
            "$ref":"#/components/schemas/Severity"
        },
        "canBeManuallyClosed":{
            "type":"boolean",
            "description":"Can a user clear this event?",
            "example":true,
            "default":false
        },
        "associatedIncidentId":{
            "type":"string",
            "description":"ID of the associated incident",
            "format":"raw",
            "readOnly":true,
            "example":"C4E214A1172A2F19E053860E4B645AC7"
        },
        "links":{
            "required":[
                "self"
            ],
            "type":"object",
            "properties":{
                "self":{
                    "$ref":"#/components/schemas/Link"
                }
            },
            "description":"URL links inside details of resource.",
            "readOnly":true,
            "example":{
                "self":{
                    "href":"/em/api/events/C4E06BD206B62AB3E053860E4B64C911"
                }
            }
        }
    },
    "description":"Summary of an event"
}

Nested Schema : links

Type: object

Read Only: true

URL links inside details of resource.

Show Source

• self(required): object Link
  Represents a link(could be self, previous or next)

{
    "required":[
        "self"
    ],
    "type":"object",
    "properties":{
        "self":{
            "$ref":"#/components/schemas/Link"
        }
    },
    "description":"URL links inside details of resource.",
    "readOnly":true,
    "example":{
        "self":{
            "href":"/em/api/events/C4E06BD206B62AB3E053860E4B64C911"
        }
    }
}

Example:

{
    "self":{
        "href":"/em/api/events/C4E06BD206B62AB3E053860E4B64C911"
    }
}

Nested Schema : nonTargetEntities

Type: array

Minimum Number of Items: 0

Unique Items Required: true

Entities other than targets which are affected by this event

Show Source

• Array of: object SourceEntity
  Details of an source entity

{
    "minItems":0,
    "uniqueItems":true,
    "type":"array",
    "description":"Entities other than targets which are affected by this event",
    "items":{
        "$ref":"#/components/schemas/SourceEntity"
    }
}

Nested Schema : targets

Type: array

Minimum Number of Items: 0

Unique Items Required: true

Targets affected by this incident

Show Source

• Array of: object schema
  Target details

{
    "minItems":0,
    "uniqueItems":true,
    "type":"array",
    "description":"Targets affected by this incident",
    "items":{
        "$ref":"#/components/schemas/Target"
    }
}

Nested Schema : Link

Type: object

Represents a link(could be self, previous or next)

Show Source

• href: string
  URL for Link

  Example: /em/api/<resources>?page=b2Zmc2V0OjA&limit=0

{
    "type":"object",
    "description":"Represents a link(could be self, previous or next)",
    "properties":{
        "href":{
            "type":"string",
            "description":"URL for Link",
            "example":"/em/api/<resources>?page=b2Zmc2V0OjA&limit=0"
        }
    }
}

Nested Schema : SourceEntity

Type: object

Details of an source entity

Show Source

• id(required): string (raw)
  ID of the entity

  Example: 317C6AD6C69832D0ADDA279BEB7B7F32
• name(required): string
  Name of the entity

  Example: bkupjob-123456
• subTypeDisplayName: string
  Display name for sub type for an entity type

  Example: Database backup job
• subTypeName: string
  Sub type for an entity type

  Example: DBBackupJob
• typeDisplayName: string
  Display name for the entity type

  Example: Job
• typeName(required): string
  Type of the entity

  Example: JOB

{
    "required":[
        "id",
        "name",
        "typeName"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"ID of the entity",
            "format":"raw",
            "example":"317C6AD6C69832D0ADDA279BEB7B7F32"
        },
        "name":{
            "type":"string",
            "description":"Name of the entity",
            "example":"bkupjob-123456"
        },
        "typeName":{
            "type":"string",
            "description":"Type of the entity",
            "example":"JOB"
        },
        "typeDisplayName":{
            "type":"string",
            "description":"Display name for the entity type",
            "example":"Job"
        },
        "subTypeName":{
            "type":"string",
            "description":"Sub type for an entity type",
            "example":"DBBackupJob"
        },
        "subTypeDisplayName":{
            "type":"string",
            "description":"Display name for sub type for an entity type",
            "example":"Database backup job"
        }
    },
    "description":"Details of an source entity"
}

Nested Schema : schema

Type: object

Target details

Show Source

• targetName: string
  Name of the target

  Example: sales_db1
• targetType: string
  Type of the target

  Example: oracle_database

{
    "description":"Target details",
    "type":"object",
    "properties":{
        "targetName":{
            "description":"Name of the target",
            "type":"string",
            "example":"sales_db1"
        },
        "targetType":{
            "description":"Type of the target",
            "type":"string",
            "example":"oracle_database"
        }
    }
}

400 Response

Bad Request

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

401 Response

Unauthorized

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

404 Response

Not Found

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

500 Response

Internal Server Error

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

503 Response

Service Unavailable

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

Back to Top