White Papers

REST API Guide  OpenManage Essentials | Revision A02
1.6 Resource operations
The standard HTTP methods are used for performing create, retrieve, update, and delete operations on the
resources. The mapping of the HTTP methods to operational semantics is described in the following table.
HTTP method
Description
Example
GET
Used to retrieve the resource
representation. This method does
not modify the resource across
repeated invocations. The query
parameters are appended to the
URI to appropriately filter the
resource instances.
GET <BASE_URI>/Alerts?Severity=16
To retrieve only critical alerts.
GET
<BASE_URI>/Alerts?Severity=16&Status=2
To retrieve only acknowledged critical alerts.
POST
Used to create a new instance of
a resource or append to the
existing resource reference.
POST <BASE_URI>/Tasks/PowerControl
To create a new power control task.
If the service generates the identifier, the resource
identifier is returned in the Location response
header.
PUT
Used to update a specific instance
or create a specific resource
instance with a specific identifier.
PUT <BASE_URI>/alerts/1234
The entity body has the new state representation.
For example, changing the acknowledge flag to
update the alert.
DELETE
Used to remove a specific
resource. If the resource does not
exist, success is returned.
DELETE <BASE_URI>/Alerts/1234
Deletes a specific alert with an instance identifier
1234.
HEAD
Used to determine if a resource is
present or to return meta-data
corresponding to the resource.
HEAD <BASE_URI>/Alerts
The meta-data information is populated using
custom HTTP response header options. For
example,
X-dell-alerttypes: storage, LC
X-dell-alertURL:/alerts/storage, /alerts/LC
OPTIONS
Used to determine the method-
level support for a specific
resource.
OPTIONS <BASE_URI>/Alerts/1234
The Allow HTTP response header indicates which
methods are permitted.