Skip to main content

Get function transfer by ID

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

Retrieve detailed information of a specific function transfer.

Path Parameters

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

Responses

  • 200 OK: Returns the complete function transfer object including:
    • id: Unique identifier
    • deviceId: Associated device
    • dataObjectName: Source data object
    • type: Transfer type (always expression for now)
    • name: Output data object name
    • config: Configuration containing expression and extracted variable
    • creationTime: When the transfer was created
    • lastModificationTime: When the transfer was last updated
  • 404 Not Found: Function transfer with the specified ID does not exist for this device.

Security

  • This API requires authentication.

Request​

Responses​

OK