ErrorMessage.Details
A single error detail entry describing one part of a failed change history request.
Declaration
object ErrorMessage.DetailsProperties
| Name | Type | Description |
|---|---|---|
code | string | A machine-readable code identifying the specific validation failure. Read-only. |
message | string | A human-readable description of this detail entry. Read-only. |
info | ErrorMessage.Details.Info | Additional structured context for this failure. See ErrorMessage.Details.Info. Read-only. |
Discussion
Each entry in ErrorMessage’s details array narrows down which part of the request caused the failure. Use these entries, together with the top-level message, for diagnostic logging or user-facing error displays. Use the top-level code on ErrorMessage for programmatic error handling.
Example
{
"code": "MISSING_FIELD",
"message": "eventTime must be provided.",
"info": {
"field": "eventTime"
}
}