Skip to main content

This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.Opens in a new tab

For information on migrating to InterSystems IRISOpens in a new tab, see Why Migrate to InterSystems IRIS?

%Api.Dashboard.v3

class %Api.Dashboard.v3 extends %Dashboard.REST

%Api.Dashboard.v3 provides version 3 API for Dashboard

Method Inventory

Methods

classmethod GetCalculatedData(sid As %String, iid As %String) as %Status
-----------------------------------------------------------------------------------------------------------------------------------------/// ------------------------------------------------ Method to Get a Sensor's Calculated Data -----------------------------------------------/// -----------------------------------------------------------------------------------------------------------------------------------------///
classmethod GetChartData(sid As %String, iid As %String) as %Status
-----------------------------------------------------------------------------------------------------------------------------------------/// ---------------------------------------------------- Method to Get a Sensor's Chart Data ------------------------------------------------/// -----------------------------------------------------------------------------------------------------------------------------------------///
classmethod GetSensor(sid As %String, iid As %String) as %Status
-----------------------------------------------------------------------------------------------------------------------------------------/// ---------------------------------------------------------- Method to Get A Sensor -------------------------------------------------------/// -----------------------------------------------------------------------------------------------------------------------------------------///
classmethod GetSensors() as %Status
-----------------------------------------------------------------------------------------------------------------------------------------/// --------------------------------------------------------- Method to Get All Sensors -----------------------------------------------------/// -----------------------------------------------------------------------------------------------------------------------------------------///
classmethod OutsideIntervalWindow(sampTime As %Numeric, sampDay As %Numeric, intervalStartTime As %Numeric, intervalStartDay As %Numeric, samplePeriod As %Integer)
Calculates if the new data point is within the bounds of the current interval
classmethod RollingAverage(curAvg As %Numeric, newValue As %Numeric, numValues As %Integer)
Calculates a running average, allowing for no sums to be stored
classmethod ValidateDataRequest(type As %String = "data", encryption As %String, ns As %String, sTime As %String, sPer As %Integer, ByRef error As %ZEN.proxyObject) as %Status
-----------------------------------------------------------------------------------------------------------------------------------------/// -------------------------------------------------------- Methods to Validate URI --------------------------------------------------------/// -----------------------------------------------------------------------------------------------------------------------------------------///

Inherited Members

Inherited Methods

FeedbackOpens in a new tab