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

Page 67: Returned result, Interface uri access method returned result

Advertising
background image

Query Vendor Information List

Query device vendor information list.

Interface URI

/plat/res/vendor

Access Method

HTTP

GET

Parameters

Query parameter

Vendor name.

name

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

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, phone, contact,
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.

Returned Result

Status codes

200 (OK): Success.

Message header

If the total parameter is true, the Total field gives all the records that match the sort criteria. No
message body is included.

HTTP/1.1 200 OK
Total: 17

Query Vendor Information List

67

Advertising