API Guide

The returning header will contain the x-auth-token:
connection →Keep-Alive
content-length →268
content-type →application/json; odata.metadata=minimal
date →Tue, 05 Sep 2017 11:55:29 GMT
keep-alive →timeout=5, max=150
location →/api/SessionService/Sessions('e1817fe6-97e5-4ea0-88a9-d865c7302152')
odata-version →4.0
server →Apache
x-auth-token →13bc3f63-9376-44dc-a09f-3a94591a7c5d
x-frame-options →DENY
This x-auth-token will then be used in the header for subsequent REST calls and will be used to authenticate the user.
Resource operations
The standard HTTP methods are used for performing create, retrieve, update, and delete operations on resources. The mapping of the
HTTP methods to operational semantics is described in the following table:
Table 1. Resource operations
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>/ ApplicationService/AuditLogs?
$filter=CreatedDate gt '2016-11-15 16:35:39.820'
To retrieve only logs with dates after'2016-11-15
16:35:39.820' .
POST Used to create a new instance of a
resource or append to the existing
resource reference.
POST <BASE_URI>/SessionService/Sessions
Creates a new user session (Payload is not shown.)
PUT Used to update a specific instance or
create a specific resource instance
with a specific identifier.
PUT <BASE_URI>/AccountService/Accounts('1414')
Updates the user account details (Payload is not shown).
DELETE Used to remove a specific resource. If
the resource does not exist, success
is returned.
DELETE <BASE_URI>/AccountService/Accounts(‘1414’)
Deletes a specific user account with an instance identifier
(‘1234’).
Security considerations
The OpenManage Enterprise REST 'PUT' and 'DELETE' operations require that the user IDs used to run these commands have write
access to the base directory where the OpenManage Enterprise REST services are installed. If the 'write' permission on this directory is
not enabled for the user IDs used to access the DELETE and PUT operations, an error is thrown to indicate that the ID is unauthorized.
Typically, on a default installation, the REST services top level directory is as shown below in the screen shot:
Data filtering and sorting
Data filtering can be accomplished by associating queries with the GET request. In the simplest form, it is a set of parameter name/value
pairs that are appended to the request. The following is an example of data filtering:
<BASE_URI>/ApplicationService/AuditLogs?$filter=CreatedDate gt '2016-11-15 16:35:39.820'
(To get the list of critical acknowledged alerts 16: Critical Severity, 1: Status Acknowledged)
<BASE_URI>/SessionService/Sessions?$orderby='Name' asc
(To get the list of sessions in order by SessionType name in ascending order)
6
Key integration concepts