Class: Systems

Systems(networkPropertiesopt)

new Systems(networkPropertiesopt)

Parameters:
Name Type Attributes Default Description
networkProperties Object <optional>
 {}
Properties
Name Type Attributes Default Description
endpointUrl String defines the Http(s) endpoint URL
tls Boolean defines is use Http or Https secure protocol for fetching data
streamProtocol String <optional>
 'ws' the Stream protocol to use: 'ws' pr 'mqtt'
mqttOpts Object <optional>
 {} the Mqtt options if stream protocol is 'mqtt'
Properties
Name Type Description
prefix String the Mqtt prefix value
endpointUrl String the Mqtt specific endpointUrl
Source:

Methods

(async) getSystemById(systemId, systemFilteropt) → {System}

Get a specific system resource by ID. Note that this will return the description of the system valid at the current time. To get the description valid for a past (or future) time, use the "history" sub-collection. route: /systems/{sysid}
Parameters:
Name Type Attributes Default Description
systemId String the ID of the System resource
systemFilter SystemFilter <optional>
 new SystemFilter() the system filter
Source:
Returns:
- The corresponding System
Type
System

(async) searchSystems(systemFilteropt, pageSizeopt) → {Promise.<Collection.<System>>}

List or search all observing systems available through this API. By default, only top level systems are listed (i.e. subsystems are ommitted) unless the "parent" query parameter is set route: /systems
Parameters:
Name Type Attributes Default Description
systemFilter SystemFilter <optional>
 new SystemFilter() the system filter
pageSize Number <optional>
 10 default page size
Source:
Returns:
- A collection of System
Type
Promise.<Collection.<System>>