Fetch custom report details for the specified report ID

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 the full details of a specific custom report by its ID. Returns all configuration details including report name, description, sub-module, selected columns, criteria, grouping, and chart metadata.

Request URL

https://{server-hostname}:8383/dcapi/reports/customReports/v2/{reportId}

Scope

CustomReport.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

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

- Path Parameters

reportIdstringMandatory

The unique id of the created custom report

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomain/dcapi/reports/customReports/v2/{reportId} \
  --header 'Accept: application/selectedCustomReport.v2+json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'
Show full

Response Parameters

- HTTP code 200

Response Body - application/json
JSON object
Hide Sub-Attributes
reportNamestring

Display name of the custom report (suffixed with _copy when saveAsNew=true)

reportDescstring

Description of the custom report

subModulestring

Sub-module name (e.g., Computer, Hardware, Software)

criteriaJSON array

Array of filter criteria objects applied to the report

Show Sub-Attributes
JSON object
Show Sub-Attributes
columnIDlong

Column ID the criteria is applied on

searchValuearray

Array of search values for the criteria

comparatorstring

Comparison operator used (e.g., contains, equal, greater than)

logicalOperatorstring

Logical operator (AND or OR) for combining with previous criteria

criteriaPatternstring

Criteria pattern expression (e.g., (1 AND 2) OR 3). Empty string if not set

editableboolean

Whether the current user can edit this report

componentTypestring

Type of report component: Table or Chart

selectComponentsJSON array

Array of selected column objects for table reports. Present only when componentType is Table

Show Sub-Attributes
JSON object
Show Sub-Attributes
columnIDlong

Column ID from the available columns API. Fetch from Get Available Columns

columnNamestring

Display name of the column

aggregationstring

Aggregation method applied: SUM, AVG, COUNT, MIN, MAX, STRING_AGG, JSON_AGG, or ACTUAL_VALUE. Defaults to ACTUAL_VALUE if not set

groupbyarray

Array of column IDs used for grouping. Present only when componentType is Table

chartMetaJSON object

Chart configuration object. Present only when componentType is Chart

Show Sub-Attributes
chartTypestring

Chart type identifier (e.g., bar, pie, line, area, dial, pyramid, funnel). Fetch types from Get Available Charts

xAxisJSON object

X-axis column configuration

Show Sub-Attributes
columnIDstring

Column ID for the axis. Fetch from Get Available Columns

yAxisJSON object

Y-axis column configuration with aggregation

Show Sub-Attributes
columnIDstring

Column ID for the axis. Fetch from Get Available Columns

aggregationstring

Aggregation method for the axis (cannot be ACTUAL_VALUE). Values: SUM, AVG, COUNT, MIN, MAX, STRING_AGG, JSON_AGG

zAxisJSON object

Z-axis column configuration (optional, for bubble/scatter charts)

Show Sub-Attributes
columnIDstring

Column ID for the axis. Fetch from Get Available Columns

aggregationstring

Aggregation method for the axis (cannot be ACTUAL_VALUE). Values: SUM, AVG, COUNT, MIN, MAX, STRING_AGG, JSON_AGG

isReportCountExceededboolean

Whether the report exceeds the configured column or criteria limits

- HTTP code 400

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

Numeric error code: report ID not found or user is not authorized to access the report

errorMessagestring

Detailed error description indicating the specific failure

- HTTP code 401

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

Unauthorized error code returned when authentication credentials are missing, expired, or invalid (authentication=required)

errorMsgstring

Authentication failure reason

- HTTP code 403

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

Forbidden error code returned when the authenticated user does not have the required uem-roles (e.g., DataEncryption_Admin or DataEncryptionRecoveryKey_Admin)

errorMsgstring

Message indicating insufficient privileges to access this resource

- HTTP code 417

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

Expectation failed error code: Custom Report V2 is not enabled

errorMessagestring

Message indicating Custom Report V2 feature is not active

- HTTP code 429

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

Rate limit error code returned when the API call threshold (configured via threshold/duration in security XML) is exceeded; client is locked out for lock-period minutes

errorMsgstring

Rate limit exceeded message with retry guidance

Possible Response Codes

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

Sample Response: HTTP 200

Full details of a table-based custom report

Copied!
  {
    "componentType": "Table",
    "reportDesc": "List of all active computers with OS details",
    "reportName": "Active Computers Report",
    "subModule": "Computer",
    "criteria": [
      {
        "comparator": "contains",
        "logicalOperator": "AND",
        "columnID": 103,
        "searchValue": [
          "Windows"
        ]
      }
    ],
    "editable": true,
    "selectComponents": [
      {
        "columnID": 101,
        "aggregation": "ACTUAL_VALUE",
        "columnName": "Computer Name"
      },
      {
        "columnID": 102,
        "aggregation": "ACTUAL_VALUE",
        "columnName": "IP Address"
      },
      {
        "columnID": 105,
        "aggregation": "COUNT",
        "columnName": "Total Memory (MB)"
      }
    ],
    "groupby": [
      101
    ],
    "isReportCountExceeded": false,
    "chartMeta": null,
    "criteriaPattern": "1"
  }
                
Show full

Full details of a chart-based custom report

Copied!
  {
    "componentType": "Chart",
    "reportDesc": "",
    "reportName": "OS Distribution Chart",
    "subModule": "Computer",
    "criteria": [],
    "editable": true,
    "selectComponents": null,
    "groupby": null,
    "isReportCountExceeded": false,
    "chartMeta": {
      "yAxis": {
        "columnID": "101",
        "aggregation": "COUNT"
      },
      "xAxis": {
        "columnID": "103"
      },
      "chartType": "pie",
      "zAxis": null
    },
    "criteriaPattern": ""
  }
                
Show full

Sample Response: HTTP 400

Report ID not found or user not authorized

Copied!
  {
    "errorMessage": "Unauthorized to access this custom report",
    "errorCode": 40001
  }
                
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 417

Custom Report V2 is not enabled

Copied!
  {
    "errorMessage": "Custom Report V2 is not enabled",
    "errorCode": "417"
  }
                
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.