Object

UniversalSearchQuery

Query that can be used in connection with the universal search API

Properties

Name	Type	Access	Description
static	Number	readonly	AND operator for field queries.
static	Number	readonly	OR operator for field queries.
static	Number	readonly	Find fields that contain the given content.
static	Number	readonly	Find fields that end with the given content.
static	Number	readonly	Find fields that equal the given content.
static	Number	readonly	Find fields that start with the given content.
	String	readonly

Methods

static → Object

Constructs a filter query that only enables agents other then the given agents.

disallowedAgents Varies

subQuery Object

static → Object

Constructs a filter query that only enables the given agents.

agents Varies

subQuery Object

static → Object

Constructs a text query that searches on agents for the given text.

queryText String

static → Object

Constructs a field query consisting of a vector of {schema:string property:string content:string operator:FIELD_QUERY_CONTAINS|FIELD_QUERY_EQUALS|FIELD_QUERY_STARTS_WITH|FIELD_QUERY_ENDSWITH} objects that can be used to query e.g. the metadata search index for path based queries. The second parameter is an operator (BOOLEAN_FIELD_OPERATOR_AND|BOOLEAN_FIELD_OPERATOR_OR) for the metadata search aggregation which can be either

fieldSpecs Array

operator Number

static → Object

Constructs a merge query that merges results from multiple subqueries. Merge queries will not perform any deduplication. Results from all subqueries are merged into one final output result set.

subQueries Array

static → Object

Constructs a join query that joins results from 2 subqueries on a set of given paths. The join operation will be successful if the same objects exist under the same pathes for both objects and return a joined object with all paths merged in that case. Otherwise the join operation will fail.A path is a <dot> seperated string that represents the path to the object in the result object. e.g. key1.key2.key3

leftQuery Object

rightQuery Object

keyPaths Varies

static → Object

Constructs a query from a valid query JSON file.

jsonString String

static → Object

Constructs a join query that joins results from 2 subqueries on the universal search result object hash. Meaning that two results will be joined if and only if the refer to the same object within the host

leftQuery Object

rightQuery Object