Class ContentAggregationOnChannelRequest
Request to aggregate contents based on the aggregators defined on a channel
Inheritance
ContentAggregationOnChannelRequest
Namespace: System.Dynamic.ExpandoObject
Syntax
[GeneratedCode("NJsonSchema", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")]
public class ContentAggregationOnChannelRequest
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
Limits the aggregation to the contents that have or not have broken references. By default it includes both.
Declaration
[JsonProperty("brokenDependenciesFilter", Required = Required.Always)]
[Required(AllowEmptyStrings = true)]
[JsonConverter(typeof(StringEnumConverter))]
public BrokenDependenciesFilter BrokenDependenciesFilter { get; set; }
Property Value
Limits the simple search fields to the fields available in the specified channel. Defaults to RootChannel.
For the ContentAggregationOnChannelRequest only, the existing aggregation saved on the channel are retrieved and used to perform the aggregation.
Declaration
[JsonProperty("channelId", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public string ChannelId { get; set; }
Property Value
Limit the search to the contents belonging to the specified collection.
Declaration
[JsonProperty("collectionId", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public string CollectionId { get; set; }
Property Value
An optional search filter. Limits the document result set.
Declaration
[JsonProperty("filter", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public FilterBase Filter { get; set; }
Property Value
Limits the aggregation to the contents that have the specified life cycle state. Defaults to ActiveOnly.
Declaration
[JsonProperty("lifeCycleFilter", Required = Required.Always)]
[Required(AllowEmptyStrings = true)]
[JsonConverter(typeof(StringEnumConverter))]
public LifeCycleFilter LifeCycleFilter { get; set; }
Property Value
An optional list of search behaviors. All the passed behaviors will be applied.
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 defined in the system are used.
Declaration
[JsonProperty("searchLanguages", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public ICollection<string> SearchLanguages { get; set; }
Property Value
Limits the search by using a query string filter. The Lucene query string syntax is supported.
Declaration
[JsonProperty("searchString", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public string SearchString { get; set; }
Property Value
Type of search to be performed: search only in metadata, only in the extracted fulltext from the file or both. Default to Metadata.
Declaration
[JsonProperty("searchType", Required = Required.Always)]
[Required(AllowEmptyStrings = true)]
[JsonConverter(typeof(StringEnumConverter))]
public ContentSearchType SearchType { get; set; }
Property Value
Methods
Declaration
public static ContentAggregationOnChannelRequest FromJson(string data)
Parameters
Returns