API Guide

Table Of Contents
DELETE
Use the DELETE method to remove a resource. Services support the DELETE method for resources that can be deleted. If
the resource cannot be deleted, status code 405 is returned. Services return a representation of the deleted resource in the
response body.
HTTP headers
The server response contains only basic information about related resources. Any metadata that is required to process a request
or response is accessed by using HTTP headers. iDRAC supports the following request headers:
Header Description
If-Match Supported only for AccountService and FirmwareInventory URIs.
If-None-Match Supported only for AccountService, FirmwareInventory, and metadata URIs.
Content-Length Returned on all responses except responses that have Transfer-Encoding: chunked.
Content-Type
Responses other than OData metadataapplication/json;charset=utf-8
OData responsesapplication/xml;charset=utf-8
ETag Supported on AccountService, FirmwareInventory, and metadata URIs.
Location Service sets this header when resources are created or when HTTP requests are redirected to other
resources.
Cache-Control Returned on all responses. Metadata URIs support cached responses. Instrumentation resources cannot
be cached.
X-Auth-Token Used for authentication of user sessions. See Session-based authentication under Redfish
authentication and authorization on page 10.
HTTP status codes and error messages
HTTP defines the status codes that are returned in response messages. When the HTTP status code indicates a failure, the
response body contains an extended error resource, which provides meaningful and deterministic error semantics.
The extended-error information for the Redfish service that Dell has implemented contains error or exception information
that is unique to Dell. This information provides more details and recommendations for error resolution. To learn more about
extended-error information, see the Event and Error Message Reference Guide available at www.dell.com/manuals.
For more details about the error messages, see the following:
Base messages: Registries > BaseMessage schema. Examples of base messages are GeneralError, PropertyUnknown,
InsufficientPrivilege, and so on.
Event and Error messages: Registries > Message schema. Examples of Event and Error messages are AMP0300, ASR0001,
HWC7014, and so on.
For more information about supported status codes and error messages, see the Redfish Scalable Platforms Management API
Specification document available at www.dmtf.org/standards/redfish.
NOTE:
For some URLs, if you execute an unsupported method, the response code may not indicate that the method is
unsupported. To see the methods that the URL supports, see the relevant section in this document. You can also use
the Get method on the URL and see the supported methods in the response.
If you perform a Patch operation on multiple attributes, and if some attributes do not get updated due to dependency
issues, HTTP code 400 is returned.
Redfish-based systems management 13