SearchQuery

SearchQuery
SearchQuery
JSON Example
{
    "key": "string",
    "value": "string",
    "values": [
        "string"
    ],
    "matchingMethod": "string",
    "negated": false,
    "start": 0,
    "end": 0
}
string
key
Required

The entity facet (key) by which to search. Valid keys are any property keys returned by the JSON representation of the entity. Examples are 'creatorId', 'name', etc. The following special key keywords are also valid: 'tags' performs a search on entity tags, 'tagpath' performs a hierarchical search on tags, with periods (.) as path level separators. 'freetext' performs a free text search across many fields of the entity

string
value
Optional

The entity facet value for which to search. Either value or values field is required. If both are set, values takes precedence.

array of string
values
Optional

The entity facet values for which to search based on OR operation. Either value or values field is required. If both are set, values takes precedence.

string
matchingMethod
Optional

The method by which search matching is performed. Default: CONTAINS

Possible values are : CONTAINS, STARTSWITH, EXACT, TAGPATH,
boolean
negated
Optional

The flag to create a NOT operation. Default: false

Possible values are : true, false,
integer As int64 As int64
start
Optional

The start point of the range. At least one of start or end points should be available for range search.

integer As int64 As int64
end
Optional

The end point of the range. At least one of start or end points should be available for range search.