browse APIv1_beta.21.0

ErrorDetailV3

The type that defines the fields that can be returned in an error.

Types that use ErrorDetailV3

Calls that use ErrorDetailV3

Fields

Field
Type
Description
category
This string value indicates the error category. There are three categories of errors: request errors, application errors, and system errors.
domain
The name of the primary system where the error occurred. This is relevant for application errors.
errorId
A unique code that identifies the particular error or warning that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms.
inputRefIds
array of string
An array of reference IDs that identify the specific request elements most closely associated to the error or warning, if any.
longMessage
A detailed description of the condition that caused the error or warning, and information on what to do to correct the problem.
message
A description of the condition that caused the error or warning.
outputRefIds
array of string
An array of reference IDs that identify the specific response elements most closely associated to the error or warning, if any.
parameters
An array of warning and error messages that return one or more variables contextual information about the error or warning. This is often the field or value that triggered the error or warning.
subdomain
The name of the subdomain in which the error or warning occurred.