Error

Error response containing a minor error code, a localized error message, a localized remediation message and optionally a reference token to correlate the error with the logs


Properties

array of string
arguments Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.


array of ErrorCause
causes Optional

The underlying cause exceptions.


map of string
context Optional

The error context (e.g. the component where it occurred).


string
errorCode Optional

The minor error code


string
errorType Optional

The error type


string
message Optional

The localized error message


array of Error
nestedErrors Optional

The nested errors when the error is a composite one


string
referenceToken Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.


string
remediationMessage Optional

The localized remediation error message

JSON Example

{
	"arguments": [
		"string"
	],
	"causes": [
		{
			"message": "string",
			"type": "string"
		}
	],
	"context": {
		"key": "string"
	},
	"errorCode": "string",
	"errorType": "string",
	"message": "string",
	"nestedErrors": "Error Object",
	"referenceToken": "string",
	"remediationMessage": "string"
}

Feedback

Was this page helpful?