API Guide

The HTTP GET method is used to retrieve a resource. The service ignores the content of the body on a GET. The GET operation is
unchanged in the absence of external changes to the resource.
HEAD
All URLs support the HEAD method. This method returns the response headers.
POST
Use the POST method to invoke actions and create a resource. The POST request is submitted to the resource collection to which the
new resource belongs. Submitting a POST request to a resource that represents a collection is equivalent to submitting the request to the
Members property of that resource. Services that support adding members to a collection support both forms.
Services support the POST method for creating resources. If the resource does not support this method, status code 405 is returned. The
body of the create request contains a representation of the object to be created. The service can ignore any service-controlled properties
such as ID, forcing those properties for the service to be overridden. The service sets the Location header to the URI of the newly created
resource.
PUT
Use the PUT method to replace the property values of a resource. Properties omitted from the request body are reset to their default
value. Services support the PUT method to replace a resource completely. If a service does not support this method, status code 405 is
returned. Services may return a representation of the resource after any server-side transformations occur in the body of the response.
The PUT operation must be unchanged in the absence of external changes to the resource. The exception is that the ETag values may
change as a result of this operation.
PATCH
Use the PATCH method to update pre-existing resources. Changes to the resource are sent in the request body. This method does not
change the properties that are not specified in the request body. The response is either empty or a representation of the resource after
the update is done, or a success code if the operation is successful. Depending on the policies, the implementation may reject the update
operation on certain fields and not apply any of the requested updates.
NOTE:
Starting from iDRAC version 3.15.15.15 release, you can use the PATCH method with up to 50 attributes at a
time.
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 metadata—application/json;charset=utf-8
• OData responses—application/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.
14 Redfish-based systems management