ingestMeasures #

Available since 2.5.0

Ingest measures from a data source into an asset.

Query Syntax #

HTTP #

URL: http://kuzzle:7512/_/device-manager/:engineId/assets/:assetId/_mMeasureIngest
Method: POST

Other protocols #

{
  "controller": "device-manager/assets",
  "action": "_mMeasureIngest",
  "assetId": "<assetId>",
  "engineId": "<engineId>",
  "body": {
    "dataSource": {
      "id": "<id>",
      // optional:
      "metadata": {
        // ...
      }
    },
    "measurements": [
      {
        "slotName": "<measureName>",
        "measuredAt": "<measuredAt>",
        "values": {
          "<valueName>": "<value>",
          // ...        
        }
      }
      // ...
    ]
  },

  // optional:
  "engineGroup": "<engine group>"
}

Arguments #

engineId: target engine id
assetId: target asset id
engineGroup: (optional): target engine group

Body properties #

dataSource: the measures source
measurements: the list of measurements to ingest

Datasource properties #

id: the measure source unique identifier
metadata: (optional) additional metadata for the source

Measurement properties #

slotName: target measure slot name
measuredAt: the timestamp of when the measure was collected
values: the measure values

Response #

{
  "status": 200,
  "error": null,
  "controller": "device-manager/assets",
  "action": "mMeasureIngest",
  "requestId": "<unique request identifier>",
  "result": null,
}

Errors #

Ingesting measures with incorrect values will throw a MeasureValidationError with the HTTP code 400.