Data Collection

Get last collected value of table DCI

Changed on

Retrieve last collected value of a table DCI (Data Collection Item) together with its collection timestamp and current collection status. If no value has been collected yet, both timestamp and table are null. The last collected table is returned even when the DCI currently has collection errors; use errorCount and lastCollectionError to detect that the returned data may be stale.

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

Request

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

Path parameters

object-idinteger required

Object ID

dci-idinteger required

DCI (Data Collection Item) ID

Response

Last collected table value retrieved successfully

idinteger

DCI ID

descriptionstring

DCI description

statusinteger

Current DCI status (0 = active, 1 = disabled, 2 = not supported)

errorCountinteger

Number of consecutive collection errors (0 if last collection attempt was successful)

lastCollectionError'SUCCESS' | 'COMM_ERROR' | 'NOT_SUPPORTED' | 'IGNORE' | 'NO_SUCH_INSTANCE' | 'COLLECTION_ERROR' | 'ACCESS_DENIED' | 'INVALID_DATA' | 'UNKNOWN'

Reason of the last data collection error (SUCCESS if last collection attempt was successful)

noValueboolean

True if DCI does not hold a value of its own (for example, instance discovery source DCI)

timestampstring date-time nullable

Collection timestamp of the returned value (ISO 8601), null if no value collected yet

Changes

    • breaking

      the /////// response's property type changed from integer to string for status

    • warning

      removed the optional property ///// from the response with the status

    • warning

      added the new counter32 enum value to the /////// response property for the response status

    • warning

      added the new counter64 enum value to the /////// response property for the response status

    • warning

      added the new float enum value to the /////// response property for the response status

    • warning

      added the new int32 enum value to the /////// response property for the response status

    • warning

      added the new int64 enum value to the /////// response property for the response status

    • warning

      added the new null enum value to the /////// response property for the response status

    • warning

      added the new string enum value to the /////// response property for the response status

    • warning

      added the new uint32 enum value to the /////// response property for the response status

    • warning

      added the new uint64 enum value to the /////// response property for the response status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status