inventory APIv1.6.0

ErrorDetailV3

This type is used to express detailed information on errors and warnings that may occur with a call request.

Types that use ErrorDetailV3

Calls that use ErrorDetailV3

Fields

Field
Type
Description
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.
domain
The name of the domain in which the error or warning occurred.
subdomain
The name of the subdomain in which the error or warning occurred.
category
This string value indicates the error category. There are three categories of errors: request errors, application errors, and system errors.
message
A description of the condition that caused the error or warning.
parameters
Various warning and error messages return one or more variables that contain contextual information about the error or waring. This is often the field or value that triggered the error or warning.
longMessage
A detailed description of the condition that caused the error or warning, and information on what to do to correct the problem.
inputRefIds
array of string
An array of one or more reference IDs which identify the specific request element(s) most closely associated to the error or warning, if any.
outputRefIds
array of string
An array of one or more reference IDs which identify the specific response element(s) most closely associated to the error or warning, if any.