---
title: "List data collection item definitions"
method: GET
path: "/v1/objects/{object-id}/data-collection/configuration"
tags: ["Data Collection"]
---

# List data collection item definitions

`GET /v1/objects/{object-id}/data-collection/configuration`

Retrieve the definitions (configuration) of all data collection items (DCIs) configured on
the object. This returns the DCI configuration, not collected values - use the
`current-values` and `history` endpoints for data. Enumerations such as `origin`, `dataType`,
`status` and threshold `function`/`condition` are returned as symbolic names.

## Path parameters

- `object-id` integer, required

## Response `200`

DCI definitions retrieved successfully

- DataCollectionItem[]
  - `id` integer — DCI ID (assigned by the server)
  - `guid` string, uuid — Globally unique DCI identifier
  - `type` 'item' | 'table' — DCI type. Selected at creation; cannot be changed afterwards.
  - `name` string — Metric/parameter name (required on create)
  - `description` string — Human-readable DCI description
  - `origin` 'internal' | 'nxagent' | 'snmp' | 'websvc' | 'push' | 'winperf' | 'smclp' | 'script' | 'ssh' | 'mqtt' | 'driver' | 'modbus' | 'ethernetip' | 'cloud' | 'otlp' — Data origin
  - `status` 'active' | 'disabled' | 'unsupported' — DCI status
  - `dataType` 'int32' | 'uint32' | 'int64' | 'uint64' | 'string' | 'float' | 'null' | 'counter32' | 'counter64' — Data type (single-value DCI only)
  - `transformedDataType` 'int32' | 'uint32' | 'int64' | 'uint64' | 'string' | 'float' | 'null' | 'counter32' | 'counter64' — Data type after transformation (single-value DCI only)
  - `deltaCalculation` 'none' | 'simple' | 'averagePerSecond' | 'averagePerMinute' — Delta calculation method (single-value DCI only)
  - `pollingScheduleType` 'default' | 'custom' | 'advanced' — Polling schedule type
  - `pollingInterval` string — Polling interval expression (used when pollingScheduleType is custom)
  - `retentionType` 'default' | 'custom' | 'none' — Data retention type
  - `retentionTime` string — Retention time expression (used when retentionType is custom)
  - `systemTag` string
  - `userTag` string
  - `comments` string
  - `transformationScript` string — NXSL transformation script source
  - `sourceNode` integer — Source (proxy) node ID, or 0 to disable
  - `snmpPort` integer
  - `snmpVersion` integer
  - `snmpContext` string
  - `snmpRawValueType` 'none' | 'int32' | 'uint32' | 'int64' | 'uint64' | 'double' | 'ipAddr' | 'macAddr' | 'ip6Addr' — SNMP raw value interpretation (single-value DCI only)
  - `multiplier` integer
  - `unitName` string
  - `mappingTableId` integer
  - `sampleCount` integer
  - `predictionEngine` string
  - `allThresholdsRearmEvent` integer
  - `aiHint` string
  - `aggregationDisabled` boolean
  - `hourlyRetention` integer
  - `dailyRetention` integer
  - `instanceDiscoveryMethod` 'none' | 'agentList' | 'agentTable' | 'snmpWalkValues' | 'snmpWalkOids' | 'script' | 'winperf' | 'webService' | 'internalTable' | 'smclpTargets' | 'smclpProperties' | 'push' | 'otlp'
  - `instanceDiscoveryData` string
  - `instanceFilter` string — NXSL instance filter script source
  - `instanceName` string
  - `instanceRetentionTime` integer
  - `perfTabSettings` string
  - `accessList` integer[] — Per-DCI access list (user/group IDs)
  - `thresholds` DciThreshold[] — Thresholds. When present in a request, replaces the whole set.
    - `id` integer — Threshold ID (0 or omitted for a new threshold; supply the existing id to preserve runtime state on update)
    - `activationEvent` string — Event generated when the threshold is reached
    - `deactivationEvent` string — Event generated when the threshold is rearmed
    - `function` 'last' | 'average' | 'meanDeviation' | 'diff' | 'error' | 'sum' | 'script' | 'absoluteDeviation' | 'anomaly'
    - `condition` 'less' | 'lessOrEqual' | 'equal' | 'greaterOrEqual' | 'greater' | 'notEqual' | 'like' | 'notLike' | 'iLike' | 'iNotLike'
    - `value` string
    - `sampleCount` integer
    - `deactivationSampleCount` integer
    - `repeatInterval` integer
    - `regenerateOnValueChange` boolean
    - `disabled` boolean
    - `script` string
  - `columns` DciTableColumn[] — Table columns (table DCI only). When present in a request, replaces the whole set.
    - `name` string
    - `displayName` string
    - `snmpOid` string
    - `dataType` 'int32' | 'uint32' | 'int64' | 'uint64' | 'string' | 'float' | 'null' | 'counter32' | 'counter64'
    - `aggregationFunction` 'last' | 'min' | 'max' | 'average' | 'sum'
    - `instanceColumn` boolean
    - `convertSnmpStringToHex` boolean
  - `templateId` integer
  - `templateItemId` integer

## Other responses

- `400` — Object does not support data collection
- `401` — Unauthorized
- `403` — User does not have read access to given object
- `404` — Object with given ID does not exist

---

[API](https://skmtc.net/netxms/apis/netxms-api.md) · [All operations](https://skmtc.net/netxms/apis/netxms-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/netxms/netxms-api/versions/ee1f54ee3abd/schema)