Verwenden des Query-Webdiensts

Letzte Änderung: Dienstag, 20. Juli 2010

Gilt für: SharePoint Server 2010

Zugreifen auf den Query-Webdienst

Der Webdienstabfrage befindet sich in folgendem Pfad:

https://Server_Name/[sites/][Site_Name/]_vti_bin/search.asmx

Mit einem Entwicklungstool wie z. B. Microsoft Visual Studio können Sie eine Clientanwendung für den Zugriff auf den Query-Webdienst erstellen. In der Visual Studio-Entwicklungsumgebung können Sie automatisch eine Proxyklasse für den Zugriff auf den Query-Webdienst generieren, indem Sie Ihrer Clientanwendung einen Webverweis hinzufügen. Schrittweise Anleitungen zum Hinzufügen eines Webverweises zum Query-Webdienst mithilfe von Microsoft Visual Studio 2010 finden Sie unter Gewusst wie: Hinzufügen eines Webverweises zum Query-Webdienst.

Alternativ können Sie mit dem Web Services Description Language (WSDL)-Tool einen Proxy für den Query-Webdienst generieren. Weitere Informationen finden Sie unter Web Services Description Language Tool (Wsdl.exe) und Creating an XML Web Service Proxy. Weitere Informationen zum Erstellen von Clientanwendungen, die Webdienste aufrufen, finden Sie unter Building XML Web Service Clients.

Webmethoden

In der folgenden Tabelle werden die im Webdienstabfrage verfügbaren Webmethoden beschrieben.

Query-Methoden

Der Webdienstabfrage enthält zwei Methoden zum Abrufen von Suchergebnissen: Query und QueryEx. Für beide Methoden ist die gleiche Eingabe zulässig, nämlich eine Zeichenfolge mit XML zur Angabe der Suchabfrageparameter. Das Format der zurückgegebenen Ergebnisse ist jedoch unterschiedlich.

Auswählen der Query-Methode für den Webdienst

Sie müssen die QueryEx-Methode verwenden, um in den Suchergebnissen mehrere Ergebnistypen zurückzugeben, wie z. B. relevante Ergebnisse, besondere Ausdrücke und Einschränkungsergebnisse.

Erstellen des XML-Codes für die Suchabfrage

Das XML-Format für die Suchabfrage wird im Microsoft.Search.Query-Schema definiert.

Die eigentliche Suchabfrage wird im "QueryText"-Element im "Microsoft.Search.Query"-Schema angegeben. Sie geben die Abfragesyntax an, die im type-Attribut des QueryText-Elements verwendet wird. Informationen zur Abfragesyntax der SharePoint-Unternehmenssuche finden Sie unter Erstellen von Suchabfragen.

Das folgende Codebeispiel enthält Beispiel-XML für das QueryText-Element, mit dem mithilfe von SQL-Syntax eine Suchabfrage definiert wird.

<QueryText language=xml:lang type='MSSQLFT'>
SELECT Title, Path, Description, Write, Rank, Size FROM Scope() WHERE CONTAINS(Description,'SharePoint')
</QueryText>

Hinweis
Wenn Sie SQL-Syntax mit der Query-Methode verwenden, müssen Sie die folgenden Eigenschaften in der SELECT-Anweisung der SQL-Abfrage angeben: Title, Path, Description, Write, Rank und Size.

Das folgende Codebeispiel enthält Beispiel-XML für das QueryText-Element, mit dem mithilfe von Schlüsselwortsyntax eine Suchabfrage definiert wird.

<QueryText language=xml:lang type='STRING'>
SharePoint
</QueryText>

Hinweis
Beim XML gibt es einige Unterschiede, je nachdem, ob Sie die SharePoint Server-Suche oder FAST Search Server 2010 for SharePoint als Suchanbieter verwenden. Dies ist für jedes Element explizit in einem "Gilt für"-Abschnitt angegeben.

Mit dem Property-Element im Microsoft.Search.Query-Schema-Element können Sie angeben, welche Eigenschaften für die Stichwortabfrage zurückgegeben werden sollen.

Falls Sie im Abfrage-XML keine Eigenschaften angeben, wird ein Standardsatz von Eigenschaften zurückgegeben.

Die folgenden Standardeigenschaften werden für die Query-Methode zurückgegeben:

• Title

• Description

• Date

• Relevance

Die folgenden Standardeigenschaften werden für die QueryEx-Methode zurückgegeben, wenn die SharePoint Server-Suche als Suchanbieter verwendet wird:

• WorkId

• Rank

• Title

• Author

• Size

• Path

• Description

• Write

• SiteName

• CollapsingStatus

• HitHighlightedSummary

• HitHighlightedProperties

• ContentClass

• IsDocument

• PictureThumbnailURL

Die folgenden Standardeigenschaften werden für die QueryEx-Methode zurückgegeben, wenn FAST Search Server 2010 for SharePoint als Suchanbieter verwendet wird:

• WorkId

• Rank

• Title

• Author

• Size

• Path

• Description

• Write

• SiteName

• CollapsingStatus

• HitHighlightedSummary

• HitHighlightedProperties

• ContentClass

• IsDocument

• PictureThumbnailURL

• Url

• ServerRedirectedUrl

• FileExtension

• SpSiteUrl

• docvector

• fcocount

• fcoid

• PictureWidth

• PictureHeight

Zurückgeben der Suchergebnisse

Mit der QueryEx-Methode werden die Suchergebnisse in einem DataSet-Objekt zurückgegeben, und mit der Query-Methode werden die Suchergebnisse in einer Zeichenfolge als XML zurückgegeben.

Hinweis
Von der Query-Methode werden als einziger Ergebnistyp relevante Ergebnisse unterstützt.

Query-Methode

Das Format für das von der Query-Methode zurückgegebene XML wird durch das Microsoft.Search.Response-Schema und das "Microsoft.Search.Response.Document"-Schema definiert. Die vollständigen Suchergebnisse finden Sie im Results-Element im Microsoft.Search.Response-Schema, wo jedes einzelne Ergebnis durch ein Document-Element im Microsoft.Search.Response.Document-Schema dargestellt wird.

QueryEx-Methode

Das von der QueryEx-Methode zurückgegebene DataSet-Objekt enthält ExtendedProperties-Eigenschaften, die zusätzliche Informationen zur Abfrage liefern. In Tabelle 1 werden die zurückgegebenen erweiterten Eigenschaften beschrieben.

Tabelle 1. Erweiterte Eigenschaften

Das zurückgegebene Dataset kann bis zu fünf Datentabellen enthalten, die in Tabelle 2 beschrieben werden. Abhängig ist dies von den in der QueryEx-Anforderung angegebenen Optionen sowie vom Suchanbieter.

Tabelle 2. Tabellen, die im für "QueryEx" zurückgegebenen Dataset enthalten sind