User Manual
ASUS ASMB9-iKVM
4-9
4.2.4 Responses
This section describes about the response headers, Error codes, and response format used
in Redfish v0.3 update.
A. Response Headers
The response messages specified in this document refers to
Redfish 1.0.4 Specification
.
B. Redfish error response
In the case of an error, Redfish REST API responds with an HTTP status code, as defined
by the HTTP 1.1 specification and constrained by additional requirements defined in this
specification.
HTTP Response: status codes alone often do not provide enough information to determine
the error cause. The Redfish REST API returns extended error information as a JSON object
with a single property named error.
Table 4 Error Code Response
Attribute Description
Message ID String indicating a specific error or message (not to be confused with the HTTP status
code). This code can be used to access a detailed message from a message registry.
Message This is the human readable message, if provided. This property shall contain an optional
human readable message.
Message Args An optional array of strings representing the substitution parameter values for the
message. This shall be included in the Response: if a Message ID is specified for a
parameterized message.
Severity An optional string representing the severity of the error.
Resolution An optional string describing recommended action(s) to take to resolve the error.
Related Properties An optional array of JSON Pointers defining the specific properties within a JSON payload
described by the message.
• Common Error Status Codes
The following are the common error codes that are handled in Redfish:
- 404 Not Found
The request specified a URI of a resource that does not exist. This status code is
returned for any of the HTTP Methods namely GET, POST, PATCH, DELETE, PUT.
- 400 Bad Request
The request could not be processed because it contains missing or invalid
information (such as validation error on an input field, a missing required value, and
so on). An extended error shall be returned in the response body, as defined in the
above mentioned table.
This is typically returned with PATCH or POST response involving request
parameters.
E16160_ASMB9-iKVM_UM_V3.indb 9E16160_ASMB9-iKVM_UM_V3.indb 9 1/17/2020 2:29:24 PM1/17/2020 2:29:24 PM