EDedgeimpulse
Raw data

Get sample

Get a sample.

get/api/{projectId}/raw-data/{sampleId}

Request

Path parameters

projectIdinteger required

Project ID

sampleIdinteger required

Sample ID

Query parameters

limitPayloadValuesinteger

Limit the number of payload values in the response

cacheKeystring

If set, then a long cache header is sent. If this is omitted then a no-cache header is sent. You can use this if you f.e. know the last modified date of a sample. Stick the last modified date in the cache key, so the sample can be stored in browser cache (and will automatically be invalidated if the modified date changes).

impulseIdinteger

Impulse ID. If this is unset then the default impulse is used.

proposedActionsJobIdinteger

Pass this parameter when querying samples from inside an AI Action job. If you pass this parameter in a multi-stage AI Action, previous proposed changes (from an earlier step) will be applied to the returned dataset.

truncateStructuredLabelsboolean

If true, only a slice of labels will be returned for samples with multiple labels.

datasetVersionIdinteger

Dataset version ID. If not set, the current mutable dataset is used

Response

OK

successboolean required

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

totalPayloadLengthinteger required

Total number of payload values

Example response

{
  "sample": {
    "id": 2,
    "filename": "idle01.d8Ae",
    "signatureValidate": true,
    "signatureMethod": "HS256",
    "label": "healthy-machine",
    "intervalMs": 16,
    "frequency": 62.5,
    "originalIntervalMs": 16,
    "originalFrequency": 62.5,
    "sensors": [
      {
        "name": "accX"
      }
    ],
    "datastreams": [
      {
        "sensors": [
          {
            "name": "accX"
          }
        ]
      }
    ]
  },
  "payload": {
    "device_name": "ac:87:a3:0a:2d:1b",
    "device_type": "DISCO-L475VG-IOT01A",
    "sensors": [
      {
        "name": "accX"
      }
    ],
    "cropEnd": 128,
    "intervalMs": 16,
    "frequencyHz": 62.5
  },
  "datastreamPayloads": [
    {
      "payload": {
        "device_name": "ac:87:a3:0a:2d:1b",
        "device_type": "DISCO-L475VG-IOT01A",
        "sensors": [
          {
            "name": "accX"
          }
        ],
        "cropEnd": 128,
        "intervalMs": 16,
        "frequencyHz": 62.5
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.