Operación GetDiscoverySearchConfiguration
Busque información sobre la operación EWS GetDiscoverySearchConfiguration .
La operación GetDiscoverySearchConfiguration devuelve información de configuración para las retenciones en contexto, las búsquedas de detección guardadas y los buzones habilitados para la búsqueda de detección.
Esta operación se introdujo en Exchange Server 2013.
Uso de la operación GetDiscoverySearchConfiguration
La operación GetDiscoverySearchConfiguration proporciona información de configuración para la búsqueda de detección. Las solicitudes pueden contener uno o varios de los argumentos siguientes:
SearchId : identifica una búsqueda de detección guardada. Si este argumento se envía en la solicitud, se omiten los valores de los demás argumentos.
ExpandGroupMembership : indica si la pertenencia a grupos se expande en la respuesta. Un valor de true indica que la pertenencia a grupos se expande para que todos los buzones que se pueden buscar se devuelvan en la respuesta. Un valor de false indica que solo se devuelve el grupo en la respuesta.
InPlaceHoldConfigurationOnly : indica si se devuelven todos los buzones que se pueden buscar además de la configuración de retención local. Un valor de true indica que solo se devuelven las configuraciones de retención local. Un valor de false indica que todos los identificadores de buzón que se pueden buscar se devuelven además de los identificadores de retención local. Si este elemento no está presente, el comportamiento predeterminado es el equivalente del valor false.
Encabezados SOAP de la operación GetDiscoverySearchConfiguration
La operación GetDiscoverySearchConfiguration puede usar los encabezados SOAP que aparecen en la tabla siguiente.
| Nombre de encabezado | Elemento | Descripción |
|---|---|---|
| ManagementRole |
ManagementRole |
Identifica los roles de servidor necesarios para que el autor de la llamada realice la solicitud. Este encabezado es aplicable a una solicitud. |
| RequestVersion |
RequestServerVersion |
Identifica la versión del esquema de la solicitud de operación. Este encabezado es aplicable a una solicitud. |
| ServerVersion |
ServerVersionInfo |
Identifica la versión del servidor que respondió a la solicitud. Este encabezado se aplica a una respuesta. |
Ejemplo de solicitud de operación GetDiscoverySearchConfiguration: obtener la configuración de búsqueda de detección para una búsqueda guardada
En el ejemplo siguiente de una solicitud de operación GetDiscoverySearchConfiguration se muestra cómo solicitar la configuración de una búsqueda guardada denominada "MyDiscSearchFor-sbrown". Los argumentos de los elementos ExpandGroupMembership e InPlaceHoldConfigurationOnly se omiten.
<?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>
El cuerpo SOAP de la solicitud contiene los siguientes elementos:
Respuesta correcta de la operación GetDiscoverySearchConfiguration: solicitud de una única búsqueda guardada
En el ejemplo siguiente se muestra una respuesta correcta a una solicitud de operación GetDiscoverySearchConfiguration para obtener la configuración de una búsqueda guardada denominada "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>
El cuerpo soap de respuesta contiene los siguientes elementos:
Respuesta correcta de la operación GetDiscoverySearchConfiguration: solicitud de retenciones en contexto
En el ejemplo siguiente se muestra una respuesta correcta a una solicitud de operación GetDiscoverySearchConfiguration para obtener solo retenciones en contexto.
<?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>
El cuerpo soap de respuesta contiene los siguientes elementos:
Respuesta correcta de la operación GetDiscoverySearchConfiguration: solicitud de todas las configuraciones de búsqueda de detección guardadas
En el ejemplo siguiente se muestra una respuesta correcta a una solicitud de operación GetDiscoverySearchConfiguration para obtener todas las búsquedas de detección guardadas.
<?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>
El cuerpo soap de respuesta contiene los siguientes elementos:
Respuesta de error de la operación GetDiscoverySearchConfiguration
En el ejemplo siguiente se muestra una respuesta de error a una solicitud de operación GetDiscoverySearchConfiguration . Se trata de una respuesta a una solicitud para obtener una búsqueda guardada que no se encuentra en el servidor.
<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>
El cuerpo SOAP de la respuesta de error contiene los siguientes elementos:
Para obtener códigos de error adicionales que son genéricos para EWS y específicos de esta operación, vea ResponseCode.