Skip to main content

Retrieving Asset Thresholds

To retrieve the configured threshold values for one or more assets (irrigation equipment), you can call the POST /assets/thresholds endpoint.

Authenticate your requests with an API key (see Authentication for the Authorization: Api-Key <your_key> header format).

Endpoint​

POST https://api.telaqua.com/assets/thresholds

Request​

The request body uses the public subset of the asset search schema:

  • assetIds (UUID array, optional): directly target assets; when present, other filters are ignored (preferred).
  • assetGroupIds (UUID array, optional): target assets that belong to one or more asset groups.
  • assetGroupType (enum, optional): asset group type (e.g. FarmBlock).
  • equipmentType (enum or array, optional): equipment types to include (e.g. VALVE, PUMP).

In practice, this endpoint is typically used either with assetIds, or with assetGroupIds + equipmentType (+ optional assetGroupType).

Option A: Specific assets by assetIds​

{
  "assetIds": ["2c37ad05-379b-4823-a105-e1b5e5aab5e6", "a5fd205c-56a3-440f-bfa7-fefa88a1ff24"]
}

Option B: Filter by group and equipment type​

{
  "assetGroupIds": ["265c79cc-8b23-4e1b-bb23-582a6ad45d50"],
  "assetGroupType": "FarmBlock",
  "equipmentType": "VALVE"
}

Response​

The response is an array. Each item contains:

  • assetId, name, equipmentType
  • thresholds: a map of variable names to numeric values

Assets without stored thresholds are omitted from the response. If none of the matching assets have stored thresholds, the response can be an empty array ([]).

The thresholds keys depend on the equipmentType (for example, pumps use openPumpThreshold/targetPumpThreshold/overpressureThreshold, while valves use openValveThreshold/targetValveThreshold/overpressureThreshold).

[
  {
    "assetId": "2c37ad05-379b-4823-a105-e1b5e5aab5e6",
    "name": "Pompe A",
    "equipmentType": "PUMP",
    "thresholds": {
      "openPumpThreshold": 0.3,
      "targetPumpThreshold": 2,
      "overpressureThreshold": 8
    }
  },
  {
    "assetId": "a5fd205c-56a3-440f-bfa7-fefa88a1ff24",
    "name": "Valve A1",
    "equipmentType": "VALVE",
    "thresholds": {
      "openValveThreshold": 0.3,
      "targetValveThreshold": 0.8,
      "overpressureThreshold": 3.5
    }
  }
]