Skip to main content

Create transfer function

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

Create a new transfer function to transform data object values using mathematical expressions.

Path Parameters

  • deviceId (string, required): Device identifier. The device must exist in the system. Example: 9f75abda56c3

Request Body Parameters

  • type (FunctionTransferType, required): Type of transfer function. Currently only Expression is supported. Example: Expression
  • outputDataObjectName (string, required): Output data object name for the transformed value. Must be unique for the device. Accepted formats: camelCase, snake_case, or single word. No all-digit names or special characters. Example: calibrated_temperature
  • expression (string, required): Mathematical expression for transformation. Supports basic arithmetic operators (+, -, *, /, %). The variable name will be automatically extracted. Example: (temperature * 1.8) + 32

Responses

  • 200 OK: Returns the created transfer function. Response fields:
    • transferFunctionId: Unique identifier (GUID string)
    • type: Transfer type (expression)
    • outputDataObjectName: Output data object name
    • expression: Mathematical expression
    • isEnabled: Whether the transfer function is active (always true on creation)
    • creationTime: ISO 8601 creation timestamp
    • lastModificationTime: ISO 8601 last update timestamp (null on creation)
  • 400 Bad Request: Invalid request parameters or expression syntax.
  • 409 Conflict: Transfer function already exists for the device and output name combination.

Security

  • This API requires authentication.

Request​

Responses​

OK