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

Filter devices by

model

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

Filter devices by

device type

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

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

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

Data sorting

The console software provides sorting options on certain URIs that return a collection of entities. The sorting options enable the clients to

get sorted results using the Sort operators on certain attributes of the model entity behind the collection. The relevant URI section contain

information about the attributes that support sorting.

<Collection API>?$orderby=<attribute> <asc/desc>

Examples: Get devices sorted in ascending order by Status

/api/DeviceService/Devices?$orderby=Status asc

NOTE: For enumeration of Status, see /api/DeviceService/DeviceStatuses.

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

Data pagination

The console software provides pagination options on certain URIs that return a collection of entities. The pagination options enable the

clients to get paginated results. If a URI supports pagination, the relevant URI sections indicate it.

Examples:

Get 5

to 8

devices from the

Device collection

/api/DeviceService/Devices?$skip=4&$top=4

Get first four

devices from the

Device collection

/api/DeviceService/Devices?$top=4

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

Request headers

The request header represents headers in the client HTTPS request that are used to communicate client-preferences to the service end

point. The service provides the supported preference in the response header.

Key integration concepts