Subsections of datasets

Dataset Finder

This class allow make get request to DatasetFinder resource into 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 list of datasets

Parámetros

Nombre Tipo Opcional Descripción
organization string ❌ organization

Retorna

Tip

Tipo: Promise


findByOrganizationAndDatasetId(organization, datasetId)

Performs a get that returns a definition of dataset

Parámetros

Nombre Tipo Opcional Descripción
organization string ❌ organization
datasetId string ❌ dataset identifier

Retorna

Tip

Tipo: Promise


findByOrganizationAndName(organization, name)

Performs a get that returns a definition of timeserie

Parámetros

Nombre Tipo Opcional Descripción
organization string ❌ organization
name string ❌ timeserie name

Retorna

Tip

Tipo: Promise


Datasets

This is the base object for working with Datasets.

constructor

Constructor

Parámetros

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

optimizationPlan()

Request optimization plan

Retorna

Tip

Tipo: Promise


withColumns(columns)

Set the columns attribute

Parámetros

Nombre Tipo Opcional Descripción
columns array ❌ required field

Retorna

Tip

Tipo: Datasets


withDescription(description)

Set the description attribute

Parámetros

Nombre Tipo Opcional Descripción
description string ❌

Retorna

Tip

Tipo: Datasets


withIdentifier(identifier)

Set the identifier attribute

Parámetros

Nombre Tipo Opcional Descripción
identifier string ❌ required field

Retorna

Tip

Tipo: Datasets


withIdentifierColumn(identifierColumn)

Set the identifierColumn attribute

Parámetros

Nombre Tipo Opcional Descripción
identifierColumn string ❌ required field

Retorna

Tip

Tipo: Datasets


withName(name)

Set the name attribute

Parámetros

Nombre Tipo Opcional Descripción
name string ❌ required field

Retorna

Tip

Tipo: Datasets


withOrganization(organization)

Set the organization attribute

Parámetros

Nombre Tipo Opcional Descripción
organization string ❌ required field

Retorna

Tip

Tipo: Datasets


withSorts(sorts)

List of sorting fields

Parámetros

Nombre Tipo Opcional Descripción
sorts array ❌ required field

Retorna

Tip

Tipo: Datasets