Reference Guide

Table 3. HTTP status codes in the REST API (continued)
Status
code
Name Applies to Description
The role of the authenticated user does not
have the privilege required to perform the
requested operation.
404
Not Found
All requests
Resource does not exist.
This can be caused by an invalid ID in an
instance URI.
405
Method Not Allowed
All requests
Specified resource does not support the
request's operation.
For example, requesting a DELETE on a
hardware resource can cause this error.
416
Range Not
Satisfiable
GET requests
The specified range of items is invalid.
The value of the Range header or the URL
parameters limit or offset, or both, are
invalid.
422
Unprocessable
Entity
Non-GET requests
Error during execution of the request.
The response body contains an error message
that describes the problem with the request.
Example causes:
● The system is out of space.
● A range error occurred.
● There are inconsistent properties on a POST
or PATCH
500
Internal Server
Error
All requests Internal error.
503
Service
Unavailable
All requests The REST service is temporarily unavailable.
Wait and try the request again.
JSON collection response body
A JSON collection response body occurs in response to a GET collection request that results in a 200 OK or a 206 Partial
Content HTTP status code. For collections with fewer than 100 elements, the response body for a collection contains the
identifier for all instances in the resource type collection. The response is a JSON array of zero or more instances. Each instance
in the response has one or more attribute name-value pairs. The returned name-value pairs are determined by the select URI
parameter, which defaults to the id attribute. You can specify which attributes to return for each instance by using the
select query parameter. You can specify which instances are returned by filtering the data using an attribute expression as a
query parameter.
Example
GET collection response for an event
The following example illustrates the components of a collection resource. It shows a collection resource returned in response to
a GET collection request for the event resource type. In this example, the query returns the id and severity of each event
in the appliance. Spaces outside the quoted strings are used for readability, and are not significant.
REST responses
15