PT EN

Sensores

URL base: $BUSINESS_API

O objecto

idstring · opcional
codestring · opcional
namestring · opcional
device_idstring · opcional
kindstring · opcional

um de flow, pressure, level, quality

metricstring · opcional
unitstring · opcional
locationstring · opcional

um de abstraction_point, treatment_plant, reservoir, distribution

asset_idstring · opcional
dma_idstring · opcional
activeboolean · opcional
O objecto
{
  "id": "sen_28o3p46TDQsRdq8pzycV5cIxbMg",
  "code": "COD-2026-000142",
  "name": "Ana Matsinhe",
  "device_id": "dev_2E2J9iiRr2o7PWMrj8wJrQyb9sK",
  "kind": "flow",
  "metric": "metric",
  "unit": "unit",
  "location": "abstraction_point",
  "asset_id": "ass_2IIXBYi79uuRV0QXd685rmSLhO0",
  "dma_id": "dma_2gE3tiwbLQQnDGcrVkstPO8Bjkg",
  "active": true
}

Listar sensores

Registos

GET /sensors

Returns a cursor-paginated page of the tenant's telemetry sensors, each with its code, device ID, metric, unit, location in the supply chain and linked asset or DMA. Page with limit and after. Requires the monitoring read permission.

Parâmetros

kindstring · consulta · opcional

Returns only sensors of this kind: flow, pressure, level or quality.

limitinteger · consulta · opcional

Maximum resources to return (default 20, maximum 100).

afterstring · consulta · opcional

Opaque cursor returned by the previous page.

Devolve

200 OK

Mostrar atributos
dataarray of Sensor · opcional
Mostrar atributos filhos
idstring · opcional
codestring · opcional
namestring · opcional
device_idstring · opcional
kindstring · opcional

um de flow, pressure, level, quality

metricstring · opcional
unitstring · opcional
locationstring · opcional

um de abstraction_point, treatment_plant, reservoir, distribution

asset_idstring · opcional
dma_idstring · opcional
activeboolean · opcional
has_moreboolean · opcional
next_cursorstring · opcional

Erros 400 · 403

Permissões business:monitoring:read · Funções: admin, analyst, field_supervisor, operations, owner, viewer

curl -X GET "$BUSINESS_API/sensors" \
  -H "Authorization: Bearer sk_test_..."
Resposta 200
{
  "data": [
    {
      "id": "sen_28o3p46TDQsRdq8pzycV5cIxbMg",
      "code": "COD-2026-000142",
      "name": "Ana Matsinhe",
      "device_id": "dev_2E2J9iiRr2o7PWMrj8wJrQyb9sK",
      "kind": "flow",
      "metric": "metric",
      "unit": "unit",
      "location": "abstraction_point",
      "asset_id": "ass_2IIXBYi79uuRV0QXd685rmSLhO0",
      "dma_id": "dma_2gE3tiwbLQQnDGcrVkstPO8Bjkg",
      "active": true
    }
  ],
  "has_more": true,
  "next_cursor": "next cursor"
}

Registar um sensor

Registos

POST /sensors

Registers an active telemetry sensor whose samples can then be ingested and checked against alarm rules. code, name, device_id, metric and unit are required, and kind must be flow, pressure, level or quality. location must be abstraction_point, treatment_plant, reservoir or distribution and defaults to distribution; asset_id and dma_id are optional. Invalid values return 400 and a conflicting sensor returns 409.

Corpo application/json

codestring · obrigatório
namestring · obrigatório
device_idstring · obrigatório
kindstring · obrigatório

um de flow, pressure, level, quality

metricstring · obrigatório
unitstring · obrigatório
locationstring · opcional
asset_idstring · opcional
dma_idstring · opcional

Devolve

201 OK

Mostrar atributos
idstring · opcional
codestring · opcional
namestring · opcional
device_idstring · opcional
kindstring · opcional

um de flow, pressure, level, quality

metricstring · opcional
unitstring · opcional
locationstring · opcional

um de abstraction_point, treatment_plant, reservoir, distribution

asset_idstring · opcional
dma_idstring · opcional
activeboolean · opcional

Erros 400 · 403

Permissões business:monitoring:write · Funções: admin, operations, owner

curl -X POST "$BUSINESS_API/sensors" \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{
  "code": "COD-2026-000142",
  "name": "Ana Matsinhe",
  "device_id": "dev_2E2J9iiRr2o7PWMrj8wJrQyb9sK",
  "kind": "flow",
  "metric": "metric",
  "unit": "unit",
  "location": "location",
  "asset_id": "ass_2IIXBYi79uuRV0QXd685rmSLhO0",
  "dma_id": "dma_2gE3tiwbLQQnDGcrVkstPO8Bjkg"
}'
Resposta 201
{
  "id": "sen_28o3p46TDQsRdq8pzycV5cIxbMg",
  "code": "COD-2026-000142",
  "name": "Ana Matsinhe",
  "device_id": "dev_2E2J9iiRr2o7PWMrj8wJrQyb9sK",
  "kind": "flow",
  "metric": "metric",
  "unit": "unit",
  "location": "abstraction_point",
  "asset_id": "ass_2IIXBYi79uuRV0QXd685rmSLhO0",
  "dma_id": "dma_2gE3tiwbLQQnDGcrVkstPO8Bjkg",
  "active": true
}

Obter um sensor

Registos

GET /sensors/{id}

Returns one telemetry sensor with its code, device ID, kind, metric, unit, location, linked asset or DMA and whether it is active. A sensor that does not exist in the tenant returns 404.

Parâmetros

idstring · caminho · obrigatório

ID of the sensor to return.

Devolve

200 OK

Mostrar atributos
idstring · opcional
codestring · opcional
namestring · opcional
device_idstring · opcional
kindstring · opcional

um de flow, pressure, level, quality

metricstring · opcional
unitstring · opcional
locationstring · opcional

um de abstraction_point, treatment_plant, reservoir, distribution

asset_idstring · opcional
dma_idstring · opcional
activeboolean · opcional

Erros 400 · 403

Permissões business:monitoring:read · Funções: admin, analyst, field_supervisor, operations, owner, viewer

curl -X GET "$BUSINESS_API/sensors/{id}" \
  -H "Authorization: Bearer sk_test_..."
Resposta 200
{
  "id": "sen_28o3p46TDQsRdq8pzycV5cIxbMg",
  "code": "COD-2026-000142",
  "name": "Ana Matsinhe",
  "device_id": "dev_2E2J9iiRr2o7PWMrj8wJrQyb9sK",
  "kind": "flow",
  "metric": "metric",
  "unit": "unit",
  "location": "abstraction_point",
  "asset_id": "ass_2IIXBYi79uuRV0QXd685rmSLhO0",
  "dma_id": "dma_2gE3tiwbLQQnDGcrVkstPO8Bjkg",
  "active": true
}