Class SchemaSearchRequest
Request to search schemas
Inheritance
SchemaSearchRequest
Namespace: System.Dynamic.ExpandoObject
Syntax
[GeneratedCode("NJsonSchema", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")]
public class SchemaSearchRequest
Properties
Special filters used to filter down independently the aggregations' values and the search results on specific conditions.
For the search results, the aggregation filters are used to create a Filter that is put in AND with the eventual existing Filter of the search request to nail down the search results. The filters generated
by the aggregation filters are put in OR each other if they have the same AggregationName, and then such groups are put in AND.
For the aggregation values, only the original Filter of the search request is used to nail down the data to be considered for the aggregations. Then, on top of that, for each aggregator in the search request, a Filter is created to filter down the
aggregation results of that aggregation: depending if the AggregationName of the AggregationFilter matches the AggregationName of the Aggregator, the filter is put in OR (if it matches) or in AND (if it does not match it).
Moreover, an AggregationFilter ensures that the related value is returned in the AggregationResults also if the top aggregation values returned by default do not contain it.
Declaration
[JsonProperty("aggregationFilters", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public ICollection<AggregationFilter> AggregationFilters { get; set; }
Property Value
List of aggregators that defines how the items should be aggregated.
Declaration
[JsonProperty("aggregators", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public ICollection<AggregatorBase> Aggregators { get; set; }
Property Value
Enable debug mode: additional debug information regarding the query execution and reason of the matched documents are returned in the SchemaSearchResult.
Warning! It severely affects performance.
Declaration
[JsonProperty("debugMode", Required = Required.Always)]
public bool DebugMode { get; set; }
Property Value
An optional filter to limit the schemas.
Declaration
[JsonProperty("filter", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public FilterBase Filter { get; set; }
Property Value
Limits the number of the returned schemas. Defaults to 30.
Declaration
[JsonProperty("limit", Required = Required.Always)]
public int Limit { get; set; }
Property Value
The token used to retrieve the next page of results. It must be null on first request and only filled with the returned pageToken to request next page of results.
Declaration
[JsonProperty("pageToken", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public string PageToken { get; set; }
Property Value
Limits the schemas to the ones the user has the specified MetadataRights.
Declaration
[JsonProperty("rightsFilter", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore, ItemConverterType = typeof(StringEnumConverter))]
public ICollection<MetadataRight> RightsFilter { get; set; }
Property Value
An optional list of search behaviors. All the passed behaviors will be applied in the specified order.
Declaration
[JsonProperty("searchBehaviors", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore, ItemConverterType = typeof(StringEnumConverter))]
public ICollection<SearchBehavior> SearchBehaviors { get; set; }
Property Value
When searching in multi language fields, limit the searchable fields to the ones corresponding to the specified languages.
If not specified, all metadata languages in the system are used.
Declaration
[JsonProperty("searchLanguages", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public ICollection<string> SearchLanguages { get; set; }
Property Value
The string used to query the data. The Lucene query string syntax is supported.
Declaration
[JsonProperty("searchString", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public string SearchString { get; set; }
Property Value
Sorts the search results. Currently only sorting on the Names property is allowed.
Declaration
[JsonProperty("sort", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public ICollection<SortInfo> Sort { get; set; }
Property Value
Methods
Declaration
public static SchemaSearchRequest FromJson(string data)
Parameters
Returns