NEnetxms
Data Collection

Get data collection item definition

Changed on

Retrieve the definition of a single data collection item.

Requires OBJECT_ACCESS_READ and OBJECT_ACCESS_READ_DC_CONFIG on the object.

get/v1/objects/{object-id}/data-collection/configuration/{dci-id}

Request

  • Base URL
    http://127.0.0.1:8000
  • URL
    http://127.0.0.1:8000/v1/objects/{object-id}/data-collection/configuration/{dci-id}
  • Auth
    HTTP bearer

Path parameters

object-idinteger required

Object ID

dci-idinteger required

Data collection item ID

Response

DCI definition retrieved successfully

idinteger

DCI ID (assigned by the server)

guidstring uuid

Globally unique DCI identifier

type'item' | 'table'

DCI type. Selected at creation; cannot be changed afterwards.

namestring

Metric/parameter name (required on create)

descriptionstring

Human-readable DCI description

origin'internal' | 'agent' | 'snmp' | 'websvc' | 'push' | 'winperf' | 'smclp' | 'script' | 'ssh' | 'mqtt' | 'driver' | 'modbus' | 'ethernetip' | 'cloud' | 'otlp' | 'trafficobserver' | 'netconf' | 'computed'

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

pollingIntervalstring

Polling interval expression (used when pollingScheduleType is custom)

retentionType'default' | 'custom' | 'none'

Data retention type

retentionTimestring

Retention time expression (used when retentionType is custom)

systemTagstring
userTagstring
commentsstring
transformationScriptstring

NXSL transformation script source

sourceNodeinteger

Source (proxy) node ID, or 0 to disable

snmpPortinteger
snmpVersioninteger
snmpContextstring
snmpAgentNamestring

Name of additional SNMP agent on the node to collect from; empty to use the node's primary SNMP agent. When set, the agent's configuration takes precedence over snmpPort, snmpVersion, and snmpContext.

snmpRawValueType'none' | 'int32' | 'uint32' | 'int64' | 'uint64' | 'double' | 'ipAddr' | 'macAddr' | 'ip6Addr'

SNMP raw value interpretation (single-value DCI only)

multiplierinteger
unitNamestring
mappingTableIdinteger
sampleCountinteger
predictionEnginestring
allThresholdsRearmEventinteger
aiHintstring
aggregationDisabledboolean
hourlyRetentioninteger
dailyRetentioninteger
instanceDiscoveryMethod'none' | 'agentList' | 'agentTable' | 'snmpWalkValues' | 'snmpWalkOids' | 'script' | 'winperf' | 'webService' | 'internalTable' | 'smclpTargets' | 'smclpProperties' | 'push' | 'otlp'
instanceDiscoveryDatastring
instanceFilterstring

NXSL instance filter script source

instanceNamestring
instanceRetentionTimeinteger
perfTabSettingsstring
accessListinteger[]

Per-DCI access list (user/group IDs)

templateIdinteger
templateItemIdinteger

Changes

  • 75f2dedc3fb9Revision changes
    • warning

      added the new agent enum value to the response property for the response status

    • info

      removed the nxagent enum value from the response property for the response status

  • 13e5dc345df1Revision changes
    • info

      added the optional property to the response with the status