Sign in

v1

latestOpenAPI 3.0.32026-07-23194968.1 KB
Template DataStreams

Get template datastreams

Retrieve all datastreams defined in a template.

Required permissions, when user-scoped authentication is used: PRODUCT_VIEW.

get/api/v1/organization/template/datastreams

Query parameters

templateIdinteger required

Template ID

Response

List of datastreams

idinteger required

DataStream ID

labelstring required

DataStream label

aliasstring required

DataStream alias

units'None' | 'KilometerPerHour' | 'MillimeterPerHour' | 'InchesPerHour' | 'CubicMetresPerHour' | 'MilePerHour' | 'MilePerHour2' | 'GramPerSquareMeter' | 'MilliLitterPerSquareMeter' | 'LitterPerSquareMeter' | 'PoundPerSquareInch' | 'PoundPerSquareInch2' | 'PoundPerCubicYard' | 'OuncePerCubicYard' | 'PoundPerCubicFoot' | 'VolumeFlow' | 'CubicCentimetersPerMinute' | 'SignalStrength' | 'DegreeDays' | 'Millimeter' | 'Centimeter' | 'Meter' | 'Kilometer' | 'KiloBytes' | 'MegaBytes' | 'GigaBytes' | 'Feet' | 'SquareFeet' | 'Inch' | 'Foot' | 'Yard' | 'Mile' | 'Milligram' | 'Gram' | 'Kilogram' | 'Ton' | 'Liter' | 'Milliliter' | 'Ounce' | 'Pint' | 'Gallon' | 'Pound' | 'Stone' | 'Quarter' | 'Hundredweight' | 'Celsius' | 'Fahrenheit' | 'Kelvin' | 'Percentage' | 'Degrees' | 'RPM' | 'Step' | 'Year' | 'Month' | 'Week' | 'Day' | 'Hour' | 'Minute' | 'Second' | 'Volt' | 'Ampere' | 'MilliAmpere' | 'MicroAmpere' | 'Ohm' | 'Hertz' | 'Watts' | 'Farad' | 'Siemen' | 'Henry' | 'MicrogramPerCubicMeter' | 'PartsPerMillion' | 'PartsPerBillion' | 'KiloWatts' | 'HectoPascal' | 'Pascal' | 'Lux' | 'Pressure' | 'PressureInBars' | 'AirQualityIndex' | 'KiloWattHour' | 'MilliSecond' | 'MilliSec' | 'MeterPerSecond' | 'MilliGramPerCubicMeter' | 'KiloPascal' | 'CubicMeter' | 'CubicYard' | 'CubicFeetPerMinute' | 'SquareMeter' | 'LitersPerSecond' | 'WattHour' | 'MilliWatt' | 'pH' | 'AmpereHour' | 'MilliAmpereHour'

DataStream units

type'STRING' | 'INT' | 'DOUBLE' | 'BOOLEAN' | 'LOCATION' | 'ENUM' required

DataStream value type

pininteger required

Virtual pin number

pinType'VIRTUAL' | 'DIGITAL' | 'ANALOG' required

Pin type

pinMode'INPUT' | 'OUTPUT' | 'INPUT_PULL_UP' | 'INPUT_PULL_DOWN'

Pin mode

isAnalogPinboolean required

Whether the pin is an analog pin

isRawboolean required

Whether the datastream value should be stored as raw value without parsing

isHistoryboolean required

Whether the datastream should be stored in the aggregated format

isForServiceboolean required

Whether the datastream should be displayed in the service chart widget

isForReportsboolean required

Whether the datastream is used for reporting purposes

isForActionsboolean required

Whether the datastream can be used in the automation actions

isForConditionsboolean required

Whether the datastream can be used in the automation conditions

isSyncboolean required

Whether the datastream value should be synced on the hardware request

minnumber double

Minimum allowed datastream value

maxnumber double

Maximum allowed datastream value