NEnetxms
Data Export

Get DCI history export state

Changed on

Retrieve state and progress of an export task started by POST /v1/data-export. Export statistics and archive size are included once the task is completed. Only the user who started the export can query it.

get/v1/data-export/{task-id}

Request

  • Base URL
    http://127.0.0.1:8000
  • URL
    http://127.0.0.1:8000/v1/data-export/{task-id}
  • Auth
    HTTP bearer

Path parameters

task-idinteger required

Task ID returned by POST /v1/data-export

Response

Export state

taskIdinteger

Background task ID

state'pending' | 'running' | 'completed' | 'failed'

Current task state

progressinteger

Completion percentage

failureReasonstring nullable

Failure description for failed tasks

metricCountinteger

Number of exported metrics (completed tasks only)

skippedCountinteger

Number of selected DCIs skipped as non-numeric or inaccessible (completed tasks only)

sampleCountinteger

Number of sample rows in data.csv (completed tasks only)

archiveSizeinteger

Archive size in bytes (completed tasks only)

mappingAvailableboolean

True if a pseudonym mapping file was produced (completed tasks only)

Changes