Alert interface

Alert class

Extends

Properties

alertType

Type of the alert

appearedAtSourceTime

UTC time at which the alert appeared on the source

appearedAtTime

UTC time at which the alert appeared

clearedAtSourceTime

UTC time at which the alert was cleared on the source

clearedAtTime

UTC time at which the alert got cleared

detailedInformation

Other information about the alert

errorDetails

ErrorDetails of the alert

recommendation

Recommendation for acting on the alert

resolutionReason

Reason for resolving the alert

scope

Device or Resource alert

severity

Severity of the alert

source

Source at which the alert was cleared

status

Current status of the alert

title

Title of the alert

Inherited Properties

id

The identifier. NOTE: This property will not be serialized. It can only be populated by the server.

name

The name. NOTE: This property will not be serialized. It can only be populated by the server.

type

The type. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

alertType

Type of the alert

alertType: string

Property Value

string

appearedAtSourceTime

UTC time at which the alert appeared on the source

appearedAtSourceTime: Date

Property Value

Date

appearedAtTime

UTC time at which the alert appeared

appearedAtTime: Date

Property Value

Date

clearedAtSourceTime

UTC time at which the alert was cleared on the source

clearedAtSourceTime?: Date

Property Value

Date

clearedAtTime

UTC time at which the alert got cleared

clearedAtTime?: Date

Property Value

Date

detailedInformation

Other information about the alert

detailedInformation?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

errorDetails

ErrorDetails of the alert

errorDetails?: AlertErrorDetails

Property Value

recommendation

Recommendation for acting on the alert

recommendation?: string

Property Value

string

resolutionReason

Reason for resolving the alert

resolutionReason?: string

Property Value

string

scope

Device or Resource alert

scope: AlertScope

Property Value

severity

Severity of the alert

severity: AlertSeverity

Property Value

source

Source at which the alert was cleared

source: AlertSource

Property Value

status

Current status of the alert

status: AlertStatus

Property Value

title

Title of the alert

title: string

Property Value

string

Inherited Property Details

id

The identifier. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From BaseModel.id

name

The name. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From BaseModel.name

type

The type. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From BaseModel.type