Skip to main content

Get a data stream data pack

GET 
/api/v1/orgs/{orgId}/devices/{deviceId}/data-streams/{dataStreamId}/data-packs/{dataPackId}

Returns a structured/complex "Sets" record (data pack), identified by its dataPackId. Only valid for a data stream declared dataType: data-pack.

Parameters

  • deviceId (string, required): Unique ID of the device. Example: 74fe488d5d35
  • dataStreamId (Guid, required): Unique ID of the data stream. Example: 3a217ee3-fb2c-617b-6ff6-7257537afade
  • dataPackId (string, required): Document id of the data pack. Not guaranteed to be a UUID.

Response Fields:

  • dataPackId (string): Document id of the stored data pack (opaque, store-native).
  • timestamp (DateTime): Business timestamp supplied at creation time.
  • record (object): The structured record itself (arbitrary application-defined JSON shape).
  • createdAt (DateTime): When the record was stored, distinct from timestamp.

Responses

  • 200 OK: Returns the data pack.
  • 400 Bad Request: Invalid request parameters.
  • 404 Not Found: No data pack was found for the specified device and dataPackId.
  • 422 Unprocessable Content: The data stream's dataType is not exactly data-pack. This is rejected regardless of what the actual dataType is (including double, integer, boolean, string, long, application/json, application/octet-stream, image/png, image/jpeg, image/jpg, and blob), since only a data stream declared dataType: data-pack stores data packs.

Security

  • This API requires authentication.

Request​

Responses​

Returns the data pack: dataPackId, timestamp, record, createdAt.