Novant

Documentation

Sign in

Values

Retrieves current values for points under a source.

GET /v1/values
curl -G https://api.novant.io/v1/values \
  -u ak_sample_123: \
  -d source_id=s.1 \
  --compressed

Parameters

source_id Required

Parent source ID for point list. One of source_id, asset_id, or space_id is required. If multiple are specified, precedence is source_id, then asset_id, then space_id.

asset_id Required

Parent asset ID for point list. One of source_id, asset_id, or space_id is required. If multiple are specified, precedence is source_id, then asset_id, then space_id.

space_id Required

Parent space ID for point list. One of source_id, asset_id, or space_id is required. If multiple are specified, precedence is source_id, then asset_id, then space_id.

point_ids

An allowlist to filter points by ID. Ids are formatted as a comma-separated list, i.e.: "s.1.1,s.1.2,s.1.5".

point_types

An allowlist to filter points by type. Types are formatted as a comma-separated list, i.e.: "discharge_air_temp_sensor,zone_air_temp_sensor".

Returns

Returns point values for the given source.

{
  "source_id": "s.1",
  "values": [
    {
      "id": "s.1.1",
      "val": 77.0,
      "status": "ok"
    },
    {
      "id": "s.1.2",
      "val": 3.0,
      "status": "ok"
    },
    {
      "id": "s.1.3",
      "val": 74.0,
      "status": "ok"
    },
    ...
  ]
}