Home Manual Reference Source Test Repository
import TimeseriesFinder from 'opengate-js/src/timeseries/TimeseriesFinder.js'
public class | source

TimeseriesFinder

Extends:

GenericFinder → TimeseriesFinder

This class allow make get request to TimeseriesFinder resource into Opengate North API.

Constructor Summary

Public Constructor
public

Constructor

Method Summary

Public Methods
public

findByOrganization(organization: string, expand: Array, dataStreams: Array): Promise

Performs a get that returns list of timeseries

public

Performs a get that returns a definition of timeserie

public

findByOrganizationAndTimeserieId(organization: string, timeserieId: string): Promise

Performs a get that returns a definition of timeserie

Public Constructors

public constructor(ogapi: InternalOpenGateAPI) source

Constructor

Override:

GenericFinder#constructor

Params:

NameTypeAttributeDescription
ogapi InternalOpenGateAPI

Reference to the API object.

Public Methods

public findByOrganization(organization: string, expand: Array, dataStreams: Array): Promise source

Performs a get that returns list of timeseries

Params:

NameTypeAttributeDescription
organization string

organization

expand Array

['columns', 'context']

dataStreams Array

["ds_id_1","ds_id_2"]

Return:

Promise

public findByOrganizationAndName(organization: string, name: string): Promise source

Performs a get that returns a definition of timeserie

Params:

NameTypeAttributeDescription
organization string

organization

name string

timeserie name

Return:

Promise

public findByOrganizationAndTimeserieId(organization: string, timeserieId: string): Promise source

Performs a get that returns a definition of timeserie

Params:

NameTypeAttributeDescription
organization string

organization

timeserieId string

timeserie identifier

Return:

Promise