White Papers
Key integration concepts
11 REST API Guide–OpenManage Essentials
Request headers
The request header represents headers in the client HTTPS request that are used to communicate client
preferences to the service end-point. The service will indicate the supported preference in the response header.
The following table includes a few examples of request headers. For an extensive list of request headers, see
List of HTTP header fields.
Request
Header
Description
Example
Accept
Format of the data that is requested by
the client. This could be one or more
values that are comma-separated.
Accept: application/xml
Accept-
Encoding
Encoding scheme. For example, to
compress data to save bandwidth.
Accept-
Language
Choice of language that can be
requested by the client.
Accept-Language: en
x-dell-api-
version
Version of the API that is requested by
the client.
x-dell-api-version:1.1
Response codes
For synchronous operations, the server returns HTTP response codes 200 or 204 based on the request. For
long-running operations, the server returns a status code of 202 along with a HTTP response header (Location),
corresponding to the URI of the temporary resource that can be used to monitor the operation. The following
table includes a few examples of response codes. For an extensive list of response codes, see List of HTTP
status codes.
Request
Response Code
Success Codes
GET
200 – OK with message body
204 – OK with no message body
206 – OK with partial message body
POST
201 – Resource created (operation complete)
202 – Resource accepted (operation pending)
PUT
202 – Accepted (operation pending)
204 – Success (operation complete)
DELETE
202 – Accepted (operation pending)
204 – Success (operation complete)
Failure Codes
Invalid parameter
400 – Invalid parameter
Authorization
401 – Authorization failure
Permission denied
403 – Permission denied
Not found
404 – Resource not found
Invalid request method
405 – Invalid request method
Internal server error
500 – Internal server error
Service unavailable
503 – Service unavailable