Skip to main content

Status messages

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

Some 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.

Most GET requests that are successful (2xx response code) do not include status-message attributes. Some 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.

AttributesTypeDescription
resultStringResults of the request. This can be one of the following values.
  • success. The request completed successfully.
  • failed. The request failed. A descriptive error message was returned.
  • warning. The request completed with a warning. A descriptive error message was returned.
messagesArray of objectsInformation about one or more messages
 idStringMessage identifier of a returned message
 textStringMessage text associated with the message identifier
 explanationStringAdditional information to clarify the reason for the message
 recoveryArray of objectsRecovery information
  textStringUser actions that can be taken to recover from the event
  URLStringLink to the help system for more information, if available
The following example is returned for a failed REST API request.
{
    "result": "failed",
   "messages": [{
      "id": "FQXHMSS1002J",
      "text": "The request to change the log level of com.apache to ERROR was not successful.",
      "explanation": "The log level requested could not be changed.",
      "recovery": {
         "text": "Please retry the action.",
         "url": ""
      }
   }]
}