Retrieve computers where a hardware component is installed

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

Returns all computers that have the specified hardware component.

Endpoints

Request URL

https://{serverurl}/dcapi/inventory/viewData/computersByHW

Scope

DesktopCentralCloud.Inventory.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/InventoryMobileAPI.v1+jsonapplication/InventoryMobileAPI.v1+jsonCopied!

- Query Parameters

toolIDstringMandatory

Set value as 7773

hwIDstringMandatory

Hardware ID. Obtain from the response of the Get Installed Hardware List API.

domainstringOptional

Domain name to filter computers. Obtain from the response of the Get Computers List API.

branchOfficestringOptional

Branch office ID to filter computers. Obtain it from the response of the Get Remote Office List API.

customGroupstringOptional

Custom group ID to filter computers. Obtain it from the response of the Get Custom Group List API.

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url 'https://appdomain/dcapi/inventory/viewData/computersByHW?toolID=7773&hwID=SOME_STRING_VALUE' \
  --header 'Accept: application/InventoryMobileAPI.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'
▼ Show full

Response Parameters

- HTTP code 200

Response Body - application/json

JSON object
Hide Sub-Attributes
metadataJSON object

Pagination metadata

Show Sub-Attributes
limitstring

Number of items returned per page

pagestring

Current page number in paginated response

totalRecordsstring

Total number of records matching the query

messageResponseJSON array

Array of computer detail objects

Show Sub-Attributes
JSON object
Show Sub-Attributes
resource_name_transformstring

Computer name display value

model_transformstring

Computer model display value

branch_office_idstring

Branch office identifier

product_numberstring

Product number

copiesstring

Number of hardware copies

warranty_expiry_date_transformstring

Warranty expiry date display value

modelstring

Computer model

live_status_resource_idstring

Resource ID for live status lookup

domain_netbios_name_transformstring

Domain NetBIOS name display value

license_status_transformstring

License status display value

asset_tagstring

Asset tag

copies_transformstring

Copies count display value

branch_office_name_transformstring

Branch office name display value

asset_tag_transformstring

Asset tag display value

agent_last_contact_time_transformstring

Agent last contact time display value

agent_logged_on_usersstring

Currently logged-on user

fqdn_name_transformstring

FQDN display value

license_statusstring

License status

computer_descriptionstring

Computer description

no_of_processorsstring

Number of processors

system_typestring

System architecture type

computer_status_transformstring

Computer status display value

friendly_name_transformstring

Friendly name display value

computer_description_transformstring

Computer description display value

product_number_transformstring

Product number display value

computer_status_update_timestring

Computer status update time as epoch timestamp

no_of_processors_transformstring

Processors count display value

computer_statusstring

Computer status

branch_office_namestring

Branch office name

shipping_datestring

Shipping date as epoch timestamp

agent_last_contact_timestring

Agent last contact time as epoch timestamp

domain_netbios_namestring

Domain NetBIOS name

fqdn_namestring

Fully qualified domain name

primary_owner_namestring

Primary owner name

ip_address_transformstring

IP address display value

agent_last_bootup_time_transformstring

Last boot time display value

boot_up_statestring

Boot up state

mac_addressstring

MAC address

warranty_expiry_datestring

Warranty expiry date as epoch timestamp

boot_up_state_transformstring

Boot up state display value

friendly_namestring

Computer friendly name

agent_logged_on_users_transformstring

Logged-on users display value

ip_addressstring

IP address

shipping_date_transformstring

Shipping date display value

system_type_transformstring

System type display value

mac_address_transformstring

MAC address display value

agent_last_bootup_timestring

Last boot time as epoch timestamp

servicetagstring

Service tag

total_ram_memorystring

Total RAM memory in bytes

resource_idstring

Resource identifier

computer_live_statusstring

Computer live status code

resource_namestring

Computer resource name

servicetag_transformstring

Service tag display value

totalPagesstring

Total number of pages

LinksJSON object

Pagination links

Show Sub-Attributes
nextstring

URL to the next page of results, null if last page

prevstring

URL to the previous page of results, null if first page

statusstring

Response status - success

- HTTP code 500

Response Body - application/json

JSON object
Hide Sub-Attributes
error_codestring

INTERNAL_ERROR - unexpected exception in the service layer

error_descriptionstring

Internal server error message

Possible HTTP Status Codes

200HTTP code
500HTTP code

Sample Response: HTTP 200

Computers by hardware

Copied!
  {
    "metadata": {
      "limit": 25,
      "page": 1
    },
    "totalRecords": "1",
    "messageResponse": [
      {
        "resource_name_transform": "sample-computer",
        "model_transform": "Sample Model",
        "branch_office_id": "1",
        "product_number": "--",
        "copies": "1",
        "warranty_expiry_date_transform": "Oct 11, 2024",
        "model": "Sample Model",
        "live_status_resource_id": "301",
        "domain_netbios_name_transform": "WORKGROUP",
        "license_status_transform": "Licensed",
        "asset_tag": "-",
        "copies_transform": "1",
        "branch_office_name_transform": "Local Office",
        "asset_tag_transform": "-",
        "agent_last_contact_time_transform": "May 14, 2026 04:31 PM",
        "agent_logged_on_users": "Administrator",
        "fqdn_name_transform": "SAMPLE-COMPUTER.DOMAIN.COM",
        "license_status": "Licensed",
        "computer_description": "-",
        "no_of_processors": "1",
        "system_type": "x64-based PC",
        "computer_status_transform": "Unknown",
        "friendly_name_transform": "sample-computer",
        "computer_description_transform": "-",
        "product_number_transform": "--",
        "computer_status_update_time": "1778756474127",
        "no_of_processors_transform": "1",
        "computer_status": "Unknown",
        "branch_office_name": "Local Office",
        "shipping_date": "1570714200000",
        "agent_last_contact_time": "1778756473455",
        "domain_netbios_name": "WORKGROUP",
        "fqdn_name": "SAMPLE-COMPUTER.DOMAIN.COM",
        "primary_owner_name": "--",
        "ip_address_transform": "10.0.0.1",
        "agent_last_bootup_time_transform": "Apr 30, 2026 01:20 PM",
        "boot_up_state": "Normal boot",
        "mac_address": "00:00:00:00:00:00",
        "warranty_expiry_date": "1728653399000",
        "boot_up_state_transform": "Normal boot",
        "friendly_name": "sample-computer",
        "agent_logged_on_users_transform": "Administrator",
        "ip_address": "10.0.0.1",
        "shipping_date_transform": "Oct 10, 2019",
        "system_type_transform": "x64-based PC",
        "mac_address_transform": "00:00:00:00:00:00",
        "agent_last_bootup_time": "1777535435000",
        "servicetag": "SAMPLE01",
        "total_ram_memory": "17179869184",
        "resource_id": "301",
        "computer_live_status": "1",
        "resource_name": "sample-computer",
        "servicetag_transform": "SAMPLE01"
      }
    ],
    "totalPages": 1,
    "Links": {
      "next": null,
      "prev": null
    },
    "status": "success"
  }
▼ Show full

Sample Response: HTTP 500

Server error

Copied!
  {
    "error_description": "Internal server error",
    "error_code": "INTERNAL_ERROR"
  }
▼ Show full

Duration: 1 minute | Threshold: 120 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.

© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.