Assets Search Builder

AssetsSearchBuilder

AssetsSearchBuilder Objects

class AssetsSearchBuilder()

Defined a search over Assets

constructor
function constructor()

Arguments:

  • parent InternalOpenGateAPI - Instance of our InternalOpenGateAPI
build
function build() -> 'Search'

Build a instance of Search

Returns:

  • Search

Example:

 ogapi.assetsSearchBuilder().onProvisioned().build()
group
function group(group: object) -> 'AssetsSearchBuilder'

The search request will have this group by

Arguments:

  • group object

Returns:

  • AssetsSearchBuilder

Example:

select
function select(select: SelectBuilder,object) -> 'AssetsSearchBuilder'

The search request will have this filter

Arguments:

  • select SelectBuilder,object

Returns:

  • AssetsSearchBuilder

Example:

 ogapi.assetsSearchBuilder().select(
     ogapi.newSelectBuilder().add(SE.element("provision.device.identifier", ["value"], "id"), SE.add("device.temperature.value", ["value"]))
 ) // Setting SelectBuilder
 ogapi.assetsSearchBuilder().select({ "elements": [{"name": "provision.device.identifier",
	"fields": [{"field": "value","alias": "identifier"}]},
     {"name": "device.temperature.value","fields": [{"field": "value","alias": "identifier"}]}]
  }) //Custom select
summary
function summary() -> 'AssetsSearchBuilder'

The response will only have a summary information

Returns:

  • AssetsSearchBuilder

Example:

ogapi.assetsSearchBuilder().summary()