Retrieve hardware detected across managed computers

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 the complete list of hardware detected across all managed computers.

Request URL

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

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 2111

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.

hardwareTypeFilterstringOptional

Hardware type to filter by. Obtain the list of hardware types from the response of the Get Filter Parameters API.

manufacturerFilterstringOptional

Manufacturer name to filter by. Obtain the list of manufacturers from the response of the Get Filter Parameters API.

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url 'https://appdomain/dcapi/inventory/viewData/hardware?toolID=2111' \
  --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 hardware detail objects

Show Sub-Attributes
JSON object
Show Sub-Attributes
managed_installations_transformstring

Managed installations count display value

hardware_name_transformstring

Hardware name display value

installations_transformstring

Installations count display value

hardware_namestring

Hardware component name

installationsstring

Total installations count

hw_type_description_transformstring

Hardware type description display value

manufacturer_namestring

Manufacturer name

hw_type_descriptionstring

Hardware type description

hardware_idstring

Hardware component identifier

manufacturer_name_transformstring

Manufacturer name display value

managed_installationsstring

Managed installations count

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

Hardware view data

Copied!
  {
    "metadata": {
      "limit": 25,
      "page": 1
    },
    "totalRecords": "23",
    "messageResponse": [
      {
        "managed_installations_transform": "1",
        "hardware_name_transform": "Sample Hardware Name",
        "installations_transform": "1",
        "hardware_name": "Sample Hardware",
        "installations": "1",
        "hw_type_description_transform": "Sample Type",
        "manufacturer_name": "Sample Manufacturer",
        "hw_type_description": "Sample Hardware Type",
        "hardware_id": "1",
        "manufacturer_name_transform": "Sample Manufacturer",
        "managed_installations": "1"
      }
    ],
    "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.