Novant

Documentation

Search /
Sign in

Sources

Retrieves a list of all sources in a project.

GET /v1/sources
curl https://api.novant.io/v1/sources \
  -u ak_sample_123: \
  --compressed

Parameters

source_ids

An allowlist to filter sources. Ids are formatted as a comma-separated list, i.e.: "s.1,s.2,s.8".

bound_only

If "true" then only return sources that are bound to a source map and edge node.

Returns

Returns the list of sources in this project based on input arguments.

{
  "sources": [
    {
      "id": "s.1",
      "name": "ECB-600-1",
      "type": "bacnet",
      "addr": "10.0.1.1:47808",
      "device_id": 3001,
      "vendor": "Distech",
      "model": "ECB-600",
      "version": "2.07",
      "firmware": "1.0.12",
      "desc": "Rooftop unit controller",
      "enabled": true,
      "bound": true,
      "source_map_id": "sm.1",
      "node_id": "NA00000000V1",
      "parent_asset_id": "a.1",
      "target_poll_freq": 300,
      "trend_interval": 900
    },
    {
      "id": "s.2",
      "name": "ECB-600-2",
      "type": "bacnet",
      "addr": "10.0.1.2:47808",
      "device_id": 3002,
      "vendor": "Distech",
      "model": "ECB-600",
      "enabled": true,
      "bound": true,
      "parent_asset_id": "a.2"
    },
    {
      "id": "s.3",
      "name": "ECB-600-3",
      "type": "bacnet",
      "addr": "10.0.1.3:47808",
      "device_id": 3003,
      "vendor": "Distech",
      "model": "ECB-600",
      "enabled": true,
      "bound": true,
      "parent_asset_id": "a.3"
    },
    ...
  ]
}

The bound field indicates whether the source is bound to a source map and an edge node. An unbound source is defined in the project but is not yet reading data, and omits source_map_id and node_id.

source_map_id is the point template this source uses. node_id is the serial number of the edge node servicing the source.

The device metadata fields - device_id, vendor, model, version, firmware, and desc - are reported by the source and are omitted when the source does not advertise them.

target_poll_freq and trend_interval are expressed in seconds, and are omitted when not set on the source.