Retrieve detailed software information for a computer

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 detailed information about software installed on a specific managed computer. Supports filtering by license type, access type, compliance status, and OS compatibility. Supports pagination and search.

Request URL

https://{serverurl}/dcapi/inventory/computers/{resourceID}/softwareInfo

Scope

DesktopCentralCloud.Inventory.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

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

- Path Parameters

resourceIDstringMandatory

Resource identifier of the computer. Obtain from the response of the Get Computers List API.

- Query Parameters

licensetypefilterintegerOptional

1 - Commercial, 2 - Non-commercial, 0 - Unidentified

accesstypefilterintegerOptional

1 - Allowed, 2 - Prohibited, 0 - Not assigned

compliancestatusfilterintegerOptional

0 - Under licensed, 1 - Over licensed, 2 - In compliance, 3 - Expired, -1 - Not available

oscompatibilityfilterstringOptional

32-bit, 64-bit, or Neutral

offsetintegerOptional

Pagination offset

limitintegerOptional

Page size limit

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomains/dcapi/inventory/computers/{resourceID}/softwareInfo \
  --header 'Accept: application/softwareInfo.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
metadataJSON Object

Pagination metadata including offset, limit, totalPages, and totalCount

Show Sub-Attributes
dataarray

Array of software detail objects with fields such as invsw.software_id, invsw.software_name, invsw.software_version, invmanufacturer.manufacturer_name, invswinstalled.installed_date, invswextn.architecture, invsw.installed_format, invswinstalled.location, invswcategory.sw_category_name, invswlicenseusage.compliant_status, invsw.is_usage_prohibited, invsw.sw_type, invsw.sw_family, and related fields

linksJSON Object

Pagination links with next and prev URLs

Show Sub-Attributes
statusstring

Response status - success

- HTTP code 401

Response Body - application/json
JSON Object
Hide Sub-Attributes
error_codestring

UAC_UNAUTHORIZED - user lacks the required uem-roles or credentials are missing

error_descriptionstring

Authentication or authorization failure reason

- HTTP code 404

Response Body - application/json
JSON Object
Hide Sub-Attributes
error_codestring

RESOURCE_NOT_AVAILABLE - the specified resourceID does not exist or is not accessible

error_descriptionstring

Resource not found message

- 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
401HTTP code
404HTTP code
500HTTP code

Sample Response: HTTP 200

Software list with pagination

Copied!
  {
    "metadata": {
      "offset": 1,
      "limit": 1,
      "totalPages": 36,
      "totalCount": 36
    },
    "data": [
      {
        "invswinstalled.app_installed_by": 0,
        "invswinstalled.uninstall_remarks": "--",
        "invswtoosrel.app_identifier": "5B860485-0F07-41DC-BA8C-3A839A141FBA",
        "invswextn.architecture": "32-bit",
        "invsw.comments": "--",
        "invmanagedsw.managed_sw_id": 1,
        "invswinstalled.installed_date": "1772700015000",
        "invsw.software_id": 1,
        "invmanagedsw.software_id": 1,
        "invswcategory.sw_category_name": "--",
        "invswinstalled.installed_users_login": "-",
        "invswinstalledtouserrel.user_component_id": "--",
        "invswinstalled.uninstall_status": "--",
        "invsw.detected_time": "1778751155506",
        "invswlicenseusage.remaining_copies": "--",
        "invswinstalledtouserrel.sw_installed_id": "--",
        "invsw.software_version": "13.2.5026.0",
        "invsw.manufacturer_id": 14,
        "invsw.installed_format": "MSI",
        "invswlicense.total_copies": "--",
        "invsystemusers.name": "--",
        "invswlicense.license_owner": "--",
        "invmanufacturer.manufacturer_name": "Sample Manufacturer",
        "invsw.sw_type": 0,
        "invsystemusers.domain": "--",
        "invsw.sw_family": 1,
        "invswinstalled.location": "--",
        "invswbinarysummary.binaries_count": "--",
        "invsw.is_usage_prohibited": 0,
        "invswlicenseusage.compliant_status": "--",
        "invsw.software_name": "Sample Software",
        "invswinstalled.component_id": 34
      }
    ],
    "links": {
      "next": "/dcapi/inventory/computers/301/softwareInfo?offset=2&limit=1",
      "prev": null
    },
    "status": "success"
  }
                
Show full

Sample Response: HTTP 401

Missing credentials

Copied!
  {
    "error_description": "Unauthorized access",
    "error_code": "UAC_UNAUTHORIZED"
  }
                
Show full

Sample Response: HTTP 404

Resource not found

Copied!
  {
    "error_description": "The specified resource was not found",
    "error_code": "RESOURCE_NOT_AVAILABLE"
  }
                
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.