Skip to main content

Get transfer function by ID

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

Retrieve detailed information of a specific transfer function.

Path Parameters

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

Responses

  • 200 OK: Returns the transfer function object with 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
    • creationTime: ISO 8601 creation timestamp
    • lastModificationTime: ISO 8601 last update timestamp
  • 404 Not Found: Transfer function with the specified ID does not exist for this device.

Security

  • This API requires authentication.

Request​

Responses​

OK