Create a new custom report with table or chart components

Creates a new custom report. Supports either table or chart component types.

Endpoints

post /dcapi/reports/customReports/v2

Copy full URL

Request URL

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

Scope

CustomReport.CREATECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory

application/customReport.v2+jsonCopied!

AcceptstringMandatory

application/savedCustomReport.v2+jsonCopied!

- Request Body

application/json

JSON object

Hide Sub-Attributes

reportNamestringMandatory

Display name of the custom report. Must be unique when saving

reportDescstringOptional

Optional description of the custom report

subModulestringMandatory

Sub-module name (e.g., Computer, Hardware, Software). Fetch from Get Available Columns

criteriaJSON arrayOptional

Array of filter criteria objects for filtering report data

Show Sub-Attributes

JSON object

Show Sub-Attributes

columnIDlongOptional

Column ID the criteria is applied on. Fetch from Get Available Columns

searchValuearrayOptional

Array of search values for the criteria

comparatorstringOptional

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

logicalOperatorstringOptional

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

selectComponentsJSON arrayMandatory

Array of selected column objects for table reports. Each object specifies a column and optional aggregation

Show Sub-Attributes

JSON object

Show Sub-Attributes

columnIDlongMandatory

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

aggregationstringOptional

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

groupbyarrayOptional

Array of column IDs to group by. Required when aggregation is applied

criteriaPatternstringOptional

Custom criteria pattern defining how criteria are combined (e.g., (1 AND 2) OR 3)

componentTypestringMandatory

Type of report component: Table or Chart

chartMetaJSON objectOptional

Chart configuration object. Required when componentType is Chart

Show Sub-Attributes

chartTypestringOptional

Chart type identifier (e.g., bar, pie, line, area, dial, radar, scatter, bubble, stackedBar, wordCloud, pyramid, packedBubble, funnel). Fetch available types from Get Available Charts

xAxisJSON objectOptional

X-axis column configuration

Show Sub-Attributes

columnIDlongOptional

Column ID for the X-axis. Fetch from Get Available Columns

yAxisJSON objectOptional

Y-axis column configuration with aggregation

Show Sub-Attributes

columnIDlongOptional

Column ID for the Y/Z-axis. Fetch from Get Available Columns

aggregationstringOptional

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

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request POST \
  --url https://appdomain/dcapi/reports/customReports/v2 \
  --header 'Accept: application/savedCustomReport.v2+json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/customReport.v2+json' \
  --data '{"componentType":"Table","reportDesc":"List of all active computers with OS details","reportName":"Active Computers Report","subModule":"Computer","selectComponents":[{"columnID":"101"},{"columnID":"102"},{"columnID":"105","aggregation":"COUNT"}],"criteria":[{"comparator":"contains","logicalOperator":"AND","columnID":103,"searchValue":["Windows"]}],"groupby":["101"],"criteriaPattern":"(1)"}'

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.io.IOException;
import java.net.http.HttpTimeoutException;

public class Main {
  public static void main(String[] args) {

    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("https://appdomain/dcapi/reports/customReports/v2"))
        .header("Content-Type", "application/customReport.v2+json")
        .header("Accept", "application/savedCustomReport.v2+json")
        .header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
        .method("POST", HttpRequest.BodyPublishers.ofString("{\"componentType\":\"Table\",\"reportDesc\":\"List of all active computers with OS details\",\"reportName\":\"Active Computers Report\",\"subModule\":\"Computer\",\"selectComponents\":[{\"columnID\":\"101\"},{\"columnID\":\"102\"},{\"columnID\":\"105\",\"aggregation\":\"COUNT\"}],\"criteria\":[{\"comparator\":\"contains\",\"logicalOperator\":\"AND\",\"columnID\":103,\"searchValue\":[\"Windows\"]}],\"groupby\":[\"101\"],\"criteriaPattern\":\"(1)\"}"))
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

conn = http.client.HTTPSConnection("appdomain")

payload = "{\"componentType\":\"Table\",\"reportDesc\":\"List of all active computers with OS details\",\"reportName\":\"Active Computers Report\",\"subModule\":\"Computer\",\"selectComponents\":[{\"columnID\":\"101\"},{\"columnID\":\"102\"},{\"columnID\":\"105\",\"aggregation\":\"COUNT\"}],\"criteria\":[{\"comparator\":\"contains\",\"logicalOperator\":\"AND\",\"columnID\":103,\"searchValue\":[\"Windows\"]}],\"groupby\":[\"101\"],\"criteriaPattern\":\"(1)\"}"

headers = {
    'Content-Type': "application/customReport.v2+json",
    'Accept': "application/savedCustomReport.v2+json",
    'Authorization': " d92d4xxxxxxxxxxxxx15f52"
    }

conn.request("POST", "/dcapi/reports/customReports/v2", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


    headersMap = Map();
    headersMap.put("Content-Type", "application/customReport.v2+json");
    headersMap.put("Accept", "application/savedCustomReport.v2+json");

    data=Map();
    data.put("reportName","value");
    data.put("reportDesc","value");
    data.put("subModule","value");
    data_criteria=List();
    data_criteria_item1=Map();
    data_criteria_item1.put("columnID","1");
    data_criteria_item1_searchValue=List();
    data_criteria_item1.put("searchValue",data_criteria_item1_searchValue);
    data_criteria_item1.put("comparator","value");
    data_criteria_item1.put("logicalOperator","value");
    data_criteria.add(data_criteria_item1);
    data.put("criteria",data_criteria);
    data_selectComponents=List();
    data_selectComponents_item1=Map();
    data_selectComponents_item1.put("columnID","1");
    data_selectComponents_item1.put("aggregation","value");
    data_selectComponents.add(data_selectComponents_item1);
    data.put("selectComponents",data_selectComponents);
    data_groupby=List();
    data.put("groupby",data_groupby);
    data.put("criteriaPattern","value");
    data.put("componentType","value");
    data_chartMeta=Map();
    data_chartMeta.put("chartType","value");
    data_chartMeta_xAxis=Map();
    data_chartMeta_xAxis.put("columnID","1");
    data_chartMeta.put("xAxis",data_chartMeta_xAxis);
    data_chartMeta_yAxis=Map();
    data_chartMeta_yAxis.put("columnID","1");
    data_chartMeta_yAxis.put("aggregation","value");
    data_chartMeta.put("yAxis",data_chartMeta_yAxis);
    data.put("chartMeta",data_chartMeta);

    response = invokeUrl
    [
        url: "https://appDomain/dcapi/reports/customReports/v2"
        type: POST
        headers: headersMap
        body: data
        connection: connection_name
    ]

    info response;

$headers=@{}
$headers.Add("Content-Type", "application/customReport.v2+json")
$headers.Add("Accept", "application/savedCustomReport.v2+json")
$headers.Add("Authorization", " d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/dcapi/reports/customReports/v2' -Method POST -Headers $headers -ContentType 'application/customReport.v2+json' -Body '{"componentType":"Table","reportDesc":"List of all active computers with OS details","reportName":"Active Computers Report","subModule":"Computer","selectComponents":[{"columnID":"101"},{"columnID":"102"},{"columnID":"105","aggregation":"COUNT"}],"criteria":[{"comparator":"contains","logicalOperator":"AND","columnID":103,"searchValue":["Windows"]}],"groupby":["101"],"criteriaPattern":"(1)"}'

▼ Show full

Sample Request Body

Create a table-based custom report with column selection, grouping, and criteria

Copied!

  {
    "componentType": "Table",
    "reportDesc": "List of all active computers with OS details",
    "reportName": "Active Computers Report",
    "subModule": "Computer",
    "selectComponents": [
      {
        "columnID": "101"
      },
      {
        "columnID": "102"
      },
      {
        "columnID": "105",
        "aggregation": "COUNT"
      }
    ],
    "criteria": [
      {
        "comparator": "contains",
        "logicalOperator": "AND",
        "columnID": 103,
        "searchValue": [
          "Windows"
        ]
      }
    ],
    "groupby": [
      "101"
    ],
    "criteriaPattern": "(1)"
  }

▼ Show full

Create a chart-based custom report with pie chart configuration

Copied!

  {
    "componentType": "Chart",
    "reportName": "OS Distribution Chart",
    "subModule": "Computer",
    "chartMeta": {
      "yAxis": {
        "columnID": "101",
        "aggregation": "COUNT"
      },
      "xAxis": {
        "columnID": "103"
      },
      "chartType": "pie"
    }
  }

▼ Show full

Response Parameters

- HTTP code 200

Response Body - application/json

JSON object

Hide Sub-Attributes

reportIdlong

Unique ID of the created/previewed custom report

reportNamestring

Display name of the report

400HTTP code

401HTTP code

403HTTP code

429HTTP code

Sample Response: HTTP 200

Custom report successfully created

Copied!

  {
    "owner": "admin",
    "reportId": 1005,
    "reportName": "Active Computers Report",
    "viewName": "CRVIEW_1711234567890",
    "customerId": 2
  }

▼ Show full

Sample Response: HTTP 400

Report name already exists

Copied!

  {
    "errorMessage": "A custom report with this name already exists",
    "errorCode": 12345
  }

▼ 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: 15 | 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.