Share via


DataverseError Class

Base structured exception for the Dataverse SDK.

Constructor

DataverseError(message: str, code: str, subcode: str | None = None, status_code: int | None = None, details: Dict[str, Any] | None = None, source: str | None = None, is_transient: bool = False)

Parameters

Name Description
message
Required
str

Human-readable error message.

code
Required
str

Error category code (e.g. "validation_error", "http_error").

subcode
str | None

Optional subcategory or specific error identifier.

Default value: None
status_code
int | None

Optional HTTP status code if the error originated from an HTTP response.

Default value: None
details
dict | None

Optional dictionary containing additional diagnostic information.

Default value: None
source
str

Error source, either "client" or "server".

Default value: None
is_transient

Whether the error is potentially transient and may succeed on retry.

Default value: False

Methods

to_dict

Convert the error to a dictionary representation.

to_dict

Convert the error to a dictionary representation.

to_dict() -> Dict[str, Any]

Returns

Type Description

Dictionary containing all error properties.