v51

latestOpenAPI 3.0.2raw.githubusercontent.com2026-08-01245104440.0 KB

Data Collection

Update data collection item

Apply a JSON merge-patch to an existing data collection item: only the properties present in the request body are changed. The thresholds array (and, for table DCIs, the columns array), when present, replaces the whole set; existing thresholds are matched by id so their runtime state is preserved. The type property, if supplied, must match the existing DCI type - it cannot be changed.

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

Path parameters

object-idinteger required

Object ID

dci-idinteger required

Data collection item ID

Request body

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' | '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

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

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

Response

Data collection item updated

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' | '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

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

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