GetPhysicalDiskInformation

(Windows only) Will retrieve the physical disk information on the device.

Syntax

Method ID

#define WAAPI_MID_GET_PHYSICAL_DISK_INFORMATION 30013

JSON Input Structure

{
  "input": {
    "method": 30013
  }
}

Input Properties

This method does not require any additional parameters beyond the method ID.

JSON Output Structure

{
  "result": {
    "method": 30013,
    "code": number,
    "timing": number,
    "timestamp": string,
    "physical_disks": [
      {
        "disk_id": string,
        "friendly_name": string,
        "serial_number": string,
        "manufacturer": string,
        "model": string,
        "media_type": number,
        "bus_type": number,
        "operational_status": [
          number,
          ...
        ],
        "health_status": number,
        "size": number,
        "temperature": number,
        "temperature_max": number,
        "volumes": [
          {
            "volume_id": string,
            "drive_letter": string,
            "operational_status": [
              number,
              ...
            ],
            "health_status": number,
            "size": number,
            "file_system": string
          },
          ...
        ]
      },
      ...
    ]
  }
}

Output Properties

Property	Type	Description
`result.method`	number	The method ID that generated this result.
`result.code`	number	The result code. See Result Codes.
`result.timing`	number	The measured time for the method call in milliseconds.
`result.timestamp`	string	The timestamp in seconds of when the call was made.
`result.physical_disks`	array<object>	List of physical disks detected on the system.
`result.physical_disks.disk_id`	string	Unique identifier for the physical disk.
`result.physical_disks.friendly_name`	string	The name assigned to the physical disk.
`result.physical_disks.serial_number`	string	(optional) Manufacturer-assigned serial number of the physical disk.
`result.physical_disks.manufacturer`	string	(optional) The name of the company responsible for the physical disk's hardware.
`result.physical_disks.model`	string	(optional) Model number of the physical disk.
`result.physical_disks.media_type`	number	(optional) The media type of the physical disk.
`result.physical_disks.bus_type`	number	(optional) The storage bus type of the physical disk.
`result.physical_disks.operational_status`	array<number>	(optional) List of operational status values further explaining a given health status of the physical disk.
`result.physical_disks.health_status`	number	(optional) Health status of the physical disk.
`result.physical_disks.size`	number	(optional) Total capacity of the physical disk in bytes.
`result.physical_disks.temperature`	number	(optional) The current temperature of the physical disk in degrees Celsius.
`result.physical_disks.temperature_max`	number	(optional) The maximum temperature in degrees Celsius at which the physical disk is capable of normal operation.
`result.physical_disks.volumes`	array<object>	(optional) List of volumes residing on the disk.
`result.physical_disks.volumes.volume_id`	string	(optional) Unique identifier for the volume.
`result.physical_disks.volumes.drive_letter`	string	(optional) The volume's assigned drive letter.
`result.physical_disks.volumes.operational_status`	array<number>	(optional) List of operational status values further explaining a given health status of the volume.
`result.physical_disks.volumes.health_status`	number	(optional) Health status of the volume.
`result.physical_disks.volumes.size`	number	(optional) Total capacity of the volume in bytes
`result.physical_disks.volumes.file_system`	string	(optional) The file system format type of the volume.

Result Codes

Code	Name	Description
0	`WAAPI_OK`	The operation completed successfully.

note

Other codes may be returned. See the full Result Codes reference for the complete list.

Remarks

Error Handling

The results of this function are determined by the error code returned by the call. If successful, WAAPI_OK or a special success code will be returned. Always check both the function return value and the result.code field in the output JSON.

Examples

Examples will be added here demonstrating the usage of this method.

Syntax​

Method ID​

JSON Input Structure​

Input Properties​

JSON Output Structure​

Output Properties​

Result Codes​

Remarks​

Error Handling​

Examples​

See Also​