Learning
Documentation
Community
Open Exchange
Global Masters
Home > Class Reference > ENSLIB namespace > %Api.Dashboard.v3
Private  Storage   

%Api.Dashboard.v3


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

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

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
7


Summary


Methods
%ClassIsLatestVersion %ClassName %DispatchClassMethod %DispatchGetModified
%DispatchGetProperty %DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty
%DispatchSetProperty %Extends %GetParameter %IsA
%New %OriginalNamespace %PackageName %SetModified
AcceptsContentType AccessCheck ConvertParameter Decrypt
DispatchMap DispatchRequest DrawCSS3STYLE DrawHEAD
DrawSTHEAD DrawSTTitle DrawSTYLE DrawTitle
DrawTitleSection Encrypt Error EscapeHTML
EscapeURL GetCalculatedData GetChartData GetSensor
GetSensors Http403 Http404 Http405
Http500 HyperEventCall HyperEventHead Include
InsertHiddenField InsertHiddenFields IsPrivate Link
Login OnErrorSetup OnHTTPHeader OnHandleCorsRequest
OnHandleOptionsRequest OnLoginPage OnPage OnPageError
OnPostHTTP OnPostHyperEvent OnPreDispatch OnPreHTTP
OnPreHyperEvent OnSecurityTokenPage OutsideIntervalWindow Page
QuoteJS ReportHttpStatusCode ResolveTarget Respond
RewriteURL RollingAverage SetResponseHeaderIfEmpty ShowError
StartTimer StatusToJSON StatusToProxyObject StopTimer
SupportedVerbs ThrowError UnescapeHTML UnescapeURL
ValidateDataRequest


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 --------------------------------------------------------/// -----------------------------------------------------------------------------------------------------------------------------------------///