Client Declaration
public ObjectSetType ExecuteSearch(SearchRequestType ExecuteSearchRequest)
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.
A subtype of the base, abstract SearchRequestType
element (must be a PrincipalSearch
or RepositorySearch
element; StoredSearch
is not supported), which specifies the following:
CollectionTerminator
element from a previously returned page. This value indicates the start point of the current page.A typical structure of an ExecuteSearch
request is as follows. Elements that are derived from their base element are in parenthesis:
SearchRequestType
(PrincipalSearch
) ExecuteSearchRequestPropertyFilterType
SelectionFilterFilterElementType
IncludeProperties[0]FilterElementType
IncludeProperties[1] . .FilterElementType
IncludeTypes[0]FilterElementType
IncludeTypes[1] . .
ExecuteSearch
has the following output, depending on whether it is successful or not:
ObjectSetType
element, which specifies the following:
CollectionTerminatorType
base, abstract element, which resolves to one the following concrete subtypes, depending on the navigation status within the object set collection:
EndOfCollection
: The last result row is included in this response.EndOfPage
: The object set contains the maximum number of object elements (page size) requested by the client.TraversalError
: A error has occurred in traversing the object set.ObjectValue
elements, each representing a object selected by the query. Each element specifies the following:ErrorStackType
element is returned. A typical structure of an ExecuteSearch
response is as follows. Elements that are derived from their base element are in parenthesis:
ObjectSetType
ObjSetTypeCollectionTerminatorType
(EndofPage
) CollectionTerminatorObjectValue
Object[0]PropertyType
(SingletonString
) Property[0]PropertyType
(SingletonInteger32
) Property[1] . .ObjectValue
Object[1]PropertyType
(SingletonString
) Property[0]PropertyType
(SingletonInteger32
) Property[1] . .
<operation name="ExecuteSearch"> <input message="tns:ExecuteSearchRequest"/> <output message="tns:ExecuteSearchResponse"/> <fault message="tns:FaultResponse" name="GeneralError"/> </operation>