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:74fe488d5d35dataStreamId(Guid, required): Unique ID of the data stream. Example:3a217ee3-fb2c-617b-6ff6-7257537afadedataPackId(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 fromtimestamp.
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'sdataTypeis not exactlydata-pack. This is rejected regardless of what the actualdataTypeis (includingdouble,integer,boolean,string,long,application/json,application/octet-stream,image/png,image/jpeg,image/jpg, andblob), since only a data stream declareddataType: data-packstores data packs.
Security
- This API requires authentication.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 422
Returns the data pack: dataPackId, timestamp, record, createdAt.
Invalid request parameters.
The request is missing a bearer token, or the token is malformed, expired, or otherwise fails signature/issuer validation.
The bearer token is valid but does not grant access to this request: either it lacks the data-pack.read scope required by this endpoint, or its resource_access claim does not grant the caller access to the organization identified by orgId.
No data pack was found for the specified device and dataPackId.
The data stream's dataType is not exactly data-pack (any other dataType, including double, integer, boolean, string, long, application/json, application/octet-stream, image/png, image/jpeg, image/jpg, and blob, is rejected).