Tickets Search Builder
TicketsSearchBuilder
TicketsSearchBuilder Objects
class TicketsSearchBuilder()Defined a search over Devices
constructor
function constructor()Arguments:
parentInternalOpenGateAPI - Instance of our InternalOpenGateAPI
disableDefaultSorted
function disableDefaultSorted() -> 'TicketsSearchBuilder'The response will return a response without sorted
Returns:
TicketsSearchBuilder
Example:
ogapi.ticketsSearchBuilder().disableDefaultSorted()
flattened
function flattened() -> 'TicketsSearchBuilder'The response will return a flattened response
Returns:
TicketsSearchBuilder
Example:
ogapi.ticketsSearchBuilder().flattened()
group
function group(group: object) -> 'SearchBuilder'The search request will have this group by
Arguments:
groupobject
Returns:
SearchBuilder
Example:
select
function select(select: SelectBuilder,object) -> 'SearchBuilder'The search request will have this filter
Arguments:
selectSelectBuilder,object
Returns:
SearchBuilder
Example:
ogapi.ticketsSearchBuilder().select(
ogapi.newSelectBuilder().add(SE.element("provision.ticket.identifier", [[{"field": "value","alias": "identifier"}], ), SE.add("device.temperature.value", [[{"field": "value"}]))
) // Setting SelectBuilder
ogapi.ticketsSearchBuilder().select({ "elements": [{"name": "provision.device.identifier",
"fields": [{"field": "value","alias": "identifier"}]},
{"name": "provision.ticket.name","fields": [{"field": "value","alias": "identifier"}]}]
}) //Custom select
summary
function summary() -> 'TicketsSearchBuilder'The response will only have a summary information
Returns:
TicketsSearchBuilder
Example:
ogapi.ticketsSearchBuilder().summary()