跳至主要内容

Partially update a data stream

PATCH 

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

Update one or more fields of a specific data stream. Only the provided fields will be updated; omitted fields retain their current values. For system-managed streams (managedBy = System), only the fields listed in the editable fields (displayName, description, unitDisplay, recordToDataLake) may be sent; any other field is rejected with 409.

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: Data stream patched successfully.
  • 400 Bad Request: Invalid request body.
  • 404 Not Found: Data stream not found.
  • 409 Conflict: A field not editable on this stream was modified.

Security

  • This API requires authentication.

Request

Responses

Data stream patched successfully.