Subsections of timeseriesFunctionsCatalog

Timeseries Function

This is a base object that contains everything you can do with TimeseriesFunction.

constructor

Constructor

Parámetros

Nombre Tipo Opcional Descripción
ogapi InternalOpenGateAPI ❌ Reference to the API object.

delete()

Deletes the selected RuleConfiguration

Retorna

Tip

Tipo: Promise

update()

Updates a rule.

Retorna

Tip

Tipo: Promise

withDescription(description)

Set the description attribute

Parámetros

Nombre Tipo Opcional Descripción
description string ❌

Retorna

Tip

Tipo: TimeseriesFunction

withIdentifier(name)

Set the name for update attribute

Parámetros

Nombre Tipo Opcional Descripción
name string ❌ required field

Retorna

Tip

Tipo: TimeseriesFunction

withName(name)

Set the name attribute

Parámetros

Nombre Tipo Opcional Descripción
name string ❌ required field

Retorna

Tip

Tipo: TimeseriesFunction

withOrganization(organization)

Set the organization attribute

Parámetros

Nombre Tipo Opcional Descripción
organization string ❌ required field

Retorna

Tip

Tipo: TimeseriesFunction

withReturnType(returnType)

Set the returnType attribute

Parámetros

Nombre Tipo Opcional Descripción
returnType String ❌

Retorna

Tip

Tipo: TimeseriesFunction

withScript(script)

Set the script attribute

Parámetros

Nombre Tipo Opcional Descripción
script string ❌

Retorna

Tip

Tipo: TimeseriesFunction

withValueTypes(valueTypes)

Set the valueTypes attribute

Parámetros

Nombre Tipo Opcional Descripción
valueTypes Array ❌

Retorna

Tip

Tipo: TimeseriesFunction

Timeseries Function Finder

This class allows making GET requests to the TimeseriesFunction resource in the OpenGate North API.

constructor

Constructor

Parámetros

Nombre Tipo Opcional Descripción
ogapi InternalOpenGateAPI ❌ Reference to the API object.

findByOrganization(organization)

Performs a get that returns a list of timeseries function

Parámetros

Nombre Tipo Opcional Descripción
organization string ❌ organization

Retorna

Tip

Tipo: Promise

findByOrganizationAndName(organization, name, script)

Performs a get that returns a timeseries function metadata

Parámetros

Nombre Tipo Opcional Descripción
organization string ❌ organization
name string ❌ Timeseries function Configuration name
script boolean ❌ If true script content will be downloaded

Retorna

Tip

Tipo: Promise

Timeseries Functions Helper

This class allows making GET requests to the TimeseriesFunctionsHelper resource in the OpenGate North API.

constructor

Constructor

Parámetros

Nombre Tipo Opcional Descripción
ogapi InternalOpenGateAPI ❌ Reference to the API object.

getDocJavascriptFunctions()

Performs a GET that returns documentation of JavaScript functions from the rules service.

Retorna

Tip

Tipo: Promise

getDocPrivateJavascriptFunctions()

Performs a GET that returns documentation of private JavaScript functions from the rules service.

Retorna

Tip

Tipo: Promise