Retrieve computers where a specific software is installed by using Query param swID={software_id}

Returns the list of computers that have the specified software installed. Use the query parameter swID to specify the software.

Endpoints

get /dcapi/inventory/viewData/computersBySW

Copy full URL

Request URL

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

Scope

DesktopCentralCloud.Inventory.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory

application/InventoryMobileAPI.v1+jsonCopied!

- Query Parameters

toolIDstringMandatory

Set value as 4202

swIDstringMandatory

Software ID to filter by installed software. Obtain from the response of the Get Installed Software 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.

liveStatusstringOptional

Agent live status. Allowed values: 1 - Live, 2 - Down, 3 - Unknown

architecturestringOptional

OS architecture filter. Allowed values: 32-bit - 32 bit OS, 64-bit - 64 bit OS

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request GET \
  --url 'https://appdomains/dcapi/inventory/viewData/computersBySW?toolID=4202&swID=SOME_STRING_VALUE' \
  --header 'Accept: application/InventoryMobileAPI.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.io.IOException;
import java.net.http.HttpTimeoutException;

public class Main {
  public static void main(String[] args) {

    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("https://appdomains/dcapi/inventory/viewData/computersBySW?toolID=4202&swID=SOME_STRING_VALUE"))
        .header("Accept", "application/InventoryMobileAPI.v1+json")
        .header("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
        .method("GET", HttpRequest.BodyPublishers.noBody())
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

conn = http.client.HTTPSConnection("appdomains")

headers = {
    'Accept': "application/InventoryMobileAPI.v1+json",
    'Authorization': "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52"
    }

conn.request("GET", "/dcapi/inventory/viewData/computersBySW?toolID=4202&swID=SOME_STRING_VALUE", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


    parameters = "toolID=value" + "&" + "swID=value";

    headersMap = Map();
    headersMap.put("Accept", "application/InventoryMobileAPI.v1+json");

    response = invokeUrl
    [
        url: "https://appDomains/dcapi/inventory/viewData/computersBySW" + "?" + parameters
        type: GET
        headers: headersMap
        connection: connection_name
    ]

    info response;

$headers=@{}
$headers.Add("Accept", "application/InventoryMobileAPI.v1+json")
$headers.Add("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomains/dcapi/inventory/viewData/computersBySW?toolID=4202&swID=SOME_STRING_VALUE' -Method GET -Headers $headers

Response Parameters

- HTTP code 200

Response Body - application/json

string

- 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 Response Codes

200HTTP code

500HTTP code

Sample Response: HTTP 200

Computers by installed software

Copied!

  {
    "metadata": {
      "limit": 25,
      "page": 1
    },
    "totalRecords": "1",
    "messageResponse": [
      {
        "resource_name_transform": "sample-computer",
        "model_transform": "Sample Model 7470",
        "installed_date_transform": "Mar 5, 2026",
        "architecture_transform": "32-bit",
        "uninstall_remarks": "--",
        "processor_arch_name": "x64-based PC",
        "uninstall_remarks_transform": "--",
        "sw_usage_type": "dc.common.NOT_KNOWN",
        "branch_office_id": "1",
        "model": "Sample Model 7470",
        "os_name_transform": "Windows 11 Professional Edition (x64)",
        "installed_date": "1772700015000",
        "software_name": "Sample Software",
        "software_version": "13.2.5026.0",
        "domain_netbios_name_transform": "WORKGROUP",
        "computer_resource_id": "301",
        "asset_tag": "-",
        "software_name_transform": "Sample Software",
        "location_transform": "--",
        "branch_office_name_transform": "Local Office",
        "asset_tag_transform": "-",
        "os_platform": "1",
        "agent_logged_on_users": "SampleUser",
        "fqdn_name_transform": "sample-computer.example.com",
        "display_name": "Sample Software",
        "osflavor_id": "0",
        "computer_description": "-",
        "user_name_transform": "--",
        "processor_arch_name_transform": "x64-based PC",
        "no_of_processors": "1",
        "domain": null,
        "computer_status_transform": "Unknown",
        "friendly_name_transform": "sample-computer",
        "computer_description_transform": "-",
        "last_successful_scan": "1778767527524",
        "computer_status_update_time": "1778767500267",
        "no_of_processors_transform": "1",
        "computer_status": "Unknown",
        "branch_office_name": "Local Office",
        "software_version_transform": "13.2.5026.0",
        "processor_architecture": "2",
        "user_name": null,
        "domain_netbios_name": "WORKGROUP",
        "primary_owner_name_transform": "--",
        "user_component_id": null,
        "fqdn_name": "sample-computer.example.com",
        "primary_owner_name": "--",
        "software_id": "1",
        "ip_address_transform": "10.0.0.1",
        "boot_up_state": "Normal boot",
        "mac_address": "00:00:00:00:00:00",
        "architecture": "32-bit",
        "boot_up_state_transform": "Normal boot",
        "domain_transform": "--",
        "friendly_name": "sample-computer",
        "last_successful_scan_transform": "May 14, 2026 07:35 PM",
        "uninstall_status_transform": "--",
        "last_sync_time": "1778828070858",
        "agent_logged_on_users_transform": "SampleUser",
        "ip_address": "10.0.0.1",
        "sw_family": "1",
        "mac_address_transform": "00:00:00:00:00:00",
        "servicetag": "SAMPLE01",
        "total_ram_memory": "17179869184",
        "resource_id": "301",
        "os_name": "Windows 11 Professional Edition (x64)",
        "location": "--",
        "computer_live_status": "1",
        "uninstall_status": "--",
        "resource_name": "sample-computer",
        "customer_id": "1",
        "is_usage_prohibited": "0",
        "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.