Формат пакета поискового запроса
Contents
В секции Query задаются общие параметры поиска.
Структура секции:
<Query xmlns="http://docs.npo-comp.ru/IntegrationServices/5.6/Models">
<Type>{Тип объектов для поиска}</Type>
<CardType>{Код типа карточки}</CardType>
<ReferenceName>{Имя справочника}</ReferenceName>
<Select>
<Skip>{Количество первых записей, которые не попадут в результат поиска}</Skip>
<Top>{Количество первых записей, которые будут возвращены в результат поиска}</Top>
<Requisites>
<Requisite>{Имя реквизита}</Requisite>
</Requisites>
</Select>
<Where>
<Operation>{Список операторов}</Operation>
</Where>
<OrderBy>
<Requisite>{Имя реквизита для сортировки}</Requisite>
<Direction>Ascending</Direction>
</OrderBy>
</Query>
Type. Тип объектов для поиска. Обязательный параметр. Возможные значения:
| • | EDocument – документ; |
| • | Reference – запись справочника. |
CardType. Код типа карточки. Параметр обязательный, если указан код внешней системы.
ReferenceName. Имя справочника системы DIRECTUM, который будет открываться при выполнении сценария.
Select – перечень реквизитов, возвращаемых при поиске.
Skip. Количество первых записей, которые будут пропущены и не попадут в результаты поиска. Параметр необязательный.
Top. Количество первых записей, которые будут возвращены в результатах поиска. Параметр необязательный.
Requisites – список реквизитов для выборки.
Requisite. Имя реквизита для выборки. Параметр необязательный. Если значение параметра не указано, то в результатах поиска будет отображаться полное описание объекта.
Where – раздел пакета, в котором перечисляются условия поиска.
Operation. Список операторов. Параметр необязательный. Не используется при выводе всех записей.
В качестве типов объединения критериев поиска могут передаваться операторы «And» или «Or». В качестве операторов сравнения критерия поиска и значения реквизита могут быть переданы:
| • | Value – значение критерия для поиска; |
| • | Like – содержит; |
| • | Eq – равно; |
| • | NEq – не равно; |
| • | Gt – больше; |
| • | Lt – меньше; |
| • | GEq – больше или равно; |
| • | LEq – меньше или равно; |
| • | IsNull – равно пустому значению Null; |
| • | IsNotNull – не равно пустому значению Null; |
| • | Contains – полнотекстовый поиск. Должен быть настроен полнотекстовый индекс. |
Если для реквизита типа «Справочник» указан оператор «Like», то поиск выполняется по значению реквизита, отображаемому в карточке документа.
OrderBy – список параметров для настройки сортировки результатов поиска.
Requisite. Имя реквизита для сортировки.
Direction. Направление сортировки результатов выполнения поиска. Возможные значения: Ascending, Descending.
Пример поиска по справочнику Работники с реквизитом Наименование, начинающимся с фрагмента «Иван» и отсортированным по наименованию.
<Query xmlns="http://docs.npo-comp.ru/IntegrationServices/5.6/Models"> |
Пример поиска по документам с типом карточки «ПЭА», созданным с 02.10.2012 пользователями, фамилия которых начинается на «Ивано», например, Иванов, Иванова. В результат поиска попадут найденные документы и их полное описание. |
| © Компания DIRECTUM, 2018 | Сообщество пользователей DIRECTUM |