API Guide

Table 5. Roles and associated privileges for OME - Modular (continued)
Privilege Roles
ADMINISTRATOR DEVICE_MANAGER VIEWER
ALERT_MANAGEMENT Y N N
AUTO_DEPLOY_MANAGEME
NT
Y N N
FABRIC_MANAGEMENT Y N N
NETWORK_MANAGEMENT Y N N
Resource addressing
Each managed resource must be uniquely addressable using a distinct URI. The URI syntax must be intuitive and should indicate
the relationships with a parent resource.
There are several ways to address specific resources either as instances of specific resource classes or within an associated
parent context.
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 6. 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.
GET <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.
POST <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.
PUT
<BASE_URI>/AccountService/
Accounts('1414')
Key integration concepts 27