Novant

Documentation

Search /
Sign in

Points

Retrieves the point list for a source.

GET /v1/points
curl -G https://api.novant.io/v1/points \
  -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 listing for the given source.

{
  "source_id": "s.1",
  "source_name": "ECB-600-1",
  "source_bound": true,
  "points": [
    {
      "id": "s.1.1",
      "name": "Discharge Air Temperature",
      "type": "discharge_air_temp_sensor",
      "addr": "ai.1",
      "kind": "num",
      "unit": "°F",
      "writable": false,
      "ontology": {
        "haystack": "point,air,temp,sensor,discharge"
      }
    },
    {
      "id": "s.1.2",
      "name": "Discharge Air Pressure",
      "type": "discharge_air_pressure_sensor",
      "addr": "av.2",
      "kind": "num",
      "unit": "inH₂O",
      "writable": true,
      "ontology": {
        "haystack": "point,air,pressure,sensor,discharge"
      }
    },
    {
      "id": "s.1.3",
      "name": "Cooling",
      "type": "generic",
      "addr": "av.3",
      "kind": "num",
      "unit": "%",
      "writable": true,
      "ontology": {
        "haystack": "point"
      }
    },
    ...
  ]
}