ExecuteSearch Operation

 

Client Declaration

Executes a query of a single object store or a merged scope.

Note that if you use multiple ExecuteSearch requests to page through the results for a query, consistency is not guaranteed.

 

Request

A subtype of the base, abstract SearchRequestType element (must be a PrincipalSearch or RepositorySearch element; StoredSearch is not supported), which specifies the following:

A typical structure of an ExecuteSearch request is as follows. Elements that are derived from their base element are in parenthesis:

SearchRequestType(PrincipalSearch) ExecuteSearchRequest
     PropertyFilterType SelectionFilter
          FilterElementType IncludeProperties[0]
          FilterElementType IncludeProperties[1]
               .
               .
          FilterElementType IncludeTypes[0]
          FilterElementType IncludeTypes[1]
               .
               .

 

Response

ExecuteSearch has the following output, depending on whether it is successful or not:

A typical structure of an ExecuteSearch response is as follows. Elements that are derived from their base element are in parenthesis:

ObjectSetType ObjSetType
     CollectionTerminatorType(EndofPage) CollectionTerminator   
     ObjectValue Object[0]
          PropertyType(SingletonString) Property[0]
          PropertyType(SingletonInteger32) Property[1]              
               .
               .
     ObjectValue Object[1]
          PropertyType(SingletonString) Property[0]
          PropertyType(SingletonInteger32) Property[1]               
               .
               .

 

XML Schema

<operation name="ExecuteSearch">   
   <input message="tns:ExecuteSearchRequest"/>   
   <output message="tns:ExecuteSearchResponse"/>   
   <fault message="tns:FaultResponse" name="GeneralError"/>
</operation>