HttpError Class

Exception raised for HTTP request failures from the Dataverse Web API.

Constructor

HttpError(message: str, status_code: int, is_transient: bool = False, subcode: str | None = None, service_error_code: str | None = None, correlation_id: str | None = None, client_request_id: str | None = None, service_request_id: str | None = None, traceparent: str | None = None, body_excerpt: str | None = None, retry_after: int | None = None, details: Dict[str, Any] | None = None)

Parameters

Name	Description
message Required	str Human-readable HTTP error message, typically from the API error response.
status_code Required	int HTTP status code (e.g. 400, 404, 500).
is_transient	bool Whether the error is transient (429, 503, 504) and may succeed on retry. Default value: False
subcode	str | None Optional HTTP status category (e.g. "4xx", "5xx"). Default value: None
service_error_code	str | None Optional Dataverse-specific error code from the API response. Default value: None
correlation_id	str | None Optional client-generated correlation ID for tracking requests within an SDK call. Default value: None
client_request_id	str | None Optional client-generated request ID injected into outbound headers. Default value: None
service_request_id	str | None Optional x-ms-service-request-id value returned by Dataverse servers. Default value: None
traceparent	str | None Optional W3C trace context for distributed tracing. Default value: None
body_excerpt	str | None Optional excerpt of the response body for diagnostics. Default value: None
retry_after	int | None Optional number of seconds to wait before retrying (from Retry-After header). Default value: None
details	dict | None Optional additional diagnostic details. Default value: None