Skip to content
Qatium Logo Qatium Logo Qatium SDK Documentation
We're currently creating a lot of content. Sign up to get notified when it's ready.

Asset

The Asset API lets you get information about the assets in the network. You can get a list of all the assets in the network using the getAssets method of the Network object. Part of the information that you can get from an asset is its readings data. See Readings for more details.

Common Properties

All assets in Qatium have a set of common properties.

  • id: A string representing the asset’s unique identifier.
  • originalId: The original id of the asset.
  • clusterId: The id of the cluster that the asset belongs to.
  • type: The type of the asset. See AssetTypes for more details.

SupplySource

Represents a supply source in the network.

Properties

  • description: A string with the description of the supply source.
  • elevation: The elevation of the supply source.
  • geometry: The geometry of the supply source, as a GeoJSON Point object.
  • head: Optional. The head of the supply source.
  • level: The level of the Supply Source.
  • pattern: Optional. A string with the pattern of the supply source.
  • readings: An object with the latest readings of the supply source. See Readings for more details.
  • sensors: An array representing the sensors attached to the supply source.
  • simulation: An object with the simulation data of the supply source.
  • zones: An array representing the zones of the supply source. Can be empty for networks without zones.
  • getPeriodSimulation: Function that returns an array of the simulation values for the whole simulation period with its dates.

Tank

Represents a tank in the network.

Properties

  • canOverflow: A boolean indicating whether the tank can overflow.
  • description: A string with the description of the tank.
  • diameter: The diameter of the tank.
  • elevation: The elevation of the tank.
  • geometry: The geometry of the tank, as a GeoJSON Point object.
  • initialLevel: The initial level of the tank.
  • level: The current level of the tank.
  • maximumLevel: The maximum level of the tank.
  • minimumLevel: The minimum level of the tank.
  • minimumVolume: The minimum volume of the tank.
  • sensors: An array representing the sensors attached to the tank.
  • simulation: An object with the simulation data of the tank.
  • volumeCurveId: The id of the volume curve of the tank.
  • zones: An array representing the zones of the tank. Can be empty for networks without zones.
  • readings: An object with the latest readings of the tank. See Readings for more details.
  • getPeriodSimulation: Function that returns an array of the simulation values for the whole simulation period with its dates.

Pump

Represents a pump in the network.

Properties

  • description: Optional. A string with the description of the pump.
  • elevation: The elevation of the pump.
  • geometry: The geometry of the pump, as a GeoJSON Point object.
  • head: Optional. The head of the pump.
  • level: The level of the pump.
  • pattern: Optional. A string with the pattern of the pump.
  • power: The power of the pump.
  • sensors: An array representing the sensors attached to the pump.
  • setting: The setting of the pump.
  • simulation: Optional. An object with the simulation data of the pump.
  • status: The status of the pump. One of OPEN, or CLOSED.
  • zones: An array representing the zone(s) the pump belongs to. Empty for pumps outside zones.
  • readings: An object with the latest readings of the pump. See Readings for more details.
  • getPeriodSimulation: Function that returns an array of the simulation values for the whole simulation period with its dates.

Junction

Represents a junction in the network.

Properties

  • demand: The junction’s demand.
  • description: Optional. A string with the description of the junction.
  • elevation: The elevation of the junction.
  • emitter
  • geometry: The geometry of the junction, as a GeoJSON Point object.
  • group
  • level: The level of the pump.
  • sensors: An array representing the sensors attached to the junction.
  • simulation: Optional. An object with the simulation data of the junction.
  • type: The type of the junction.
  • warningThresholdMax
  • warningThresholdMin
  • zones: An array representing the zone(s) the junction belongs to. Empty for junctions outside zones.
  • getPeriodSimulation: Function that returns an array of the simulation values for the whole simulation period with its dates.

Pipe

Represents a pipe in the network.

Properties

  • description: Optional. A string with the description of the pipe.
  • diameter: The pipe’s diameter.
  • geometry: The geometry of the pipe, as a GeoJSON Point object.
  • group
  • installationDate: The pipe installation date as a Date object.
  • isCV
  • lenght: The lenght of the pipe.
  • level: The level of the pipe.
  • material: The material of the pipe. See a list of possible values in the Materials section.
  • minorLoss
  • roughness
  • sensors: An array representing the sensors attached to the pipe.
  • simulation: Optional. An object with the simulation data of the pipe.
  • status: The status of the pipe.
  • type: The type of the pipe.
  • warningThresholdMax
  • warningThresholdMin
  • zones: An array representing the zone(s) the pipe belongs to. Empty for pipes outside zones.
  • getPeriodSimulation: Function that returns an array of the simulation values for the whole simulation period with its dates.

Valve

Represents a valve in the network.

Properties

  • curveId
  • description: Optional. A string with the description of the junction.
  • diameter: The valve’s diameter.
  • elevation: The elevation of the valve.
  • family
  • geometry: The geometry of the valve, as a GeoJSON Point object.
  • group
  • level: The level of the valve.
  • minorLoss
  • sensors: An array representing the sensors attached to the valve.
  • setting
  • simulation: Optional. An object with the simulation data of the valve.
  • status: The status of the valve.
  • type: The type of the valve.
  • warningThresholdMax
  • warningThresholdMin
  • zones: An array representing the zone(s) the valve belongs to. Empty for valves outside zones.
  • getPeriodSimulation: Function that returns an array of the simulation values for the whole simulation period with its dates.