Retrieve computers where a licensed software 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 associated with a given licensed software ID.

Request URL

https://{server-hostname}:8383/dcapi/inventory/viewData/computersByLicSW

Scope

Inventory.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

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

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomain/dcapi/inventory/viewData/computersByLicSW \
  --header 'Accept: application/InventoryMobileAPI.v1+json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'

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

service_packstring

Service pack version

os_name_transformstring

OS name display value

modelstring

Computer model

live_status_resource_idstring

Resource ID for live status lookup

software_namestring

Software name

domain_netbios_name_transformstring

Domain NetBIOS name display value

asset_tagstring

Asset tag

branch_office_name_transformstring

Branch office name display value

asset_tag_transformstring

Asset tag display value

agent_logged_on_usersstring

Currently logged-on user

fqdn_name_transformstring

FQDN display value

computer_descriptionstring

Computer description

manufacturer_name_transformstring

Manufacturer name display value

no_of_processorsstring

Number of processors

system_typestring

System architecture type

os_version_transformstring

OS version display value

computer_status_transformstring

Computer status display value

friendly_name_transformstring

Friendly name display value

computer_description_transformstring

Computer description display value

computer_status_update_timestring

Status update time as epoch timestamp

no_of_processors_transformstring

Processors count display value

computer_statusstring

Computer status

branch_office_namestring

Branch office name

processor_architecturestring

Processor architecture code

license_name_transformstring

License name display value

domain_netbios_namestring

Domain NetBIOS name

primary_owner_name_transformstring

Primary owner display value

fqdn_namestring

Fully qualified domain name

primary_owner_namestring

Primary owner name

license_namestring

License name

ip_address_transformstring

IP address display value

boot_up_statestring

Boot up state

mac_addressstring

MAC address

boot_up_state_transformstring

Boot up state display value

license_details_idstring

License details identifier

friendly_namestring

Computer friendly name

os_versionstring

OS version

agent_logged_on_users_transformstring

Logged-on users display value

manufacturer_namestring

Manufacturer name

ip_addressstring

IP address

service_pack_transformstring

Service pack display value

system_type_transformstring

System type display value

mac_address_transformstring

MAC address display value

servicetagstring

Service tag

total_ram_memorystring

Total RAM memory in bytes

resource_idstring

Resource identifier

os_namestring

Operating system name

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

200HTTP code
500HTTP code

Sample Response: HTTP 200

Computers by licensed software

Copied!
  {
    "metadata": {
      "limit": 25,
      "page": 1
    },
    "totalRecords": "1",
    "messageResponse": [
      {
        "resource_name_transform": "sample-computer",
        "model_transform": "Sample Model T14",
        "branch_office_id": "1",
        "service_pack": "0",
        "os_name_transform": "Windows 11",
        "model": "Sample Model T14",
        "live_status_resource_id": "301",
        "software_name": "Sample Licensed Software",
        "domain_netbios_name_transform": "WORKGROUP",
        "asset_tag": "SAMPLE01",
        "branch_office_name_transform": "Local Office",
        "asset_tag_transform": "SAMPLE01",
        "agent_logged_on_users": "SampleUser",
        "fqdn_name_transform": "sample-computer.example.com",
        "computer_description": "-",
        "manufacturer_name_transform": "Sample Manufacturer",
        "no_of_processors": "1",
        "system_type": "x64-based PC",
        "os_version_transform": "10.0.26200",
        "computer_status_transform": "Unknown",
        "friendly_name_transform": "sample-computer",
        "computer_description_transform": "-",
        "computer_status_update_time": "1778767913704",
        "no_of_processors_transform": "1",
        "computer_status": "Unknown",
        "branch_office_name": "Local Office",
        "processor_architecture": "0",
        "license_name_transform": "SampleLicense_001",
        "domain_netbios_name": "WORKGROUP",
        "primary_owner_name_transform": "--",
        "fqdn_name": "sample-computer.example.com",
        "primary_owner_name": "--",
        "license_name": "SampleLicense_001",
        "ip_address_transform": "10.0.0.1",
        "boot_up_state": "Normal boot",
        "mac_address": "00:00:00:00:00:00",
        "boot_up_state_transform": "Normal boot",
        "license_details_id": "1",
        "friendly_name": "sample-computer",
        "os_version": "10.0.26200",
        "agent_logged_on_users_transform": "SampleUser",
        "manufacturer_name": "Sample Manufacturer",
        "ip_address": "10.0.0.1",
        "service_pack_transform": "0",
        "system_type_transform": "x64-based PC",
        "mac_address_transform": "00:00:00:00:00:00",
        "servicetag": "SAMPLE01",
        "total_ram_memory": "34359738368",
        "resource_id": "301",
        "os_name": "Windows 11",
        "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.