Skip to main content

Update function transfer

PATCH 
/api/v1/devices/{deviceId}/inputs/data-objects/transfer-functions/{functionTransferId}

Update an existing function transfer's output name and expression.

Path Parameters

  • deviceId (string, required): Device identifier. Example: 9f75abda56c3
  • functionTransferId (string, required): Unique identifier of the function transfer to update. Example: 3f2504e0-4f89-11d3-9a0c-0305e82c3301

Request Body Parameters

  • type (FunctionTransferType, required): Type of function transfer. Currently only Expression is supported. Example: Expression
  • outputDataObjectName (string, required): New output data object name. Must be unique for the device. Example: calibrated_temperature_fahrenheit
  • expression (string, required): New mathematical expression for transformation. Example: ((x * 9) / 5) + 32

Responses

  • 200 OK: Returns the updated function transfer object with new values and updated lastModificationTime.
  • 404 Not Found: Function transfer with the specified ID does not exist.
  • 409 Conflict: New output data object name conflicts with an existing function transfer for this device.

Security

  • This API requires authentication.

Request​

Responses​

OK