Timeseries Finder

TimeseriesFinder

TimeseriesFinder Objects

class TimeseriesFinder()

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

constructor
function constructor()

Constructor

Arguments:

  • ogapi InternalOpenGateAPI - Reference to the API object.

findByOrganization
function findByOrganization(organization: string,expand: Array,dataStreams: Array) -> 'Promise'

Performs a get that returns list of timeseries

Arguments:

  • organization string - organization
  • expand Array - ['columns', 'context']
  • dataStreams Array - ["ds_id_1","ds_id_2"]

Returns:

  • Promise

findByOrganizationAndName
function findByOrganizationAndName(organization: string,name: string) -> 'Promise'

Performs a get that returns a definition of timeserie

Arguments:

  • organization string - organization
  • name string - timeserie name

Returns:

  • Promise

findByOrganizationAndTimeserieId
function findByOrganizationAndTimeserieId(organization: string,timeserieId: string) -> 'Promise'

Performs a get that returns a definition of timeserie

Arguments:

  • organization string - organization
  • timeserieId string - timeserie identifier

Returns:

  • Promise