NEnetxms
Data Export

Start DCI history export

Changed on

Start a server-side export of DCI history for metrics selected either by system tag patterns under a root object or by an explicit DCI list. The export runs as a background task; poll GET /v1/data-export/{task-id} for progress and download the produced archive from GET /v1/data-export/{task-id}/file once the task is completed. The archive is a ZIP with metrics.csv (one row per metric, including the classifier tag and a stable metric identifier), data.csv (one row per sample, with provenance attributes) and manifest.json. With "anonymize" set, object names are replaced with class-based pseudonyms and metric identifiers with HMAC-derived pseudonyms that stay stable across exports from the same server; numeric object identifiers and the server identifier are omitted from the archive. "keepMapping" additionally produces a pseudonym-to-identity mapping file that is downloaded separately and is never part of the archive. Requires read access to the root object and to every exported DCI; related objects and spatial ancestors are included only when readable. The period end is clamped to the current time. Every export is recorded in the audit log.

post/v1/data-export

Request

  • Base URL
    http://127.0.0.1:8000
  • URL
    http://127.0.0.1:8000/v1/data-export
  • Auth
    HTTP bearer

Request body

rootObjectIdinteger

Root of the object subtree searched for tagged DCIs; required unless dciList is given

tagPatternsstring[]

Glob patterns (* and ? wildcards) matched against DCI system tag, e.g. "eed.*"

tier'raw' | 'hourly' | 'daily'

History tier to export. Aggregated tiers produce one row per bucket with average in "value" and additional min, max and count columns; metrics for which the requested tier is not available fall back to raw samples.

format'csv'

Output format

anonymizeboolean

Replace object names with class-based pseudonyms and metric identifiers with stable pseudonyms

keepMappingboolean

Produce pseudonym mapping file (anonymized exports only), downloadable with type=mapping

Example request

{
  "tagPatterns": [
    "eed.*",
    "power.*",
    "cooling.*",
    "env.*"
  ]
}

Response

Export task started

taskIdinteger

Background task ID

Changes