ApiGwError
objectDescription of an error as provided by the API GW to help remediation.
A human-readable explanation specific to this error.
Example:Unauthorized
Error
objectDescription of an error to help remediation.
A human-readable explanation specific to this error.
Example:Unauthorized
Additional information about the error.
Show Child Parameters
ErrorDetail
objectDetailed description of an error to help remediation. It follows RFC 7807 (https://datatracker.ietf.org/doc/html/rfc7807).
A URI reference (RFC3986) that describes the problem type (in the context of the provided API).
Should resolve to a human-readable document.
Default:about:blank
A short, human-readable summary of the problem type in English.
Example:Not Found
The HTTP status code (RFC7231, Section 6) generated by the origin server for this occurrence of the problem.
>= 100<= 599
Example:400
A human-readable explanation specific to this occurrence of the problem.
Example:ISIN 'US012071998' does not exist.
A URI reference (RFC3986) that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
Example:https://www.example.com/books/1234
ParameterLocation
stringThe location of the parameter in question
Allowed values:BODYPATHQUERYHEADER
InvalidParameter
objectDescription of a parameter with invalid value.
Location of the invalid parameter.
Allowed values:BODYPATHQUERYHEADER
Name of the invalid parameter.
The reason why the parameter’s value is invalid.
The invalid value.