API Guide
Following is the format of a resource URI:
<BASE_URI>/<resource class identifier>/<resource instance identifier>
Following is an example of a resource URI, where 1234 is the unique identifier for the device:
<BASE_URI>/DeviceService/Devices(1234)
Resource operations
Standard HTTP methods are used for creating, retrieving, updating, and deleting resources. The mapping of the HTTP methods to
operational semantics is described in the following table:
Table 3. HTTP methods
HTTP method Description Example
GET Used for retrieving 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.
Retrieve logs with dates only after
2016-11-15 16:35:39.820.
<BASE_URI>/
ApplicationService/
AuditLogs?
$filter=CreatedDate gt
'2016-11-15 16:35:39.820'
POST Used for creating resources or performing
actions.
Create a user session. Payload is not
displayed.
<BASE_URI>/SessionService/
Sessions
PUT Used for updating a specific instance or
create a specific resource instance with a
specific identifier.
Update the user account details. Payload is
not displayed.
<BASE_URI>/AccountService/
Accounts('1414')
DELETE Used for removing a specific resource. If
the resource does not exist, a Success
response is returned.
Delete a specific user account.
<BASE_URI>/AccountService/
Accounts('1414')
When you perform tasks using these methods, they return an HTTP response code. For more information about the response codes, see
Status Code Definitions on the W3.org website. If a method fails, you may also see an Error and Event Message code. You can search for
more details about this code using the Dell QRL app on your mobile device.
Security considerations
For performing update and delete operations, you must be authorized to perform the operations on the resource. If you do not have the
required permission, an Unauthorized error is returned.
Data filtering
The console software provides filtering options on certain URIs that return a collection of entities. Using this feature, the clients can
extract a selected set of records using comparison operators on attributes of the model entity behind the collection. The relevant URI
sections contain the information about the attributes and the operators that support filtering.
<Collection API>?$filter=<attribute> <operator> <value>&<attribute> <operator> <value>
Examples:
12
Key integration concepts