Status messages

The status message attributes identify the success or failure of a REST API operation.

POST, PUT, PATCH, and DELETE requests include status-message attributes in the response body to describe the success or failure of the request, using the following JSON structure.

GET requests that are successful (2xx response code) do not include a status-message attributes. GET requests that fail (response codes other than 2xx) include status-message attributes in the response body to describe the failure of the request, using the following JSON structure.

Note

If the server returns multiple messages for a single request, the top-level attributes are used to describe the overall status of the request, and each message is returned in the messages array.RL

Attributes		Type	Description
status		String	Overall status of the request. This can be one of the following values. Informational. The request completed successfully. Warning. The request completed with warnings. Critical. The request failed. In case there are messages in the messages array, then this is the most severe from all the messages.
code		String	Message code (see Event and alert messages)
text		String	Message text that is associated with the message ID
description		String	Additional information to clarify the reason for the message
userAction		String	User actions that can be taken to recover from the error
recoveryURL		String	Link to more information or recovery actions, if available
messages		Array of objects	Information about multiple messages
	status	String	Status of the request. This can be one of the following values. Informational. The request completed successfully. Warning. The request completed with warnings. Critical. The request failed. In case there are messages in the messages array, then this will be the most severe from all the messages.
	code	String	Message ID (see Event and alert messages)
	text	String	Message text that is associated with the message ID
	description	String	Additional information to clarify the reason for the message
	userAction	String	User actions that can be taken to recover from the error
	recoveryURL	String	Link to more information or recovery actions, if available

The following example is returned for a single-message response.

{
   "status": "Informational",
   "code": "FQXXOSE0001I",
   "text": "The request completed successfully.",
   "description": "",
   "userAction": "Information only; no action is required.",
   "recoveryURL": ""
}

The following example is returned for a multi-message response.

{
   "status": "Critical",
   "code": "",
   "text": " There was an error parsing the input.",
   "description": "",
   "userAction": "",
   "recoveryURL": "",
   "messages": [{
      "status": "Critical",
      "code": "FQXDM0558G",
      "text": " A specified attribute is not compatible with the value of another attribute.",
      "description": "The field {1} is not allowed when field {2} has value {3}.",
      "userAction": "Correct the values, and attempt the request again.",
      "recoveryURL": ""
   },
   {
       "status": "Critical",
      "code": "FQXDM0557G",
      "text": "Incompatible fields were specified.",
      "description": "The field {1} is not allowed when field {2} is specified.",
      "userAction": " Correct the values, and attempt the request again.",
      "recoveryURL": ""
  }]
}

Give documentation feedback