Retrieve computers associated with a metering rule

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 linked to a specified software metering rule by app definition ID.

Request URL

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

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 7774

appDefIDstringMandatory

App definition ID for the software metering rule. Obtain from the response of the Get Software Metering Rules 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.

Sample Request

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

Show Sub-Attributes
JSON object
Show Sub-Attributes
file_versionstring

File version

resource_name_transformstring

Computer name display value

updated_timestring

Last updated time as epoch timestamp

product_name_transformstring

Product name display value

branch_office_namestring

Branch office name

last_usedstring

Last used time as epoch timestamp

domain_netbios_namestring

Domain NetBIOS name

branch_office_idstring

Branch office identifier

updated_time_transformstring

Updated time display value

fqdn_namestring

Fully qualified domain name

last_used_transformstring

Last used time display value

total_run_time_transformstring

Total run time display value

live_status_resource_idstring

Resource ID for live status lookup

total_run_count_transformstring

Total run count display value

file_version_transformstring

File version display value

domain_netbios_name_transformstring

Domain NetBIOS name display value

product_versionstring

Product version

friendly_namestring

Computer friendly name

total_run_timestring

Total run time in seconds

resource_resource_idstring

Resource resource identifier

fqdn_name_transformstring

FQDN display value

product_version_transformstring

Product version display value

product_namestring

Product name

total_run_countstring

Total run count

app_definition_idstring

App definition identifier

resource_idstring

Resource identifier

computer_live_statusstring

Computer live status code

resource_namestring

Computer resource name

customer_idstring

Customer identifier

friendly_name_transformstring

Friendly name display value

computer_status_update_timestring

Status update time as epoch timestamp

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 metering rule

Copied!
  {
    "metadata": {
      "limit": 25,
      "page": 1
    },
    "totalRecords": "1",
    "messageResponse": [
      {
        "file_version": "",
        "resource_name_transform": "sample-computer",
        "updated_time": "1778827912158",
        "product_name_transform": "Sample App",
        "branch_office_name": "Local Office",
        "last_used": "1778810902000",
        "domain_netbios_name": "WORKGROUP",
        "branch_office_id": "1",
        "updated_time_transform": "May 15, 2026 12:21 PM",
        "fqdn_name": "sample-computer.example.com",
        "last_used_transform": "May 15, 2026 07:38 AM",
        "total_run_time_transform": "03 days, 05 hours, 13 minutes",
        "live_status_resource_id": "301",
        "total_run_count_transform": "598",
        "file_version_transform": "--",
        "domain_netbios_name_transform": "WORKGROUP",
        "product_version": "",
        "friendly_name": "sample-computer",
        "total_run_time": "278024",
        "resource_resource_id": "301",
        "fqdn_name_transform": "sample-computer.example.com",
        "product_version_transform": "--",
        "product_name": "Sample App",
        "total_run_count": "598",
        "app_definition_id": "2",
        "resource_id": "301",
        "computer_live_status": "1",
        "resource_name": "sample-computer",
        "customer_id": "1",
        "friendly_name_transform": "sample-computer",
        "computer_status_update_time": "1778767913704"
      }
    ],
    "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.