Error Class

The error object.

All required parameters must be populated in order to send to server.

Constructor

Error(*args: Any, **kwargs: Any)

Name	Description
code	str One of a server-defined set of error codes. Required.
message	str A human-readable representation of the error. Required.
target	str The target of the error.
details	list[Error] An array of details about specific errors that led to this reported error.
innererror	InnerError An object containing more specific information than the current object about the error.

as_dict	Return a dict that can be JSONify using json.dump.
clear
copy
get
items
keys
pop
popitem
setdefault
update
values

Return a dict that can be JSONify using json.dump.

as_dict(*, exclude_readonly: bool = False) -> Dict[str, Any]

Name	Description
exclude_readonly	bool Whether to remove the readonly properties. Default value: False

Type	Description
dict	A dict JSON compatible object

clear() -> None

copy() -> Model

get(key: str, default: Any = None) -> Any

Name	Description
key Required
default	Default value: None

items() -> ItemsView[str, Any]

keys() -> KeysView[str]

pop(key: str, default: ~typing.Any = <object object>) -> Any

Name	Description
key Required
default

popitem() -> Tuple[str, Any]

setdefault(key: str, default: ~typing.Any = <object object>) -> Any

Name	Description
key Required
default

update(*args: Any, **kwargs: Any) -> None

values() -> ValuesView[Any]

One of a server-defined set of error codes. Required.

code: str

An array of details about specific errors that led to this reported error.

details: List[_models.Error] | None

An object containing more specific information than the current object about the error.

innererror: _models.InnerError | None

A human-readable representation of the error. Required.

message: str

The target of the error.

target: str | None

Was this page helpful?