Datapoints Search Builder

DatapointsSearchBuilder

DatapointsSearchBuilder Objects

class DatapointsSearchBuilder()

Defined a search over Datastreams

constructor
function constructor()

Arguments:

  • parent InternalOpenGateAPI - Instance of our InternalOpenGateAPI
betweenDates
function betweenDates(fromDate: date,toDate: date) -> 'DatapointsSearchBuilder'

Set time window to search

Arguments:

  • fromDate date - Add from date
  • toDate date - Add to date

Returns:

  • DatapointsSearchBuilder

Example:

ogapi.datapointsSearchBuilder().withDeviceId('myDevice').build()
fluentFilter
function fluentFilter()
select
function select(select: SelectBuilder,object) -> 'SearchBuilder'

The search request will have this filter

Arguments:

  • select SelectBuilder,object

Returns:

  • SearchBuilder

Example:

 ogapi.entitiesSearchBuilder().select(
     ogapi.newSelectBuilder().add(SE.element("provision.device.identifier", ["value"], "id"), SE.add("device.temperature.value", ["value"]))
 ) // Setting SelectBuilder
 ogapi.entitiesSearchBuilder().select({ "elements": [{"name": "provision.device.identifier",
	"fields": [{"field": "value","alias": "identifier"}]},
     {"name": "device.temperature.value","fields": [{"field": "value","alias": "identifier"}]}]
  }) //Custom select
tagsFilter
function tagsFilter()
withDatastream
function withDatastream(datastreamId: string) -> 'DatapointsSearchBuilder'

Set datastreamId to search

Arguments:

  • datastreamId string - Datastream.id of Datapoint

Returns:

  • DatapointsSearchBuilder

Example:

ogapi.datapointsSearchBuilder().withDeviceId('myDevice').build()
withDeviceId
function withDeviceId(deviceId: string) -> 'DatapointsSearchBuilder'

Set deviceId to search

Arguments:

  • deviceId string - Prov.customId of Device

Returns:

  • DatapointsSearchBuilder

Example:

ogapi.datapointsSearchBuilder().withDeviceId('myDevice').build()
withFeed
function withFeed(feedId: string) -> 'DatapointsSearchBuilder'

Set feedName to search

Arguments:

  • feedId string - Datastream.id of Datapoint

Returns:

  • DatapointsSearchBuilder

Example:

ogapi.datapointsSearchBuilder().withDeviceId('myDevice').build()