Dell Unity™ Family Unisphere® Management REST API Programmer's Guide

PDF

HTTP status codes

Every response to a REST API request includes an HTTP status code in the response header, which indicates whether the request was successful. If requests are unsuccessful (that is, if they return 4nn and 5nn HTTP status codes) the system returns a message entity that describes the problem.

The following table describes the HTTP status codes that apply to the REST API:

Table 1. HTTP status codes in the REST API
Status code	Name	Applies to	Description
200	OK	GET requests and action POST requests with output data	Successful request. For a GET request, the response body contains the requested resource. For an action POST request, the response body contains the output arguments.
201	Created	POST requests for creating resources	Successful request. The response body contains the id attribute and self-link for the new resource.
202	Accepted	Asynchronous POST and DELETE requests	Request is in process. The response body is the job resource instance executing the request.
204	No Content	Action POST requests with no output data and DELETE requests	Successful request. There is no body content in the response.
302	Unauthorized	All requests	Authorization error or timeout when the X-EMC-REST-CLIENT header field is missing or not set to true.
400	Bad Request	GET, POST, and DELETE requests	Request syntax error. The request has a badly formed URI or badly formed parameters, headers, or body content.
401	Unauthorized	All requests	Authorization error or timeout when the X-EMC-REST-CLIENT header field is set to true.
403	Forbidden	GET, POST, and DELETE requests	Not allowed. This is an authentication or authorization failure.
404	Not Found	GET, POST, and DELETE requests	Resource does not exist. This can be caused by: An invalid resource type name for a GET instance request or action POST request. An invalid ID for a specific instance in a GET, POST, or DELETE request. An invalid URI pattern.
405	Method Not Allowed	POST and DELETE requests	Specified resource does not support the request's operation. For example, requesting a DELETE on a hardware resource can cause this error.
406	Not Acceptable	GET, POST, and DELETE requests	Accept headers cannot be satisfied.
409	Conflict	GET, POST, and DELETE requests	Request cannot be completed due to a conflict with the current state of the resource. The response body contains an error message that describes the problem with the request.
422	Unprocessable Entity	POST requests	POST request has semantically invalid content. For example, a range error or inconsistent properties on a POST can cause this error. The response body contains an error message that describes the problem with the request.
500	Internal Server Error	GET, POST, and DELETE requests	Internal error.
503	Service Unavailable	GET, POST, and DELETE requests	The REST service is temporarily unavailable.