Query device series information list, Interface uri, Access method – HP Intelligent Management Center Licenses User Manual

Page 71: Interface uri access method, Parameters

Advertising
background image

Query Device Series Information List

Query device series information list based on predefined criteria.

Interface URI

/plat/res/series

Access Method

HTTP

GET

Parameters

Query parameter

Device series name.

seriesName

String type. Wildcards are supported. Optional. No default value.

Vendor name.

vendorName

String type. Wildcard is supported. Optional. No default value.

Only devices managed by iMC can be found.

managedOnly

Boolean type. Optional. The default value is false. If the value is true, only device series managed
by iMC is listed in the query result.

Location of the first returned record in the query result.

start

Integer type. Optional. The default value is 0. If the input parameter is smaller than 0, the parameter
is automatically changed to 0.

Total returned records.

size

Integer type. Optional. The default value is 10. If the input parameter is smaller than 0, the parameter
is automatically changed to 0. If the input parameter is greater than 1000, the parameter is
automatically changed to 1000.

Sort field of the returned result.

orderBy

String type. Optional. The default value is id. Values include id, name, description, and preDefined.

Sort records in descending order.

desc

Boolean type. Optional. The default value is false. It is valid only when the orderBy parameter is
specified.

Only records that match the sort criteria are returned.

total

Boolean type. Optional. The default value is false. When the value is true, the start and size attributes
are invalid, the returned message body is empty, and the Message Header field gives the records
that match the sort criteria.

Query Device Series Information List

71

Advertising