Listing Hardware

Base URL

https://{SERVER}/api/?apikey={yourAPIkey}&service=list_all_hardware

Description

Lists all hardware for the given asset.

Parameters

Required parameters

Add required parameters immediately after the base URL.

https://{SERVER}/api/?apikey={yourAPIkey}&service=list_all_hardware&required_parameters={parameter-value}

Parameter	Description	Type	Options	Default
assetid	The assetid must be a valid asset id. To find the assetid you want, use the list_device_asset_details call.	integer	0	0

Parameter

Description

Type

Options

Default

assetid

The assetid must be a valid asset id.

To find the assetid you want, use the list_device_asset_details call.

integer

Optional parameters

Add optional parameters after the required parameters in the base URL.

https://{SERVER}/api/?apikey={yourAPIkey}&service=list_all_hardware&required_parameters={parameter-value}&optional_parameters={parameter-value}

Parameter	Description	Type	Options	Default
describe	Optional. Returns a description of the entered call, the available parameters, an example of its output, and returned fields with descriptions.	boolean	true	0

Determine parameter values

Use the following associated service calls to determine parameter values.

Parameter	Call	URL Format
assetid	list_device_asset_details	https://{SERVER}/api/?apikey={yourAPIkey}&service=list_device_asset_details&deviceid=DEVICEID
deviceid	list_devices_at_client	https://{SERVER}/api/?apikey={yourAPIkey}&service=list_devices_at_client&clientid=CLIENTID&devicetype=server
	list_servers	https://{SERVER}/api/?apikey={yourAPIkey}&service=list_servers&siteid=SITEID
	list_workstations	https://{SERVER}/api/?apikey={yourAPIkey}&service=list_workstations&siteid=SITEID
siteid	list_sites	https://{SERVER}/api/?apikey={yourAPIkey}&service=list_sites&clientid=CLIENTID
clientid	list_clients	https://{SERVER}/api/?apikey={yourAPIkey}&service=list_clients

Examples

List hardware for an asset

https://{SERVER}/api/?apikey={yourAPIkey}&service=list_all_hardware&assetid=ASSETID

Example response

<?xml version="1.0" ?>
<result created="2009-10-01T12:20:26+01:00" host="SERVER" status="OK">
<items>
<hardware>
  <hardwareid>694760</hardwareid>
  <manufacturer>Broadcom</manufacturer>
  <name>Broadcom NetLink (TM) Gigabit Ethernet</name>
  <details>AdapterType=Ethernet 802.3 MACAddress=00:16:58:CC:DD:FF</details>
  <hardware_type>1</hardware_type>
</hardware>
... more <hardware> nodes ...
</items>
</result>

Returned fields

Field	Type	Can Be Empty	Description
hardwareid	integer	no	The unique identifier of the hardware on this asset.
hardware_type	integer	yes	The type of hardware: 1: Network Adapter 2: BIOS 3: Sound device 4: Motherboard 5: Keyboard 6: Pointing device 7: Monitor 8: Video Controller 9: Disk Drive 10: Logical Disk 11: Physical Memory 12: Cache Memory 13: Processor 14: Tape Drive 15: Optical Drive 16: Floppy Disk Drive
manufacturer	string	yes	The manufacturer of the hardware.
name	string	yes	The name of the hardware.
details	text	yes	Any other details of the hardware.