Операция GetDiscoverySearchConfiguration
Найдите сведения об операции GetDiscoverySearchConfiguration EWS.
Операция GetDiscoverySearchConfiguration возвращает сведения о конфигурации для удержаний на месте, сохраненных поисковых запросов обнаружения и почтовых ящиков, в которых включен поиск обнаружения.
Эта операция появилась в Exchange Server 2013.
Использование операции GetDiscoverySearchConfiguration
Операция GetDiscoverySearchConfiguration предоставляет сведения о конфигурации для поиска обнаружения. Запросы могут содержать один или несколько из следующих аргументов:
SearchId — определяет сохраненный поиск обнаружения. Если этот аргумент отправляется в запросе, значения других аргументов игнорируются.
ExpandGroupMembership — указывает, расширяется ли членство в группе в ответе. Значение true указывает, что членство в группе расширено, чтобы в ответе возвращались все почтовые ящики с возможностью поиска. Значение false указывает, что в ответе возвращается только группа.
InPlaceHoldConfigurationOnly — указывает, возвращаются ли все почтовые ящики с возможностью поиска в дополнение к конфигурации удержания на месте. Значение true указывает, что возвращаются только конфигурации удержания на месте. Значение false указывает, что все доступные для поиска идентификаторы почтовых ящиков возвращаются в дополнение к идентификаторам удержания на месте. Если этот элемент отсутствует, поведение по умолчанию эквивалентно значению false.
Заголовки SOAP операции GetDiscoverySearchConfiguration
Операция GetDiscoverySearchConfiguration может использовать заголовки SOAP, перечисленные в следующей таблице.
Имя заголовка | Элемент | Описание |
---|---|---|
ManagementRole |
ManagementRole |
Определяет роли сервера, необходимые для выполнения вызывающей стороны запроса. Этот заголовок применим к запросу. |
RequestVersion |
RequestServerVersion |
Определяет версию схемы для запроса операции. Этот заголовок применим к запросу. |
ServerVersion |
ServerVersionInfo |
Определяет версию сервера, который ответил на запрос. Этот заголовок применим к ответу. |
Пример запроса на операцию GetDiscoverySearchConfiguration: получение конфигурации поиска обнаружения для сохраненного поиска
В следующем примере запроса на операцию GetDiscoverySearchConfiguration показано, как запросить конфигурацию сохраненного поиска с именем MyDiscSearchFor-sbrown. Аргументы для элементов ExpandGroupMembership и InPlaceHoldConfigurationOnly игнорируются.
<?xml version="1.0" encoding="UTF-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:t="http://schemas.microsoft.com/exchange/services/2006/types"
xmlns:m="http://schemas.microsoft.com/exchange/services/2006/messages">
<soap:Header>
<t:RequestServerVersion Version="Exchange2013" />
</soap:Header>
<soap:Body >
<m:GetDiscoverySearchConfiguration>
<m:SearchId>MyDiscSearchFor-sbrown</m:SearchId>
<m:ExpandGroupMembership>true</m:ExpandGroupMembership>
<m:InPlaceHoldConfigurationOnly>false</m:InPlaceHoldConfigurationOnly>
</m:GetDiscoverySearchConfiguration>
</soap:Body>
</soap:Envelope>
Текст SOAP запроса содержит следующие элементы:
Успешный ответ на операцию GetDiscoverySearchConfiguration: запрос на один сохраненный поиск
В следующем примере показан успешный ответ на запрос операции GetDiscoverySearchConfiguration для получения конфигурации сохраненного поиска с именем MyDiscSearchFor-sbrown.
<?xml version="1.0" encoding="utf-8"?>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header>
<h:ServerVersionInfo MajorVersion="15" MinorVersion="0" MajorBuildNumber="526" MinorBuildNumber="0" Version="Exchange2013" xmlns:h="http://schemas.microsoft.com/exchange/services/2006/types" xmlns="http://schemas.microsoft.com/exchange/services/2006/types" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
</s:Header>
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<GetDiscoverySearchConfigurationResponse ResponseClass="Success" xmlns="http://schemas.microsoft.com/exchange/services/2006/messages">
<ResponseCode>NoError</ResponseCode>
<DiscoverySearchConfigurations>
<DiscoverySearchConfiguration xmlns="http://schemas.microsoft.com/exchange/services/2006/types">
<SearchId>MyDiscSearchFor-sbrown</SearchId>
<SearchQuery>test item</SearchQuery>
<SearchableMailboxes>
<SearchableMailbox>
<Guid>3c620d04-8b22-432e-92be-5b9321599576</Guid>
<PrimarySmtpAddress>SBrown@contoso.com</PrimarySmtpAddress>
<IsExternalMailbox>false</IsExternalMailbox>
<ExternalEmailAddress/>
<DisplayName>Steven Brown</DisplayName>
<IsMembershipGroup>false</IsMembershipGroup>
<ReferenceId>/o=First/ou=Exchange(FYDILT)/cn=Recipients/cn=313ecf-Steve</ReferenceId>
</SearchableMailbox>
</SearchableMailboxes>
</DiscoverySearchConfiguration>
</DiscoverySearchConfigurations>
</GetDiscoverySearchConfigurationResponse>
</s:Body>
</s:Envelope>
Текст SOAP ответа содержит следующие элементы:
Успешный ответ на операцию GetDiscoverySearchConfiguration: запрос на удержание на месте
В следующем примере показан успешный ответ на запрос операции GetDiscoverySearchConfiguration , чтобы получить только удержание на месте.
<?xml version="1.0" encoding="utf-8"?>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header>
<h:ServerVersionInfo MajorVersion="15"
MinorVersion="0"
MajorBuildNumber="526"
MinorBuildNumber="0"
Version="Exchange2013"
xmlns:h="http://schemas.microsoft.com/exchange/services/2006/types"
xmlns="http://schemas.microsoft.com/exchange/services/2006/types"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
</s:Header>
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<GetDiscoverySearchConfigurationResponse ResponseClass="Success"
xmlns="http://schemas.microsoft.com/exchange/services/2006/messages">
<ResponseCode>NoError</ResponseCode>
<DiscoverySearchConfigurations>
<DiscoverySearchConfiguration xmlns="http://schemas.microsoft.com/exchange/services/2006/types">
<SearchId>MyDiscSearchFor-sbrown</SearchId>
<SearchQuery>test item</SearchQuery>
<InPlaceHoldIdentity>3f37d90f53144558a80814ef0272749a9</InPlaceHoldIdentity>
<ManagedByOrganization/>
</DiscoverySearchConfiguration>
<DiscoverySearchConfiguration xmlns="http://schemas.microsoft.com/exchange/services/2006/types">
<SearchId>MyDiscSearch</SearchId>
<SearchQuery>test</SearchQuery>
<InPlaceHoldIdentity>6ea486f0f3f140efb044682a2e782abdf</InPlaceHoldIdentity>
<ManagedByOrganization/>
</DiscoverySearchConfiguration>
</DiscoverySearchConfigurations>
</GetDiscoverySearchConfigurationResponse>
</s:Body>
</s:Envelope>
Текст SOAP ответа содержит следующие элементы:
Успешный ответ на операцию GetDiscoverySearchConfiguration: запрос всех сохраненных конфигураций поиска обнаружения
В следующем примере показан успешный ответ на запрос операции GetDiscoverySearchConfiguration для получения всех сохраненных поисковых запросов обнаружения.
<?xml version="1.0" encoding="utf-8"?>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header>
<h:ServerVersionInfo MajorVersion="15"
MinorVersion="0"
MajorBuildNumber="526"
MinorBuildNumber="0"
Version="Exchange2013"
xmlns:h="http://schemas.microsoft.com/exchange/services/2006/types"
xmlns="http://schemas.microsoft.com/exchange/services/2006/types"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
</s:Header>
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<GetDiscoverySearchConfigurationResponse ResponseClass="Success"
xmlns="http://schemas.microsoft.com/exchange/services/2006/messages">
<ResponseCode>NoError</ResponseCode>
<DiscoverySearchConfigurations>
<DiscoverySearchConfiguration xmlns="http://schemas.microsoft.com/exchange/services/2006/types">
<SearchId>MyDiscSearchFor-sbrown</SearchId>
<SearchQuery>test item</SearchQuery>
<SearchableMailboxes>
<SearchableMailbox>
<Guid>3c620d04-8b33-435e-95be-5b9351599576</Guid>
<PrimarySmtpAddress>SBrown@contoso.com</PrimarySmtpAddress>
<IsExternalMailbox>false</IsExternalMailbox>
<ExternalEmailAddress/>
<DisplayName>Steven Brown</DisplayName>
<IsMembershipGroup>false</IsMembershipGroup>
<ReferenceId>/o=First/ou=Exchange (FYLT)/cn=Recipients/cn=35381a742f0e47e395c8601a60d13ecz-Steve</ReferenceId>
</SearchableMailbox>
</SearchableMailboxes>
</DiscoverySearchConfiguration>
<DiscoverySearchConfiguration xmlns="http://schemas.microsoft.com/exchange/services/2006/types">
<SearchId>MyDiscSearch</SearchId>
<SearchQuery>test</SearchQuery>
<SearchableMailboxes>
<SearchableMailbox>
<Guid>e788c4b0-54a2-458c-83b2-22d5bb02b23f</Guid>
<PrimarySmtpAddress>Administrator@contoso.com</PrimarySmtpAddress>
<IsExternalMailbox>false</IsExternalMailbox>
<ExternalEmailAddress/>
<DisplayName>Administrator</DisplayName>
<IsMembershipGroup>false</IsMembershipGroup>
<ReferenceId>/o=First/ou=Exchange (FYLT)/cn=Recipients/cn=ebez7871332d4595abe1c62962911a58-Admin</ReferenceId>
</SearchableMailbox>
<SearchableMailbox>
<Guid>6f6cff39-8967-4a60-b43f-328413c25199</Guid>
<PrimarySmtpAddress>ADavis@contoso.com</PrimarySmtpAddress>
<IsExternalMailbox>false</IsExternalMailbox>
<ExternalEmailAddress/>
<DisplayName>Anthony Davis</DisplayName>
<IsMembershipGroup>false</IsMembershipGroup>
<ReferenceId>/o=First/ou=Exchange (FYLT)/cn=Recipients/cn=f10c9f70519844beb04101d8f40c572z-Antho</ReferenceId>
</SearchableMailbox>
</SearchableMailboxes>
</DiscoverySearchConfiguration>
</DiscoverySearchConfigurations>
</GetDiscoverySearchConfigurationResponse>
</s:Body>
</s:Envelope>
Текст SOAP ответа содержит следующие элементы:
Ответ на ошибку операции GetDiscoverySearchConfiguration
В следующем примере показан ответ на ошибку на запрос операции GetDiscoverySearchConfiguration . Это ответ на запрос на получение сохраненного поиска, который не найден на сервере.
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header>
<h:ServerVersionInfo MajorVersion="15"
MinorVersion="0"
MajorBuildNumber="526"
MinorBuildNumber="0"
Version="Exchange2013"
xmlns:h="http://schemas.microsoft.com/exchange/services/2006/types"
xmlns="http://schemas.microsoft.com/exchange/services/2006/types"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
</s:Header>
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<GetDiscoverySearchConfigurationResponse ResponseClass="Error"
xmlns="http://schemas.microsoft.com/exchange/services/2006/messages">
<MessageText>Search configuration corresponding to the search id was not found.</MessageText>
<ResponseCode>ErrorInvalidArgument</ResponseCode>
<DescriptiveLinkKey>0</DescriptiveLinkKey>
<DiscoverySearchConfigurations/>
</GetDiscoverySearchConfigurationResponse>
</s:Body>
</s:Envelope>
Текст soap ответа на ошибку содержит следующие элементы:
Дополнительные коды ошибок, которые являются общими для EWS и относятся к этой операции, см. в разделе ResponseCode.