InnerHealthError interface

Implements InnerHealthError class. HealthError object has a list of InnerHealthErrors as child errors. InnerHealthError is used because this will prevent an infinite loop of structures when Hydra tries to auto-generate the contract. We are exposing the related health errors as inner health errors and all API consumers can utilize this in the same fashion as Exception -> InnerException.

Properties

creationTimeUtc

Error creation time (UTC).

customerResolvability

Value indicating whether the health error is customer resolvable.

entityId

ID of the entity.

errorCategory

Category of error.

errorCode

Error code.

errorId

The health error unique id.

errorLevel

Level of error.

errorMessage

Error message.

errorSource

Source of error.

errorType

Type of error.

possibleCauses

Possible causes of error.

recommendedAction

Recommended action to resolve error.

recoveryProviderErrorMessage

DRA error message.

summaryMessage

Summary message of the entity.

Property Details

creationTimeUtc

Error creation time (UTC).

creationTimeUtc?: Date

Property Value

Date

customerResolvability

Value indicating whether the health error is customer resolvable.

customerResolvability?: string

Property Value

string

entityId

ID of the entity.

entityId?: string

Property Value

string

errorCategory

Category of error.

errorCategory?: string

Property Value

string

errorCode

Error code.

errorCode?: string

Property Value

string

errorId

The health error unique id.

errorId?: string

Property Value

string

errorLevel

Level of error.

errorLevel?: string

Property Value

string

errorMessage

Error message.

errorMessage?: string

Property Value

string

errorSource

Source of error.

errorSource?: string

Property Value

string

errorType

Type of error.

errorType?: string

Property Value

string

possibleCauses

Possible causes of error.

possibleCauses?: string

Property Value

string

recommendedAction

Recommended action to resolve error.

recommendedAction?: string

Property Value

string

recoveryProviderErrorMessage

DRA error message.

recoveryProviderErrorMessage?: string

Property Value

string

summaryMessage

Summary message of the entity.

summaryMessage?: string

Property Value

string