跳至主要内容

Get a data stream

GET 

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

Retrieve details of a specific data stream by its ID. For user-managed streams (managedBy = User), dataSource is null when the stream is not yet bound to a source.

Parameters

  • deviceId (string, required): Unique ID of the device. Example: 74fe488d5d35
  • dataStreamId (Guid, required): Unique ID of the data stream. Example: e033b4b3-36e0-4dbc-a6e4-1e77185402f4

Responses

  • 200 OK: Returns the data stream details: dataStreamId, dataStreamName, displayName, description, unitDisplay, dataType, recordToDataLake, managedBy, dataSource.
  • 400 Bad Request: orgId or dataStreamId in the route is not a valid GUID.
  • 404 Not Found: Data stream not found.

Security

  • This API requires authentication.

Request​

Responses​

Returns the data stream details: dataStreamId, dataStreamName, displayName, description, unitDisplay, dataType, recordToDataLake, managedBy, dataSource.