Retrieve aggregated inventory summary

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 an aggregated summary of all inventory data including software, hardware, and computer counts across the managed environment.

Endpoints

Request URL

https://{server-hostname}:8383/dcapi/inventory/allsummary

Scope

Inventory.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

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

Sample Request

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

Response Parameters

- HTTP code 200

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

Scan audit summary with counts of successful, failed, and not-scanned computers

Show Sub-Attributes
software_compliance_summaryJSON Object

Software license compliance summary with counts by status

Show Sub-Attributes
warranty_summaryJSON Object

Warranty status summary with counts of compliant, expired, and unidentified

Show Sub-Attributes
computer_by_osJSON Object

Computer count grouped by operating system name

Show Sub-Attributes
software_summaryJSON Object

Software summary with total, prohibited, commercial, and non-commercial counts

Show Sub-Attributes

- HTTP code 400

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

CUSTOMER_HEADER_MISSING - MSP environment requires X-Customer header

error_descriptionstring

Missing customer header error message

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

Sample Response: HTTP 200

Aggregated summary

Copied!
  {
    "audit_summary": {
      "not_scanned": "0",
      "scan_failed": "0",
      "scan_success": "1"
    },
    "software_summary": {
      "commercial_software": "0",
      "total_software": "36",
      "prohibited_software": "0",
      "non_commercial_software": "0"
    },
    "software_compliance_summary": {
      "expired_license": "0",
      "over_licensed": "0",
      "under_licensed": "0",
      "license_in_compliance": "0"
    },
    "computer_by_os": {
      "Windows 11": "1"
    },
    "warranty_summary": {
      "unidentified": "0",
      "expired_warranty": "1",
      "warranty_in_compliance": "0"
    }
  }
                
Show full

Sample Response: HTTP 400

MSP header missing

Copied!
  {
    "error_description": "dc.rest.customer_header.missing",
    "error_code": "CUSTOMER_HEADER_MISSING"
  }
                
Show full

Sample Response: HTTP 401

Missing credentials

Copied!
  {
    "error_description": "Unauthorized access",
    "error_code": "UAC_UNAUTHORIZED"
  }
                
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.