Novant

Documentation

Sources

Retrieves a list of all sources in a project.

POST /v1/sources
curl https://api.novant.io/v1/sources \
  -X POST \
  -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",
      "enabled": true,
      "bound": true,
      "parent_asset_id": "a.1"
    },
    {
      "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"
    },
    ...
  ]
}