Dataset Entities Search Builder
DatasetEntitiesSearchBuilder
DatasetEntitiesSearchBuilder Objects
class DatasetEntitiesSearchBuilder()Defined a search over Executions
constructor
function constructor()Arguments:
parentInternalOpenGateAPI - Instance of our InternalOpenGateAPI
build
function build() -> 'Search'Build a instance of Search
Returns:
Search
Example:
ogapi.datasetEntitiesSearchBuilder()disableCaseSensitive
function disableCaseSensitive(flag: *) -> 'DatasetEntitiesSearchBuilder'The response will return a response by applying the filter with likes case-no-sensitive
Arguments:
flag*
Returns:
DatasetEntitiesSearchBuilder
Example:
ogapi.datasetEntitiesSearchBuilder().disableCaseSensitive()
disableDefaultSorted
function disableDefaultSorted() -> 'DatasetEntitiesSearchBuilder'The response will return a response without sorted
Returns:
DatasetEntitiesSearchBuilder
Example:
ogapi.datasetEntitiesSearchBuilder().disableDefaultSorted()
flattened
function flattened() -> 'DatasetEntitiesSearchBuilder'The response will return a flattened response
Returns:
DatasetEntitiesSearchBuilder
Example:
ogapi.datasetEntitiesSearchBuilder().flattened()
group
function group(group: object) -> 'DatasetEntitiesSearchBuilder'The search request will have this group by
Arguments:
groupobject
Returns:
DatasetEntitiesSearchBuilder
Example:
removeCaseSensitive
function removeCaseSensitive() -> 'DatasetEntitiesSearchBuilder'The response will return a response by deleteing the parameters with likes case-no-sensitive
Returns:
DatasetEntitiesSearchBuilder
Example:
ogapi.datasetEntitiesSearchBuilder().disableCaseSensitive()
select
function select(select: SelectBuilder,object) -> 'DatasetEntitiesSearchBuilder'The search request will have this filter
Arguments:
selectSelectBuilder,object
Returns:
DatasetEntitiesSearchBuilder
Example:
ogapi.datasetEntitiesSearchBuilder().select(
ogapi.newSelectBuilder().add(SE.element("provision.device.identifier", ["value"], "id"), SE.add("device.temperature.value", ["value"]))
) // Setting SelectBuilder
ogapi.datasetEntitiesSearchBuilder().select({ "elements": [{"name": "provision.device.identifier",
"fields": [{"field": "value","alias": "identifier"}]},
{"name": "device.temperature.value","fields": [{"field": "value","alias": "identifier"}]}]
}) //Custom select