Data Objects Management

Overview

To provide clear and focused documentation, the container workflow has been divided into three dedicated articles.

This article specifically covers Data Objects Management, which focuses on managing telemetry data, defining transfer functions, and setting up alert rules.

Basic Operations

Basic API URL: https://{domain}/{tenantPath}/{srp}

Operation	API	Description
Create transfer function	POST {Basic API URL}/api/v1/devices/{deviceId}/inputs/data-objects/transfer-functions	Create a new transfer function
List transfer functions	GET {Basic API URL}/api/v1/devices/{deviceId}/inputs/data-objects/transfer-functions	Get device transfer functions
Update transfer function	PATCH {Basic API URL}/api/v1/devices/{deviceId}/inputs/data-objects/transfer-functions/{transferFunctionId}	Update the expression of a function
Delete transfer function	DELETE {Basic API URL}/api/v1/devices/{deviceId}/inputs/data-objects/transfer-functions/{transferFunctionId}	Delete a transfer function by its ID. This is a soft delete operation.
Create alert rule	POST {Basic API URL}/api/v1/devices/{deviceId}/inputs/data-objects/alert-rules	Create rule with trigger/reset conditions, delay, and notification settings
List alert rules	GET {Basic API URL}/api/v1/devices/{deviceId}/inputs/data-objects/alert-rules	Get device alert rules
Update alert rule	PATCH {Basic API URL}/api/v1/devices/{deviceId}/inputs/data-objects/alert-rules/{alertRuleId}	Update conditions and notification settings
Delete alert rule	DELETE {Basic API URL}/api/v1/devices/{deviceId}/inputs/data-objects/alert-rules/{alertRuleId}	Delete an alert rule

Constraints & Limitations

General

• API access requires authentication with a valid token
• Device must be online and registered to create tunnel sessions

Transfer Functions: Create

• type is required, must be Expression.
• outputDataObjectName is required, output data object name for the transformed value. Must be unique for the device. Accepted formats: camelCase, snake_case, or single word.
• expression is required, mathematical expression for transformation. Supports basic arithmetic operators (+, -, *, /, %). The variable name will be automatically extracted.

Transfer Functions: Update

• isEnabled enable or disable the transfer function. Disabling a function will stop producing the derived data object but will not delete the function definition.

Alert Rules: Create

• type is required, must be Expression.
• outputDataObjectName is required, output data object name for the transformed value. Must be unique for the device. Accepted formats: camelCase, snake_case, or single word.
• expression is required, mathematical expression for transformation. Supports basic arithmetic operators (+, -, *, /, %). The variable name will be automatically extracted.

Advanced Features

Transfer Function

Operation	API	Description
Get transfer function by ID	GET {Basic API URL}/api/v1/devices/{deviceId}/inputs/data-objects/transfer-functions/{transferFunctionId}	Retrieve details of a specific function
Update transfer function status	PATCH {Basic API URL}/api/v1/devices/{deviceId}/inputs/data-objects/transfer-functions/{transferFunctionId}/status	Enable or disable a transfer function

Alert Rule

Operation	API	Description
Get alert rule by ID	GET {Basic API URL}/api/v1/devices/{deviceId}/inputs/data-objects/alert-rules/{alertRuleId}	Retrieve details of a specific alert rule
Update alert rule status	PUT {Basic API URL}/api/v1/devices/{deviceId}/inputs/data-objects/alert-rules/{alertRuleId}/status	Enable or disable an alert rule

---

Last updated on Apr-8, 2026 | Version 1.0.0