Skip to main content

RootApiException

Represents an error generated by the Root API. This error includes additional information such as error codes, payloads, and metadata.

Extends​

  • Error

Properties​

errorCode​

errorCode: ErrorCodeType = ErrorCodeType.Unspecified

The specific error code related to the error.

id?​

optional id?: RootGuid

Optional unique identifier for this error instance.

parentId​

parentId: RootGuid | undefined

Optional identifier for the parent error, if this error is part of a chain.

payload?​

optional payload?: RootGrpcExceptionPayload

The specific payload associated with this error, which can be one of several predefined exception payload types.

whatId​

whatId: RootGuid | undefined

Identifier for what caused the error.

whereId​

whereId: RootGuid | undefined

Identifier for where the error occurred.

whoId?​

optional whoId?: UserGuid

Optional identifier for the entity responsible for the error.