OpenManage Enterprise Version 3.2 and OpenManage Enterprise - Modular Edition Version 1.00.10 RESTful API Guide

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:

Filter devices by system ID

/api/DeviceService/Devices?$filter=SystemId eq 123 /api/DeviceService/Devices?$filter=SystemId eq 123

Filter devices by model

/api/DeviceService/Devices?$filter=Model eq 'PowerEdge MX740c' /api/DeviceService/Devices?$filter=Model eq 'PowerEdge MX740c'

Filter devices by device type

/api/DeviceService/Devices?$filter=Type eq 3000 or Type eq 5000 /api/DeviceService/Devices?$filter=Type eq 3000 or Type eq 5000

NOTE: For enumeration of Type, see /api/DeviceService/DeviceType/api/DeviceService/DeviceType.

For more information about $filter$filter, see OData Version 4.0 Part 1: Protocol at docs.oasis-open.org.