Flattened Search Builder

FlattenedSearchBuilder

class FlattenedSearchBuilder()

This is a abstract class. It is a class that extends from base to make all kind of summary search request to OpenGate North API.

function constructor()

Constructor

Arguments:

parent InternalOpenGateAPI - this is ogapi instance
routes object - this defined the routes. One of those routes must be called on Builder before call build method.

function build() -> 'Search'

Build a instance of Search

Returns:

Example:

 ogapi.devicesSearchBuilder().onProvisioned().build()

function flattened() -> 'FlattenedSearchBuilder'

The response will return a flattened response

Returns:

Example:

ogapi.entitiesSearchBuilder().flattened()