SearchAggregationItemsRequest — класс

Объект запроса.

Синтаксис

public abstract class SearchAggregationItemsRequest

Свойства

Имя Описание

ResultType

Тип получаемого результата: All — вернуть список агрегатов и сохранить результаты фильтрации в папку; Aggregation — вернуть только список агрегатов; Cards — только сохранить результаты фильтрации в папку.

FolderId

Идентификатор папки-хранилища для сохранения результатов фильтрации.

`QueryXml

Xml поиска. Должно быть заполнено как минимум поле QueryString полнотекстового поиска. Также могут быть использованы любые другие части — как и сам атрибутивный поиск, так и ограничения по результатам (ограничение на папку например).

QueryXml можно не заполнять, но в таком случае не будет заполнена папка результатами поиска, но список агрегатов вернётся.

QueryId

Идентификатор поиска. Альтернатива QueryXml. Если он не Guid.Empty, будет использоваться именно сохранённый запрос.

Parameters

Список параметров для запроса. Может использоваться как с QueryId, так и с QueryXml. В случае QueryXml параметры можно включить непосредственно в запрос.

LocaleId

Номер локализации в которой необходимо вернуть имя агрегации. Если значение не задано или не найдено в настройках агрегата, то будет использоваться английская локаль. Если английская локаль не найдена, то будет использоваться первая найденная. Если настройки не заданы вообще, то в качестве значения будет использоваться алиас агрегата.

Filters

Значения для дополнительной фильтрации результатов. Ключ — алиас агрегата, значение — текст для фильтрации. Текст для фильтрации необходимо передавать как сериализованный в JSON список (даже если элемент всего один). См. пример.

Фильтрация работает по полному совпадению переданного текста со значениями полей, указанных в соответствующем агрегате. При наличии нескольких полей результаты соединяются по условию "ИЛИ".