POST Add a Hardware Component
You can add details to the hardware tab's component.
note
You can perform CRUD operations for all the components of Computer Hardware and its sub- asset types.
URL: http://{{server-url}}/api/v1/asset/{asset_id}/discoveryComponent
Field Tables
Computer System Fields
Field Name | Description |
---|---|
type (required) | Component type |
domainName | Name of the domain to which the asset belongs to. |
manufacturerName | Name of the manufacturer of the device. |
modelName | Model name of the device. |
systemType | System architecture. |
pcSystemType | Type of system |
uuid | A unique identifier assigned to the device. |
bootUpStatus | The status of bootup process. |
numberOfLogicalProcessors | The number of logical processors. |
numberOfProcessors | The number of processors. |
deviceStatus | The status of device. |
partOfDomain | Whether the device is part of the domain or not. |
userName | The username to whom the device is assigned. |
description | Description of the device. |
computerSystemName | The hostname of the computer device. |
OS Fields
Field Name | Description |
---|---|
type (required) | Component type |
osName | Name of the OS of the device. |
osVersion | Version of the OS. |
architecture | System architecture. |
manufacturerName | Name of the OS manufacturer. |
productKey | The product key. |
licenceKey | The license key. |
activationStatus | The activation status. |
installedDate | Date when the OS was installed. |
displayVersion | OS version. |
buildNo | OS build number. |
BIOS Fields
Field Name | Description |
---|---|
type (required) | Component type. Here it is "Bios". |
biosName | Name of the BIOS of the device. |
description | Description of the BIOS. |
manufacturerName | Name of the BIOS manufacturer. |
releaseDate | The date of BIOS release. |
deviceStatus | The device status. |
version | The BIOS version. |
serialNumber | The serial number of the BIOS. |
smbiosVersion | The system BIOS version number. |
RAM Fields
Field Name | Description |
---|---|
type (required) | Component type. Here it is "Ram". |
serialNumber | The serial number of the RAM. |
manufacturerName | Name of the RAM manufacturer. |
size | Size of the RAM. |
memoryType | The type of memory. |
width | Width of the RAM. |
clockSpeed | The clock speed of RAM. |
bankLocater | RAM location in machine. |
Processor Fields
Field Name | Description |
---|---|
type (required) | Component type. Here it is "Processor". |
processorName | Displays the name of the processor. |
width | Width of the processor. |
manufacturerName | Name of the processor manufacturer. |
coreCount | Displays the number of core supported in the processor. |
l2CacheSize | Displays the cachesize. |
l3CacheSize | Displays the cachesize. |
deviceId | Displays the device ID. |
socketDesignation | Displays the designation of the socket. |
Network Adapter Fields
Field Name | Description |
---|---|
type (required) | Component type. Here it is "Network Adapter". |
manufacturerName | Name of the network adapter manufacturer. |
macAddress | Displays the Mac address. |
description | Describes the network adapter. |
deviceStatus | Displays the status of the device. |
ipAddresses | Displays the list of IP addresses. |
dnsDomain | Displays the domain. |
dnsHostName | Displays the hostname. |
dnsServerSearchOrders | Displays the order in which the DNS servers are searched. |
dhcpEnable | Displays whether DHCP is enabled or not. |
dhcpLeaseObtained | Date and time when the DHCP lease was obtained. |
dhcpLeaseExpires | Date and time when the DHCP lease expires. |
dhcpServer | IP address of the DHCP server. |
defaultIPGateway | IP address of the default gateway. |
ipSubnet | IP address of the subnet. |
connectionStatus | Connection status. |
Motherboard Fields
Field Name | Description |
---|---|
type (required) | Component type. Here it is "Motherboard". |
manufacturerName | Name of the motherboard manufacturer. |
serialNumber | Serial number of the motherboard. |
version | Motherboard version number. |
partNumber | Part number of the motherboard. |
primaryBusType | Primary bus type of the motherboard. |
secondaryBusType | Secondary bus type of the motherboard. |
deviceStatus | Displays the status of the device. |
Physical Disk Fields
Field Name | Description |
---|---|
type (required) | Component type. Here it is "Physical Disk". |
physicalDiskName | Name of the physical disk drive. |
size | Size of the physical disk. |
deviceStatus | Displays the status of the device. |
manufacturerName | Name of the physical disk manufacturer. |
description | Description of the physical disk. |
partitions | Number of partitions in the physical disk. |
mediaType | Name of the media type. |
pnpDeviceId | ID of the plug and play disk. |
interfaceType | Interface type of the physical disk. |
diskModel | Model name of the physical disk. |
serialNumber | Serial number of the physical disk. |
storageDeviceType | Type of storage device. |
Logical Disk Fields
Field Name | Description |
---|---|
type (required) | Component type. Here it is "Logical Disk". |
logicalDiskName | Name of the logical disk drive. |
fileSystemType | Type of the system file. |
driveType | DType of the logical disk drive. |
serialNumber | Serial nuumber of the logical disk. |
deviceStatus | Status of the device. |
size | Size of the logical disk. |
freeSpace | Amount of free space. |
description | Description of the logical disk. |
Monitor Fields
Field Name | Description |
---|---|
type (required) | Component type. Here it is "Monitor". |
manufacturerName | Name of the monitor manufacturer. |
monitorType | Type of monitor. |
size | Size of the monitor. |
deviceStatus | Status of the device. |
serialNumber | Serial number of the monitor. |
pnpDeviceId | ID of the plug and play device. |
screenHeight | Height of the monitor's screen. |
screenWidth | Width of the monitor's screen. |
weekOfManufacture | Week number when the monitor was manufactured. |
yearOfManufacture | Year of the monitor's manufacture. |
description | Description of the monitor. |
Keyboard Fields
Field Name | Description |
---|---|
type (required) | Component type. Here it is "Keyboard". |
keyboardName | Name of the keyboard. |
manufacturerName | Name of the device manufacturer. |
pnpDeviceId | ID of the plug and play device. |
deviceStatus | Status of the device. |
description | Description of the keyboard. |
Pointing Device
Field Name | Description |
---|---|
type (required) | Component type. Here it is "Pointing Device". |
manufacturerName | Name of the device manufacturer. |
numberOfButtons | Number of buttons on the pointing device. |
pointingType | Type of pointing. |
deviceStatus | Status of the device. |
pnpDeviceId | ID of the plug and play device. |
description | Description of the device. |
Shared Folder Fields
Field Name | Description |
---|---|
type (required) | Component type. Here it is "Shared Folder". |
folderName | Name of the shared folder. |
folderPath | Path of the shared folder. |
allowMaximum | Whether maimum limit is to be allowed or not. |
maximumAllowed | Number of maximum allowed users. |
status | Status of the shared folder. |
description | Description of the folder. |
USB Hub Fields
Field Name | Description |
---|---|
type (required) | Component type. Here it is "USB Hub". |
usbHubName | Name of the USB hub. |
usbHubDeviceStatus | Status of the USB hub. |
usbHubDeviceStatusInfo | Information related to the device status of the USB hub. |
usbHubDeviceId | ID of the USB hub device. |
description | Description of the USB hub device. |
USB Controller Fields
Field Name | Description |
---|---|
type (required) | Component type. Here it is "USB Controller". |
usbControllerName | Name of the USB controller. |
usbControllerDeviceStatus | Status of the USB controller. |
usbControllerDeviceStatusInfo | Information related to the device status of the USB controller. |
usbControllerDeviceId | ID of the USB controller device. |
description | Description of the USB controller device. |
manufacturerName | Name of the USB controller device manufacturer. |
Header
Key | Description |
---|---|
Authorization | Bearer {access token obtained after authorization} |
Content-Type | application/json |
Body:
You would be sending a JSON request that will add the details in the respective component of the Hardware tab. Some of the key-value pairs are compulsory, notice the description of each. Here, the RAM details are added.
note
The key-value pair will be based on the selected component.
{
"type": "Ram",
"componentType": "ram_component",
"serialNumber": "00000000",
"manufacturerName": "Hynix",
"size": "8192 MB",
"memoryType": "Unknown",
"width": 64,
"clockSpeed": 3.2E9,
"bankLocater": "DIMM 0"
}
Similarly, you can add details for the other components using the respective field tables.
Example: http://{{server-url}}/api/v1/asset/1/discoveryComponent
Request
curl --location 'http://172.16.11.148/api/v1/asset/1/discoveryComponent'
Response
{
"type": "Ram",
"id": 3,
"assetId": 1,
"componentType": "ram_component",
"serialNumber": "00000000",
"manufacturerName": "Hynix",
"size": "8192 MB",
"memoryType": "Unknown",
"width": 64,
"clockSpeed": 3.2E9,
"bankLocater": "DIMM 0"
}