Retrieve available filter parameters for inventory views

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 the list of available filter parameters including hardware types, hardware manufacturers, software manufacturers, software categories, and OS types that can be used to filter inventory data in various views.

Request URL

https://{serverurl}/dcapi/inventory/filterparams

Scope

DesktopCentralCloud.Inventory.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

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

Sample Request

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

Response Parameters

- HTTP code 200

Response Body - application/json

JSON object
Hide Sub-Attributes
hardware_manufacturer_filter_paramsJSON object

Object containing a params array of hardware manufacturer names

Show Sub-Attributes
software_manufacturer_filter_paramsJSON object

Object containing a params array of software manufacturer names

Show Sub-Attributes
os_filter_paramsJSON object

Object containing a params array of operating system names

Show Sub-Attributes
computer_manufacturer_filter_paramsJSON object

Object containing a params array of computer manufacturer names

Show Sub-Attributes
hardware_type_filter_paramsJSON object

Object containing a params array of hardware type names

Show Sub-Attributes
category_filter_paramsJSON object

Object containing a params array of software category names

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 HTTP Status Codes

200HTTP code
400HTTP code
401HTTP code
500HTTP code

Sample Response: HTTP 200

Available filters

Copied!
  {
    "os_filter_params": {
      "params": [
        "Windows 11",
        "Windows 10"
      ]
    },
    "category_filter_params": {
      "params": [
        "Sample Category A",
        "Sample Category B"
      ]
    },
    "software_manufacturer_filter_params": {
      "params": [
        "Sample SW Manufacturer A",
        "Sample SW Manufacturer B"
      ]
    },
    "hardware_type_filter_params": {
      "params": [
        "Processor",
        "Disk Drive",
        "Network Adapter",
        "Keyboard",
        "Video Controller"
      ]
    },
    "hardware_manufacturer_filter_params": {
      "params": [
        "Sample HW Manufacturer A",
        "Sample HW Manufacturer B",
        "Unknown"
      ]
    },
    "computer_manufacturer_filter_params": {
      "params": [
        "Sample Manufacturer A",
        "Sample Manufacturer B"
      ]
    }
  }
                
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.