Retrieves available values for a dynamic custom group criteria column

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 distinct values for the specified criteria column. Use the returned values in the criteriaList[].criteriaValue array when calling Create Dynamic CG or Update Dynamic CG. Fetch valid columnId values from Get Dynamic CG Criteria Pattern. Supports pagination via rangeIndex/limit and text filtering via searchChar. For software version columns, filter by software name using softwareNameForVersion.

Request URL

https://{serverurl}/api/1.4/customgroup/dynamic/columnValues

Scope

DesktopCentralCloud.Common.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/jsonapplication/jsonCopied!

Must be application/json. Only JSON responses are supported.

- Query Parameters

columnIdlongMandatory

ID of the criteria column whose values to retrieve. Fetch from Get Dynamic CG Criteria Pattern. Column IDs are instance-specific auto-generated values.

softwareNameForVersionstringOptional

Software name to filter version values. Used when columnId refers to a software version column.

searchCharstringOptional

Text filter applied to column values. Only values containing this string are returned.

rangeIndexstringOptional

Pagination start index (1-based). Default: 1

limitstringOptional

Maximum number of values to return per page. Default: 30

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url 'https://appdomain/api/1.4/customgroup/dynamic/columnValues?columnId=SOME_INTEGER_VALUE' \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'
Show full

Response Parameters

- HTTP code 200

Response Body - application/json


JSON object
Hide Sub-Attributes
message_typestring

Always 'dynamic' for this endpoint.

message_responseJSON object

Response payload container.

Show Sub-Attributes
dynamicJSON object

Response payload.

Show Sub-Attributes
*JSON object

Sequential-integer-keyed map ('0', '1', '2', …). Empty object {} when no values match.

Show Sub-Attributes
labelstring

Display text for the criteria value dropdown.

valuestring

Actual value to use in criteriaValue array when calling Create Dynamic CG or Update Dynamic CG.

message_versionstring

API version: '1.4'.

statusstring

'success' when the request completed without errors.

- HTTP code 500

Response Body - application/json


JSON object
Hide Sub-Attributes
message_typestring

Always 'dynamic' for this endpoint.

message_versionstring

API version: '1.4'.

statusstring

Always 'error' for error responses.

error_codestring

Internal error code: '1003' (INTERNAL_ERROR).

error_descriptionstring

Resolved I18N message, typically: An internal error occurred while processing the request.

Possible Response Codes

200HTTP code
500HTTP code

Sample Response: HTTP 200

OS name values for columnId for OS_NAME (instance-specific).

Copied!
  {
    "message_type": "dynamic",
    "message_response": {
      "dynamic": {
        "0": {
          "label": "Windows 11 Enterprise",
          "value": "Windows 11 Enterprise"
        },
        "1": {
          "label": "Windows 10 Pro",
          "value": "Windows 10 Pro"
        },
        "2": {
          "label": "Windows Server 2022 Standard",
          "value": "Windows Server 2022 Standard"
        },
        "3": {
          "label": "Ubuntu 22.04 LTS",
          "value": "Ubuntu 22.04 LTS"
        }
      }
    },
    "message_version": "1.4",
    "status": "success"
  }
                
Show full

Software version values filtered by softwareNameForVersion=Google Chrome.

Copied!
  {
    "message_type": "dynamic",
    "message_response": {
      "dynamic": {
        "0": {
          "label": "120.0.6099.130",
          "value": "120.0.6099.130"
        },
        "1": {
          "label": "119.0.6045.200",
          "value": "119.0.6045.200"
        }
      }
    },
    "message_version": "1.4",
    "status": "success"
  }
                
Show full

No matching values found for the column and filters.

Copied!
  {
    "message_type": "dynamic",
    "message_response": {
      "dynamic": {}
    },
    "message_version": "1.4",
    "status": "success"
  }
                
Show full

Sample Response: HTTP 500

Unexpected server-side failure retrieving column values.

Copied!
  {
    "error_description": "An internal error occurred while processing the request.",
    "message_type": "dynamic",
    "error_code": "1003",
    "message_version": "1.4",
    "status": "error"
  }
                
Show full

Duration: 1 minute | Threshold: 30 | 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.