Fetch all sub-modules along with their available column details

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

Fetches all sub-modules along with their available column details, organized by categories.

Endpoints

Request URL

https://{serverurl}/dcapi/reports/customReports/v2/columns

Scope

DesktopCentralCloud.CustomReport.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/columns.v2+jsonapplication/columns.v2+jsonCopied!

- Query Parameters

componentstringOptional

Component type filter. Valid values: selectColumns (default), criteriaColumns, formulaColumns. Controls which columns are returned based on usage context

subModulestringOptional

Filter columns by a specific sub-module name (Computer, Hardware, Software). If omitted, columns for all sub-modules are returned

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomains/dcapi/reports/customReports/v2/columns \
  --header 'Accept: application/columns.v2+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

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

Default suggested report name (e.g., Custom Report 5)

availableColumnsJSON Array

Array of sub-module objects containing their column categories

Show Sub-Attributes
JSON Object
Show Sub-Attributes
subModuleIdlong

Unique ID of the sub-module

subModuleNamestring

Display name of the sub-module (e.g., Computer, Hardware, Software)

categoriesJSON Array

Array of column categories within the sub-module

Show Sub-Attributes
JSON Object
Show Sub-Attributes
categorystring

Localized display name of the category (e.g., Computer Details, Formula)

columnsJSON Array

Array of column objects in this category

Show Sub-Attributes
JSON Object
Show Sub-Attributes
columnIdlong

Unique column identifier

displayNamestring

Localized display name of the column

dataTypestring

Data type of the column: BIGINT, BOOLEAN, CHAR, DATE, EQUALNOTEQUAL, EQUALONLY, LIKEONLY

aggregateOptionsJSON Array

Available aggregation functions for the column

Show Sub-Attributes
JSON Object
Show Sub-Attributes
aggregationMethodstring

Aggregation method key: SUM, AVG, COUNT, MIN, MAX, STRING_AGG, JSON_AGG, ACTUAL_VALUE

aggMethodDisplayValuestring

Localized display name of the aggregation method

groupableboolean

Whether the column can be used in group-by clause

validationKeystring

Validation key for input values: IP_ADDRESS_VALIDATION, IP_RANGE_VALIDATION, or DEFAULT_VALIDATION

- HTTP code 400

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

Error code: invalid component parameter value

errorMessagestring

Detailed error description indicating the invalid parameter

- HTTP code 401

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

Unauthorized error code: credentials missing, expired, or invalid

errorMsgstring

Authentication failure reason

- HTTP code 403

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

Error code indicating insufficient permissions

errorMsgstring

Message indicating insufficient privileges to access this resource

- HTTP code 429

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

Rate limit error code returned when the API call reached threshold

errorMsgstring

Rate limit exceeded message with retry guidance

Possible Response Codes

200HTTP code
400HTTP code
401HTTP code
403HTTP code
429HTTP code

Sample Response: HTTP 200

All sub-modules with their columns

Copied!
  {
    "reportDefaultName": "Untitled5",
    "availableColumns": [
      {
        "subModuleId": 1,
        "categories": [
          {
            "columns": [
              {
                "columnId": 101,
                "displayName": "Computer Name",
                "dataType": "CHAR",
                "aggregateOptions": [
                  {
                    "aggMethodDisplayValue": "Actual Value",
                    "aggregationMethod": "ACTUAL_VALUE"
                  },
                  {
                    "aggMethodDisplayValue": "Count",
                    "aggregationMethod": "COUNT"
                  }
                ],
                "groupable": true,
                "validationKey": "DEFAULT_VALIDATION"
              },
              {
                "columnId": 102,
                "displayName": "IP Address",
                "dataType": "CHAR",
                "aggregateOptions": [
                  {
                    "aggMethodDisplayValue": "Actual Value",
                    "aggregationMethod": "ACTUAL_VALUE"
                  }
                ],
                "groupable": false,
                "validationKey": "IP_ADDRESS_VALIDATION"
              },
              {
                "columnId": 105,
                "displayName": "Total Memory (MB)",
                "dataType": "BIGINT",
                "aggregateOptions": [
                  {
                    "aggMethodDisplayValue": "Actual Value",
                    "aggregationMethod": "ACTUAL_VALUE"
                  },
                  {
                    "aggMethodDisplayValue": "Sum",
                    "aggregationMethod": "SUM"
                  },
                  {
                    "aggMethodDisplayValue": "Average",
                    "aggregationMethod": "AVG"
                  },
                  {
                    "aggMethodDisplayValue": "Minimum",
                    "aggregationMethod": "MIN"
                  },
                  {
                    "aggMethodDisplayValue": "Maximum",
                    "aggregationMethod": "MAX"
                  }
                ],
                "groupable": true,
                "validationKey": "DEFAULT_VALIDATION"
              }
            ],
            "category": "Computer Details"
          },
          {
            "columns": [
              {
                "columnId": 5001,
                "displayName": "OSCategory",
                "dataType": "CHAR",
                "aggregateOptions": [
                  {
                    "aggMethodDisplayValue": "Count",
                    "aggregationMethod": "COUNT"
                  },
                  {
                    "aggMethodDisplayValue": "String Aggregation",
                    "aggregationMethod": "STRING_AGG"
                  }
                ],
                "groupable": true,
                "validationKey": "DEFAULT_VALIDATION"
              }
            ],
            "category": "Formula"
          }
        ],
        "subModuleName": "Computer"
      }
    ]
  }
▼ Show full

Sample Response: HTTP 400

Invalid component parameter

Copied!
  {
    "errorMessage": "Invalid component parameter value",
    "errorCode": "400"
  }
▼ Show full

Sample Response: HTTP 401

Missing or invalid authentication token

Copied!
  {
    "errorMessage": "Authentication token is missing or invalid",
    "errorCode": "401"
  }
▼ Show full

Sample Response: HTTP 403

User does not have the required role

Copied!
  {
    "errorMessage": "User does not have the required role to access this resource",
    "errorCode": "403"
  }
▼ Show full

Sample Response: HTTP 429

Rate limit exceeded

Copied!
  {
    "errorMessage": "Rate limit exceeded. Please retry after some time",
    "errorCode": "429"
  }
▼ 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.

© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.