Skip to main content

Update transfer function

PATCH 

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

Update an existing transfer function's expression, type, or enabled status. All fields are optional; only provided fields are updated.

Path Parameters

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

Request Body Parameters (all optional)

  • type (FunctionTransferType, optional): Type of transfer function. Example: Expression
  • expression (string, optional): New mathematical expression for transformation. Example: ((x * 9) / 5) + 32
  • isEnabled (boolean, optional): Enable or disable the transfer function. Example: true

Responses

  • 200 OK: Returns the updated transfer function object with updated lastModificationTime.
  • 404 Not Found: Transfer function with the specified ID does not exist.

Security

  • This API requires authentication.

Request

Responses

OK