Übersicht über die REST-API der SharePoint-SucheSharePoint Search REST API overview

Fügen Sie Suchfunktionen zu Client- und mobilen Anwendungen hinzu, mit dem Search-REST-Dienst in SharePoint und jeder Technologie, die REST-Webanforderungen unterstützt.Add search functionality to client and mobile applications using the Search REST service in SharePoint and any technology that supports REST web requests.

Wenn Sie eine Abfrage im Zusammenhang mit einer SharePoint Online-Benutzer durchführen erhalten Sie Ergebnisse von:When you query in the context of a SharePoint Online user, you get results from:

  • Inhalte in SharePoint Server-WebsitesammlungenContent in SharePoint Online site collections
  • Inhalte in Office 365-GruppenContent in Office 365 Groups
  • Freigegebene Inhalte von OneDrive for Business (Inhalte, die für andere als den Besitzer von OneDrive for Business zugänglich sind)Shared OneDrive for Business content (content that's accessible for others than the owner of the OneDrive for Business)
  • Inhalte von SharePoint Server, die über eine Cloud-Suchdienstanwendung indiziert wurden.Content from SharePoint Server that's been indexed via a cloud search Service application. Informationen über die CloudhybridsucheLearn about cloud hybrid search.

Wenn Ihre Benutzer auch Ergebnisse von OneDrive for Business, auf das nur sie Zugriff haben, erwarten, können Sie den Parameter ContentSetting verwenden, um dies zu ermöglichen.If your users also expect results from OneDrive for Business content that only they have access to, you can use the ContentSetting parameter to achieve this.

Erstellen von Abfragen mit dem Search-REST-DienstQuerying with the Search REST service

Die Suche in SharePoint enthält einen Search-REST-Dienst, mit dem Sie Suchfunktionen zu Ihren Client- und mobilen Anwendungen hinzufügen können. Verwenden sie dazu eine beliebige Technologie, die REST-Webanforderungen unterstützt. Mit dem Search-REST-Dienst können Sie Keyword Query Language (KQL)- oder FAST Query Language (FQL)-Abfragen in Ihren SharePoint-Add-Ins, Remoteclientanwendungen, mobilen Anwendungen und anderen Anwendungen senden.Der Search-REST-Dienst unterstützt POST- und GET-HTTP-Anforderungen.Search in SharePoint includes a Search REST service you can use to add search functionality to your client and mobile applications by using any technology that supports REST web requests. You can use the Search REST service to submit Keyword Query Language (KQL) or FAST Query Language (FQL) queries in your SharePoint Add-ins, remote client applications, mobile applications, and other applications.

GET-AnforderungenGET requests

Erstellen Sie den URI für GETAbfrageanforderungen hinsichtlich des Search-REST-Diensts wie folgt:Construct the URI for query GET requests to the Search REST service as follows:

GET /_api/search/query

Für GET-Anforderungen geben Sie die Abfrageparameter in der URL an. Sie können die GET-Anforderungs-URL auf zwei Arten erstellen:For GET requests, you specify the query parameters in the URL. You can construct the GET request URL in two ways:

GET http://server/_api/search/query?query_parameter=value&query_parameter=value
GET http://server/_api/search/query(query_parameter=value&amp;query_parameter=<value>)

POST-AnforderungenPOST requests

Sie erstellen den URI für POST-Abfrageanforderungen hinsichtlich des Search-REST-Diensts wie folgt:You construct the URI for query POST requests to the Search REST service as follows:

POST /_api/search/postquery

Für POST-Anforderungen geben Sie die Abfrageparameter in der Anforderung im JavaScript Object Notation (JSON)-Format weiter.For POST requests, you pass the query parameters in the request in JavaScript Object Notation (JSON) format. Die POST-HTTP-Version des Search-REST-Diensts unterstützt alle Parameter, die von der GET-HTTP-Version unterstützt werden.The HTTP POST version of the Search REST service supports all parameters supported by the HTTP GET version. Einige der Parameter weisen jedoch unterschiedliche Datentypen auf, wie in Tabelle 1 beschrieben.However, some of the parameters have different data types, as described in Table 1.

Tabelle 1. Abfrageparameter mit unterschiedlichen Datentypen für POST-AnforderungenTable 1. Query parameters with different data types for POST requests

ParameterParameter DatentypData type
SelectPropertiesSelectProperties string[]string[]
RefinementFiltersRefinementFilters string[]string[]
SortListSortList SortSort
HitHighlightedPropertiesHithighlightedProperties string[]string[]
PropertiesProperties Microsoft.SharePoint.Client.Search.Query.KeywordQueryPropertiesMicrosoft.SharePoint.Client.Search.Query.KeywordQueryProperties

Verwenden Sie POST-Anforderungen in den folgenden Szenarios:Use POST requests in the following scenarios:

  • Bei Überschreitung der URL-Längenbeschränkung für eine GET-AnforderungWhen you'll exceed the URL length restriction with a GET request.
  • Wenn Sie die Abfrageparameter nicht in einer einfachen URL angeben können. Wenn Sie beispielsweise Parameterwerte weitergeben müssen, die ein Array eines komplexen Typs oder durch Kommas getrennte Zeichenfolgen enthalten, sind Sie bei der Erstellung der POST-Anforderung flexibler.When you can't specify the query parameters in a simple URL. For example, if you have to pass parameter values that contain a complex type array, or comma-separated strings, you have more flexibility when constructing the POST request.
  • Bei Verwendung des ReorderingRules-Parameters, da er nur für POST-Anforderungen unterstützt wirdWhen you use the ReorderingRules parameter because it is supported only with POST requests.

Format der Search-REST-ErgebnisseSearch REST results format

Standardmäßig werden Ergebnisse im XML-Format zurückgegeben.By default, results are returned in XML format. Um die Ergebnisse im JSON-Format zu erhalten, fügen Sie Ihrer Anforderung den folgenden Header hinzu:To get results in JSON format, add the following header to your request:

accept: application/json;odata=verbose

Wenn Sie keine Metadaten benötigen, können Sie stattdessen Folgendes verwenden:If you don't need metadata, you can instead use:

accept: application/json;odata=nometadata

Verwenden von Abfrageparametern für den Search-REST-DienstUsing query parameters with the Search REST service

Wenn Sie den Search-REST-Dienst aufrufen, geben Sie Abfrageparameter für die Anforderung an.When you make a call to the Search REST service, you specify query parameters with the request. Suche in SharePoint verwendet diese Abfrageparameter, um die Suchabfrage zu erstellen.Search in SharePoint uses these query parameters to construct the search query. Für eine GET-Anforderung geben Sie die Abfrageparameter in der URL an.With a GET request, you specify the query parameters in the URL. Für POST-Anforderungen geben Sie die Abfrageparameter im Textkörper im JavaScript Object Notation (JSON)-Format weiter.For POST requests, you pass the query parameters in the body in JavaScript Object Notation (JSON) format. In den folgenden Abschnitten werden die Abfrageparameter beschrieben, mit denen Sie Suchabfragen mit dem Search-REST-Dienst senden können.The following sections describe the query parameters you can use to submit search queries with the Search REST service.

QueryText-ParameterQueryText parameter

Eine Zeichenfolge, die den Text für die Suchabfrage enthältA string that contains the text for the search query.

Beispiel für GET-AnforderungSample GET request

GET http://{server}/_api/search/query?querytext='sharepoint'

Beispiel für POST-AnforderungSample POST request

{
  'request': {
    'Querytext': 'sharepoint',
    'RowLimit': 20,
    'ClientType': 'ContentSearchRegular'
  }
}

QueryTemplateQueryTemplate

Eine Zeichenfolge, die den Text enthält, der den Abfragetext ersetzt (als Teil einer Abfragetransformation)A string that contains the text that replaces the query text, as part of a query transform.

Beispiel für GET-AnforderungSample GET request

GET http://server/_api/search/query?querytext='sharepoint'&amp;querytemplate='{searchterms} author:johndoe'

Beispiel für POST-AnforderungSample POST request

{
  '__metadata': {
      'type': 'Microsoft.Office.Server.Search.REST.SearchRequest'
   },
  'Querytext': 'sharepoint',
  'Querytemplate': '{searchterms} Author:johndoe'
}

EnableInterleavingEnableInterleaving

Ein boolescher Wert, der angibt, ob die für den Ergebnisblock zurückgegebenen Ergebnistabellen mit den für die ursprüngliche Abfrage zurückgegebenen Ergebnistabellen kombiniert werdenA Boolean value that specifies whether the result tables that are returned for the result block are mixed with the result tables that are returned for the original query.

true zum Kombinieren der Ergebnistabellen; andernfalls false. Der Standardwert ist true.true to mix the ResultTables; otherwise, false. The default value is true.

Ändern Sie diesen Wert nur, wenn Sie Ihre eigene überlappende Implementierung bereitstellen möchten.Change this value only if you want to provide your own interleaving implementation.

Beispiel für GET-AnforderungSample GET request

GET http:// _server_/_api/search/query?querytext='sharepoint'&amp;enableinterleaving=true

Beispiel für POST-AnforderungSample POST request

{
  '__metadata': {
      'type': 'Microsoft.Office.Server.Search.REST.SearchRequest'
  },
  'Querytext': 'sharepoint',
  'EnableInterleaving': 'True'
}

SourceIdSourceId

Ergebnis-Quell-ID für Ausführung der SuchabfrageThe result source ID to use for executing the search query.

Beispiel für GET-AnforderungSample GET request

GET http:// _server_/_api/search/query?querytext='sharepoint'&amp;sourceid='8413cd39-2156-4e00-b54d-11efd9abdb89'

Beispiel für POST-AnforderungSample POST request

{
  '__metadata': {
    'type': 'Microsoft.Office.Server.Search.REST.SearchRequest'
  },
  'Querytext': 'sharepoint',
  'SourceId': '8413cd39-2156-4e00-b54d-11efd9abdb89'
}

RankingModelIdRankingModelId

ID des Rangfolgemodells für die AbfrageThe ID of the ranking model to use for the query.

Beispiel für GET-AnforderungSample GET request

GET http:// _server_/_api/search/query?querytext='sharepoint'&amp;rankingmodelid= _CustomRankingModelID_

Beispiel für POST-AnforderungSample POST request

{
  '__metadata': {
    'type': 'Microsoft.Office.Server.Search.REST.SearchRequest'
  },
  'Querytext': 'sharepoint',
  'RankingModelId': 'CustomRankingModelID '
}

StartRowStartRow

Erste Zeile, die in den Suchergebnissen enthalten ist, die zurückgegeben werden. Verwenden Sie diesen Parameter, wenn Sie die Seitenverwaltung für Suchergebnisse implementieren möchten.The first row that is included in the search results that are returned. You use this parameter when you want to implement paging for search results.

Beispiel für GET-AnforderungSample GET request

GET http:// _server_/_api/search/query?querytext='sharepoint'&amp;startrow=10

Beispiel für POST-AnforderungSample POST request

{
  '__metadata': {
    'type': 'Microsoft.Office.Server.Search.REST.SearchRequest'
  },
  'Querytext': 'sharepoint',
  'StartRow': '10'
}

RowLimitRowLimit

Maximale Anzahl von Zeilen, die in den Suchergebnissen zurückgegeben werden. Verglichen mit RowsPerPage ist RowLimit die maximale Anzahl zurückgegebener Zeilen.The maximum number of rows overall that are returned in the search results. Compared to RowsPerPage, RowLimit is the maximum number of rows returned overall.

Beispiel für GET-AnforderungSample GET request

GET http:// _server_/_api/search/query?querytext='sharepoint'&amp;rowlimit=30

Beispiel für POST-AnforderungSample POST request

{
  '__metadata': {
    'type': 'Microsoft.Office.Server.Search.REST.SearchRequest'
  },
  'Querytext': 'sharepoint',
  'RowLimit': '30'
}

RowsPerPageRowsPerPage

Maximale Anzahl von Zeilen, die pro Seite zurückgegeben werden. Verglichen mit RowLimit bezieht sich RowsPerPage auf die maximale Anzahl von Zeilen, die pro Seite zurückgegeben werden. "RowsPerPage" wird hauptsächlich verwendet, wenn Sie die Seitenverwaltung für Suchergebnisse implementieren möchten.The maximum number of rows to return per page. Compared to RowLimit, RowsPerPage refers to the maximum number of rows to return per page, and is used primarily when you want to implement paging for search results.

Beispiel für GET-AnforderungSample GET request

GET http:// _server_/_api/search/query?querytext='sharepoint'&amp;rowsperpage=10

Beispiel für POST-AnforderungSample POST request

{
  '__metadata': {
    'type': 'Microsoft.Office.Server.Search.REST.SearchRequest'
  },
  'Querytext': 'sharepoint',
  'RowsPerPage': '10'
}

SelectPropertiesSelectProperties

Verwaltete Eigenschaften, die in den Suchergebnissen zurückgegeben werden. Um eine verwaltete Eigenschaft zurückzugeben, stellen Sie das abrufbare Flag der Eigenschaft im Suchschema auf true ein.The managed properties to return in the search results. To return a managed property, set the property's retrievable flag to true in the search schema.

Für GET-Anforderungen können Sie den SelectProperties-Parameter in einer Zeichenfolge mit einer durch Kommas getrennten Liste von Eigenschaften angeben. Für POST-Anforderungen geben Sie den SelectProperties-Parameter als Zeichenfolgenarray an.For GET requests, you specify the SelectProperties parameter in a string containing a comma-separated list of properties. For POST requests, you specify the SelectProperties parameter as a string array.

Beispiel für GET-AnforderungSample GET request

GET http:// _server_/_api/search/query?querytext='sharepoint'&amp;selectproperties='Title,Author'

Beispiel für POST-AnforderungSample POST request

{
  '__metadata': {
    'type': 'Microsoft.Office.Server.Search.REST.SearchRequest'
  },
  'Querytext': 'sharepoint',
  'SelectProperties': {
    'results': ['Title','Author']
  }
}

KulturCulture

Gebietsschema-ID (LCID) für die Abfrage (siehe Von Microsoft zugewiesene Gebietsschema-IDs).The locale ID (LCID) for the query (see Locale IDs Assigned by Microsoft).

Beispiel für GET-AnforderungSample GET request

GET http:// _server_/_api/search/query?querytext='sharepoint'&amp;culture=1044

Beispiel für POST-AnforderungSample POST request

{
  '__metadata': {
    'type': 'Microsoft.Office.Server.Search.REST.SearchRequest'
  },
  'Querytext': 'sharepoint',
  'Culture': '1044'
}

RefinementFiltersRefinementFilters

Satz an Verfeinerungsfiltern für das Senden einer Verfeinerungsabfrage. Für GET-Anforderungen wird der RefinementFilters-Parameter als FQL-Filter angegeben. Für POST-Anforderungen wird der RefinementFilters-Parameter als Array von FQL-Filtern angegeben.The set of refinement filters used when issuing a refinement query. For GET requests, the RefinementFilters parameter is specified as an FQL filter. For POST requests, the RefinementFilters parameter is specified as an array of FQL filters.

Beispiel für GET-AnforderungSample GET request

GET http:// _server_/_api/search/query?querytext='sharepoint'&amp;refinementfilters='fileExtension:equals("docx")'

Beispiel für POST-AnforderungSample POST request

{
  '__metadata': {
    'type': 'Microsoft.Office.Server.Search.REST.SearchRequest'
  },
  'Querytext': 'sharepoint',
  'RefinementFilters': {
    'results': ['fileExtension:equals("docx")']
  }
}

EinschränkungenRefiners

Satz an Einschränkungen, die in einem Suchergebnis zurückgegeben werdenThe set of refiners to return in a search result.

Beispiel für GET-AnforderungSample GET request

GET http:// _server_/_api/search/query?querytext='sharepoint'&amp;refiners='author,size'

Beispiel für POST-AnforderungSample POST request

{
  '__metadata': {
    'type': 'Microsoft.Office.Server.Search.REST.SearchRequest'
  },
  'Querytext': 'sharepoint',
  'Refiners': 'author,size',
}

HiddenConstraintsHiddenConstraints

Zusätzliche Abfrageausdrücke zum Anhängen an die AbfrageThe additional query terms to append to the query.

Beispiel für GET-AnforderungSample GET request

GET http:// _server_/_api/search/query?querytext='sharepoint'&amp;hiddenconstraints='developer'

Beispiel für POST-AnforderungSample POST request

{
  '__metadata': {
    'type': 'Microsoft.Office.Server.Search.REST.SearchRequest'
  },
  'Querytext': 'sharepoint',
  'HiddenConstraints': 'developer'
}

SortListSortList

Liste der Eigenschaften, nach der die Suchergebnisse sortiert sindThe list of properties by which the search results are ordered.

Beispiel für GET-AnforderungSample GET request

GET http:// _server_/_api/search/query?querytext='sharepoint'&amp;sortlist='rank:descending,modifiedby:ascending'

Beispiel für POST-AnforderungSample POST request

{
  '__metadata': {
    'type': 'Microsoft.Office.Server.Search.REST.SearchRequest'
  },
  'Querytext': 'sharepoint',
  'SortList': {
    'results': [
      {
        'Property': 'Created',
        'Direction': '0'
      },
      {
        'Property': 'FileExtension',
        'Direction': '1'
      }
    ]
  }
}

EnableStemmingEnableStemming

Ein boolescher Wert, der angibt, ob Wortstammerkennung aktiviert istA Boolean value that specifies whether stemming is enabled.

true, wenn Wortstammerkennung aktiviert ist; andernfalls false. Der Standardwert ist true.true if the stemming is enabled; otherwise, false. The default value is true.

Beispiel für GET-AnforderungSample GET request

GET http:// _server_/_api/search/query?querytext='sharepoint'&amp;enablestemming=false

Beispiel für POST-AnforderungSample POST request

{
  '__metadata': {
    'type': 'Microsoft.Office.Server.Search.REST.SearchRequest'
  },
  'Querytext': 'sharepoint',
  'EnableStemming : 'False'
}

TrimDuplicatesTrimDuplicates

Ein boolescher Wert, der angibt, ob doppelte Elemente aus den Ergebnissen entfernt werdenA Boolean value that specifies whether duplicate items are removed from the results.

true, um doppelte Elemente zu entfernen; andernfalls false. Der Standardwert ist true.true to remove the duplicate items; otherwise, false. The default value is true.

Beispiel für GET-AnforderungSample GET request

GET http:// _server_/_api/search/query?querytext='sharepoint'&amp;trimduplicates=false

Beispiel für POST-AnforderungSample POST request

{
  '__metadata': {
    'type': 'Microsoft.Office.Server.Search.REST.SearchRequest'
  },
  'Querytext': 'sharepoint',
  'TrimDuplicates': 'False'
}

TimeoutTimeout

Zeit in Millisekunden bis zum Timeout der Abfrageanforderung. Der Standardwert ist 30000.The amount of time in milliseconds before the query request times out. The default value is 30000.

Beispiel für GET-AnforderungSample GET request

GET http:// _server_/_api/search/query?querytext='sharepoint'&amp;timeout=60000

Beispiel für POST-AnforderungSample POST request

{
  '__metadata': {
    'type': 'Microsoft.Office.Server.Search.REST.SearchRequest'
  },
  'Querytext': 'sharepoint',
  'Timeout': '60000'
}

EnableNicknamesEnableNicknames

Ein boolescher Wert, der angibt, ob die genauen Ausdrücke in der Suchabfrage verwendet werden, um Übereinstimmungen zu finden, oder ob auch Spitznamen verwendet werdenA Boolean value that specifies whether the exact terms in the search query are used to find matches, or if nicknames are used also. true, wenn Spitznamen verwendet werden; andernfalls false.true if nicknames are used; otherwise, false. Der Standardwert ist false.The default value is false.

Beispiel für GET-AnforderungSample GET request

GET http:// _server_/_api/search/query?querytext='sharepoint'&amp;enablenicknames=true

Beispiel für POST-AnforderungSample POST request

{
  '__metadata': {
    'type': 'Microsoft.Office.Server.Search.REST.SearchRequest'
  },
  'Querytext': 'sharepoint',
  'EnableNicknames': 'True'
}

EnablePhoneticEnablePhonetic

Ein boolescher Wert, der angibt, ob die phonetische Form der Abfrageausdrücke verwendet wird, um Übereinstimmungen zu findenA Boolean value that specifies whether the phonetic forms of the query terms are used to find matches.

true, wenn die phonetische Form verwendet wird; andernfalls false. Der Standardwert ist false.true if phonetic forms are used; otherwise, false. The default value is false.

Beispiel für GET-AnforderungSample GET request

GET http:// _server_/_api/search/query?querytext='sharepoint'&amp;enablephonetic=true

Beispiel für POST-AnforderungSample POST request

{
  '__metadata': {
    'type': 'Microsoft.Office.Server.Search.REST.SearchRequest'
  },
  'Querytext': 'sharepoint',
  'EnablePhonetic': 'True'
}

EnableFqlEnableFql

Ein boolescher Wert, der angibt, ob die Abfrage die FAST Query Language (FQL) verwendetA Boolean value that specifies whether the query uses the FAST Query Language (FQL).

true, wenn die Abfrage eine FQL-Abfrage ist; andernfalls false. Der Standardwert ist false.true if the query is an FQL query; otherwise, false. The default value is false.

Beispiel für GET-AnforderungSample GET request

GET http:// _server_/_api/search/query?querytext='sharepoint'&amp;enablefql=true

Beispiel für POST-AnforderungSample POST request

{
  '__metadata': {
    'type': 'Microsoft.Office.Server.Search.REST.SearchRequest'
  },
  'Querytext': 'sharepoint',
  'EnableFQL': 'True'
}

HitHighlightedPropertiesHithighlightedProperties

Eigenschaften zur Hervorhebung in der Suchergebnisübersicht, wenn der Eigenschaftenwert den vom Benutzer eingegebenen Suchbegriffen entspricht. Für GET-Anforderungen geben Sie eine Zeichenfolge mit einer durch Kommas getrennten Liste von Eigenschaften an. Für POST-Anforderungen geben Sie ein Array von Zeichenfolgen an.The properties to highlight in the search result summary when the property value matches the search terms entered by the user. For GET requests, Specify in a string containing a comma-separated list of properties. For POST requests, specify as an array of strings.

Beispiel für GET-AnforderungSample GET request

GET http:// _server_/_api/search/query?querytext='sharepoint'&amp;hithighlightedproperties='Title'

Beispiel für POST-AnforderungSample POST request

{
  '__metadata': {
    'type': 'Microsoft.Office.Server.Search.REST.SearchRequest'
  },
  'Querytext': 'sharepoint',
  'HitHighlightedProperties':  {
    'results': ['Title']
  }
}

BypassResultTypesBypassResultTypes

Ein boolescher Wert, der angibt, ob eine Ergebnistypverarbeitung für die Abfrage durchgeführt werden sollA Boolean value that specifies whether to perform result type processing for the query.

true, um eine Ereignistypverarbeitung durchzuführen; andernfalls false. Der Standardwert ist false.true to perform result type processing; otherwise, false. The default value is false.

Beispiel für GET-AnforderungSample GET request

GET http:// _server_/_api/search/query?querytext='sharepoint'&amp;bypassresulttypes=true

Beispiel für POST-AnforderungSample POST request

{
  '__metadata': {
    'type': 'Microsoft.Office.Server.Search.REST.SearchRequest'
  },
  'Querytext': 'sharepoint',
  'BypassResultTypes': 'true'
}

ProcessBestBetsProcessBestBets

Ein boolescher Wert, der angibt, ob die besten Suchergebnisse für die Abfrage zurückgegeben werden sollenA Boolean value that specifies whether to return best bet results for the query.

true, um die besten Suchergebnisse zurückzugeben; andernfalls false. Dieser Parameter wird nur verwendet, wenn EnableQueryRules auf true festgelegt ist. Andernfalls wird er ignoriert. Der Standardwert ist false.true to return best bets; otherwise, false. This parameter is used only when EnableQueryRules is set to true, otherwise it is ignored. The default value is false.

Beispiel für GET-AnforderungSample GET request

GET http:// _server_/_api/search/query?querytext='sharepoint'&amp;processbestbets=true&amp;enablequeryrules=true

Beispiel für POST-AnforderungSample POST request

{
  '__metadata': {
    'type': 'Microsoft.Office.Server.Search.REST.SearchRequest'
  },
  'Querytext': 'sharepoint',
  'ProcessBestBets': 'true',
  'EnableQueryRules': 'true'
}

ClientTypeClientType

Typ des Clients, der die Abfrage gesendet hatThe type of the client that issued the query.

Beispiel für GET-AnforderungSample GET request

GET http:// _server_/_api/search/query?querytext='sharepoint'&amp;clienttype='custom'

Beispiel für POST-AnforderungSample POST request

{
  '__metadata': {
    'type': 'Microsoft.Office.Server.Search.REST.SearchRequest'
  },
  'Querytext': 'sharepoint',
  'ClientType': 'custom'
}

PersonalizationDataPersonalizationData

GUID für den Benutzer, der die Suchabfrage gesendet hatThe GUID for the user who submitted the search query.

Beispiel für GET-AnforderungSample GET request

GET http:// _\<server\>_/_api/search/query?querytext='sharepoint'&amp;personalizationdata=' _\<GUID\>_'

Beispiel für POST-AnforderungSample POST request

{
  '__metadata': {
    'type': 'Microsoft.Office.Server.Search.REST.SearchRequest'
  },
  'Querytext': 'sharepoint',
  'PersonalizationData': ' <GUID> '
}

ResultsURLResultsURL

URL für die Seite mit den SuchergebnissenThe URL for the search results page.

Beispiel für GET-AnforderungSample GET request

GET http:// _server_/_api/search/query?querytext='sharepoint'&amp;resultsurl='http://server/site/resultspage.aspx'

Beispiel für POST-AnforderungSample POST request

{
  '__metadata': {
    'type': 'Microsoft.Office.Server.Search.REST.SearchRequest'
  },
  'Querytext': 'sharepoint'
  'ResultURL': 'http://server/site/resultspage.aspx'
}

QueryTagQueryTag

Benutzerdefinierte Tags, die die Abfrage identifizieren. Sie können mehrere Abfrage-Tags angeben, getrennt durch Semikolons.Custom tags that identify the query. You can specify multiple query tags, separated by semicolons.

Beispiel für GET-AnforderungSample GET request

GET http:// _server_/_api/search/query?querytext='sharepoint'

Beispiel für POST-AnforderungSample POST request

{
  '__metadata': {
    'type': 'Microsoft.Office.Server.Search.REST.SearchRequest'
  },
  'Querytext': 'sharepoint'
}

EigenschaftenProperties

Zusätzliche Eigenschaften für die Abfrage.Additional properties for the query. GET-Anforderungen unterstützen nur Zeichenfolgewerte.GET requests support only string values. POST-Anforderungen unterstützen Werte jedes Typs.POST requests support values of any type.

Beispiel für GET-AnforderungSample GET request

GET http:// _server_/_api/search/query?querytext='sharepoint'&amp;properties='termid:guid'

Beispiel für POST-AnforderungSample POST request

{
  '__metadata': {
    'type': 'Microsoft.Office.Server.Search.REST.SearchRequest'
  },
  'Querytext': 'sharepoint',
  'Properties': {
    'results': [
      {
        'Name': 'sampleBooleanProperty',
        'Value':
        {
          'BoolVal': 'True',
          'QueryPropertyValueTypeIndex': 3
        }
      },
      {
        'Name': 'sampleIntProperty',
        'Value':
        {
          'IntVal': '1234',
          'QueryPropertyValueTypeIndex': 2
        }
      }
    ]
  }
}

Hinweis

QueryPropertyValueType gibt den Typ der Eigenschaft an. Jeder Typ weist einen bestimmten Indexwert auf.QueryPropertyValueType specifies the type for the property; each type has a specific index value.

EnableQueryRulesEnableQueryRules

Ein boolescher Wert, der angibt, ob Abfrageregeln für die Abfrage aktiviert werdenA Boolean value that specifies whether to enable query rules for the query.

true, um Abfrageregeln zu aktivieren; andernfalls false. Der Standardwert ist true.true to enable query rules; otherwise, false. The default value is true.

Beispiel für GET-AnforderungSample GET request

GET http:// _server_/_api/search/query?querytext='sharepoint'&amp;enablequeryrules=false

Beispiel für POST-AnforderungSample POST request

{
  '__metadata': {
    'type': 'Microsoft.Office.Server.Search.REST.SearchRequest'
  },
  'Querytext': 'sharepoint',
  'EnableQueryRules': 'false'
}

ReorderingRulesReorderingRules

Spezielle Regeln für die Neuanordnung der Suchergebnisse. Diese Regeln können angeben, dass Dokumente, die bestimmte Bedingungen erfüllen, weiter oben oder unten in den Ergebnissen platziert werden. Diese Eigenschaft wird nur angewendet, wenn die Suchergebnisse basierend auf dem Rang sortiert sind. Sie müssen eine POST-Anforderung für diese Eigenschaft verwenden; dies funktioniert nicht für eine GET-Anforderung.Special rules for reordering search results. These rules can specify that documents matching certain conditions are ranked higher or lower in the results. This property applies only when search results are sorted based on rank. You must use a POST request for this property; it does not work in a GET request.

Im folgenden Beispiel bezieht sich MatchType auf ReorderingRuleMatchType. Im folgenden Beispiel gibt 'MatchType': '0' ResultContainsKeywordan.In the following example, MatchType refers to ReorderingRuleMatchType . In the following example, 'MatchType': '0' specifies ResultContainsKeyword.

Beispiel für POST-AnforderungSample POST request

{
  '__metadata': {
  'type': 'Microsoft.Office.Server.Search.REST.SearchRequest'
  },
  'Querytext': 'sharepoint',
  'ReorderingRules':  {
    'results': [
    {
      'MatchValue': '<someValue>',
      'Boost': '10',
      'MatchType': '0'
    }
    ]
  }
}

ProcessPersonalFavoritesProcessPersonalFavorites

Ein boolescher Wert, der angibt, ob persönliche Favoriten in den Suchergebnissen zurückgegeben werdenA Boolean value that specifies whether to return personal favorites with the search results.

true, um persönliche Favoriten zurückzugeben; andernfalls false.true to return personal favorites; otherwise false.

Beispiel für GET-AnforderungSample GET request

GET http:// _server_/_api/search/query?querytext='sharepoint'&amp;processpersonalfavorites=true

Beispiel für POST-AnforderungSample POST request

{
  '__metadata': {
    'type': 'Microsoft.Office.Server.Search.REST.SearchRequest'
  },
  'Querytext ': 'sharepoint',
  'ProcessPersonalFavorites': 'false'
}

QueryTemplatePropertiesUrlQueryTemplatePropertiesUrl

Speicherort der Datei queryparametertemplate.xml.The location of the queryparametertemplate.xml file. Diese Datei wird verwendet, um anonymen Benutzern das Erstellen von Search-REST-Abfragen zu ermöglichen.This file is used to enable anonymous users to make Search REST queries.

Beispiel für GET-AnforderungSample GET request

GET http:// _server_/_api/search/query?querytext='sharepoint'&amp;querytemplatepropertiesurl='spfile://webroot/queryparametertemplate.xml'

Beispiel für POST-AnforderungSample POST request

{
  '__metadata': {
    'type': 'Microsoft.Office.Server.Search.REST.SearchRequest'
  },
  'Querytext ': 'sharepoint',
  QueryTemplatePropertiesUrl : 'spfile://webroot/queryparametertemplate.xml'
}

HitHighlightedMultivaluePropertyLimitHitHighlightedMultivaluePropertyLimit

Anzahl der Eigenschaften für die Anzeige der Treffermarkierung in den SuchergebnissenThe number of properties to show hit highlighting for in the search results.

Beispiel für GET-AnforderungSample GET request

GET http:// _server_/_api/search/query?querytext='sharepoint'&amp;hithighlightedmultivaluepropertylimit=2

Beispiel für POST-AnforderungSample POST request

{
  '__metadata': {
    'type': 'Microsoft.Office.Server.Search.REST.SearchRequest'
  },
  'Querytext ': 'sharepoint',
  'HitHighlihtedMultivaluePropertyLimit': '2'
}

EnableOrderingHitHighlightedPropertyEnableOrderingHitHighlightedProperty

Ein boolescher Wert, der angibt, ob die Eigenschaften für die Treffermarkierung sortiert werden könnenA Boolean value that specifies whether the hit highlighted properties can be ordered.

true, um Sortierungsregeln zu aktivieren; andernfalls false.true to enable ordering rules; otherwise false.

Beispiel für GET-AnforderungSample GET request

GET http:// _server_/_api/search/query?querytext='sharepoint'&amp;enableorderinghithighlightedproperty=false

Beispiel für POST-AnforderungSample POST request

{
  '__metadata': {
    'type': 'Microsoft.Office.Server.Search.REST.SearchRequest'
  },
  'Querytext ': 'sharepoint',
  'EnableOrderingHitHighlightedProperty': 'false'
}

CollapseSpecificationCollapseSpecification

Verwaltete Eigenschaften zum Reduzieren einzelner Suchergebnisse. Ergebnisse werden auf ein Ergebnis oder eine angegebene Anzahl von Ergebnissen reduziert, wenn sie beliebigen individuellen Reduzierungsspezifikationen entsprechen. In einer einzelnen Reduzierungsspezifikation werden die Ergebnisse reduziert, wenn ihre Eigenschaften allen individuellen Eigenschaften in der Reduzierungsspezifikation entsprechen.The managed properties that are used to determine how to collapse individual search results. Results are collapsed into one or a specified number of results if they match any of the individual collapse specifications. Within a single collapse specification, results are collapsed if their properties match all individual properties in the collapse specification.

Beispiel für GET-AnforderungSample GET request

GET http:// _server_/_api/search/query?querytext='sharepoint'&amp;collapsespecification='Author:1 ContentType:2'

Beispiel für POST-AnforderungSample POST request

{
  '__metadata': {
    'type': 'Microsoft.Office.Server.Search.REST.SearchRequest'
  },
  'Querytext ': 'sharepoint',
  'CollapseSpecification': 'Author:1 ContentType:2'
}

EnableSortingEnableSorting

Ein boolescher Wert, der angibt, ob die Suchergebnisse sortiert werdenA Boolean value that specifies whether to sort search results.

true, um die Suchergebnisse mit SortList oder nach Rang zu sortieren, wenn SortList leer ist.I true to sort search results using SortList, or by rank if SortList is empty. false, um die Ergebnisse unsortiert zu lassen.false to leave results unsorted.

Beispiel für GET-AnforderungSample GET request

GET http:// _server_/_api/search/query?querytext='sharepoint'&amp;enablesorting=false

Beispiel für POST-AnforderungSample POST request

{
  '__metadata': {
    'type': 'Microsoft.Office.Server.Search.REST.SearchRequest'
  },
  'Querytext ': 'sharepoint',
  'EnableSorting': 'false'
}

GenerateBlockRankLogGenerateBlockRankLog

Ein boolescher Wert, der angibt, ob Blockrang-Protokollinformationen in der Eigenschaft BlockRankLog der überlappenden Ergebnistabelle zurückgegeben werden. Ein Blockrang-Protokoll enthält die Textinformationen zur Blockbewertung und die Dokumente, die dedupliziert wurden.A Boolean value that specifies whether to return block rank log information in the BlockRankLog property of the interleaved result table. A block rank log contains the textual information on the block score and the documents that were de-duplicated.

true, um Blockrang-Protokollinformationen zurückzugeben; andernfalls false.true to return block rank log information; otherwise, false.

Beispiel für GET-AnforderungSample GET request

GET http:// _server_/_api/search/query?querytext='sharepoint'&amp;generateblockranklog=true

Beispiel für POST-AnforderungSample POST request

{
  '__metadata': {
    'type': 'Microsoft.Office.Server.Search.REST.SearchRequest'
  },
  'Querytext ': 'sharepoint',
  'GenerateBlockRankLog': 'true'
}

UIlanguageUIlanguage

Gebietsschema-ID (LCID) der Benutzeroberfläche (siehe Von Microsoft zugewiesene Gebietsschema-IDs).The locale identifier (LCID) of the user interface (see Locale IDs Assigned by Microsoft).

Beispiel für GET-AnforderungSample GET request

GET http:// _server_/_api/search/query?querytext='sharepoint'&amp;uilanguage=1044

Beispiel für POST-AnforderungSample POST request

{
  '__metadata': {
    'type': 'Microsoft.Office.Server.Search.REST.SearchRequest'
  },
  'Querytext ': 'sharepoint',
  'UILanguage': '1044'
}

DesiredSnippetLengthDesiredSnippetLength

Bevorzugte Anzahl von Zeichen in der Treffermarkierungsübersicht für ein SuchergebnisThe preferred number of characters to display in the hit-highlighted summary generated for a search result.

Beispiel für GET-AnforderungSample GET request

GET http:// _server_/_api/search/query?querytext='sharepoint'&amp;desiredsnippetlength=80

Beispiel für POST-AnforderungSample POST request

{
  '__metadata': {
    'type': 'Microsoft.Office.Server.Search.REST.SearchRequest'
  },
  'Querytext ': 'sharepoint',
  'DesiredSnippetLength': '80'
}

MaxSnippetLengthMaxSnippetLength

Maximale Anzahl von Zeichen in der Treffermarkierungsübersicht für ein SuchergebnisThe maximum number of characters to display in the hit-highlighted summary generated for a search result.

Beispiel für GET-AnforderungSample GET request

GET http:// _server_/_api/search/query?querytext='sharepoint'&amp;maxsnippetlength=100

Beispiel für POST-AnforderungSample POST request

{
  '__metadata': {
    'type': 'Microsoft.Office.Server.Search.REST.SearchRequest'
  },
  'Querytext ': 'sharepoint',
  'MaxSnippetLength': '100' 
}

SummaryLengthSummaryLength

Anzahl der Zeichen in der Ergebnisübersicht für ein SuchergebnisThe number of characters to display in the result summary for a search result.

Beispiel für GET-AnforderungSample GET request

GET http:// _server_/_api/search/query?querytext='sharepoint'&amp;summarylength=150

Beispiel für POST-AnforderungSample POST request

{
  '__metadata': {
    'type': 'Microsoft.Office.Server.Search.REST.SearchRequest'
  },
  'Querytext ': 'sharepoint',
  'Summarylength': '150'
}

ContentSettingContentSetting

Ein Zeichenfolgewert, der ein alternatives Inhaltsziel für die Abfrage angibt..A string value that specifies an alternative scope of content for the query. Der Parameter ist als Zeichenfolge formatiert, repräsentiert jedoch einen numerischen Wert.The parameter is formatted as a string, but represents a numeric value. Der Standardwert ist 0.The default value is 0. Diese Eigenschaft wenden Sie über den Eigenschaftenbehälter (Eigenschaften) an.You apply this property via the query property bag (Properties).

  • 0 : Der Bereich für die Abfrage umfasst alle freigegebenen Inhalte, die in SharePoint Online indiziert wurden.0 : The scope for the query is all shared content that's been indexed in SharePoint Online. Anhand dieses Werts des Parameters werden private Ergebnisse nicht zurückgegeben.With this value of the parameter, private results aren't returned. In diesem Zusammenhang bedeutet privat OneDrive for Business-Inhalte, auf die nur der Besitzer von OneDrive for Business zugreifen kann.In this context private means OneDrive for Business content that only the owner of the OneDrive for Business has access to.
  • 3 : Der Bereich für die Abfrage umfasst alle freigegebenen Inhalte, die in SharePoint Online indiziert wurden plus die privaten OneDrive for Business-Inhalte des Benutzers.3 : The scope for the query is all shared content that's been indexed in SharePoint Online plus the user's private OneDrive for Business content. Zwei Ergebnisblöcke werden zurückgegeben.Two result blocks are returned. Der Hauptergebnisblock enthält Ergebnisse von freigegebenen Inhalten, ausgenommen aller Ergebnisse von von OneDrive for Business des Benutzers.The main result block contains results from shared content, excluding any results from the user’s own OneDrive for Business. Der zweite Ergebnisblock enthält Ergebnisse von OneDrive for Business des Benutzers (private und freigegebene).The second result block contains results from the user’s own OneDrive for Business (private and shared). Dieser Wert des Parameters ermöglicht es der Suchoberfläche Ergebnisse von OneDrive des Benutzers getrennt von den Hauptergebnissen darzustellen.This value of the parameter enables the search experience to present results from the user’s own OneDrive separate from the main shared results.

Hinweis

Die Werte 1 und 2 sind für die zukünftige Verwendung reserviert.The values 1 and 2 are reserved for future use.

Beispiel für GET-AnforderungSample GET request

http://server/_api/search/query?querytext='sharepoint'&properties='ContentSetting:3'http://server/_api/search/query?querytext='sharepoint'&properties='ContentSetting:3'

Beispiel für POST-AnforderungSample POST request

{
  '__metadata': {
    'type': 'Microsoft.Office.Server.Search.REST.SearchRequest'
  },
  'Querytext': 'sharepoint',
  'Properties': {
    'results': [
      {
        'Name': 'ContentSetting',
        'Value':
        {
            'IntVal': '3',
            'QueryPropertyValueTypeIndex': '2'
        }
      }
    ]
  }
}

Ermöglichen anonymer Search-REST-AbfragenEnabling anonymous Search REST queries

Sie können die Suche so konfigurieren, um Search-REST-Abfragen anonymer Benutzer zuzulassen.You can configure search to support Search REST queries from anonymous users. Websiteadministratoren können entscheiden, welche Abfrageparameter unter Verwendung der Datei queryparametertemplate.xml anonymen Benutzern zur Verfügung gestellt werden.Site administrators can decide what query parameters to expose to anonymous users by using the queryparametertemplate.xml file. Dieser Abschnitt beschreibt die Konfiguration Ihrer Website, um anonymen Zugriff zu ermöglichen und die Datei queryparametertemplate.xml zu erstellen.This section describes how to configure your site to enable anonymous access, and create the queryparametertemplate.xml file.

So ermöglichen Sie anonyme Search-REST-AbfragenTo enable anonymous Search REST queries

  1. Ermöglichen Sie den anonymen Zugriff auf die Webanwendung und Veröffentlichungswebsite. Weitere Informationen erhalten Sie unter Verwalten von Berechtigungsrichtlinien für eine Webanwendung in SharePoint und Planen der Benutzerauthentifizierungsmethoden in SharePoint in TechNet.Enable anonymous access on the web application and publishing site. For more information about how to do this, see Manage permission policies for a web application in SharePoint and Plan for user authentication methods in SharePoint on TechNet.

  2. Fügen Sie eine neue Dokumentbibliothek namens QueryPropertiesTemplate zur Veröffentlichungswebsite hinzu.Add a new document library named QueryPropertiesTemplate to the publishing site.

  3. Erstellen Sie eine XML-Datei namens queryparametertemplate.xml, und kopieren Sie die folgende XML in die Datei.Create an XML file named queryparametertemplate.xml, and copy the following XML to the file.

    <QueryPropertiesTemplate xmlns="http://www.microsoft.com/sharepoint/search/KnownTypes/2008/08" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
      <QueryProperties i:type="KeywordQueryProperties">
        <EnableStemming>true</EnableStemming>
        <FarmId>FarmID</FarmId>
        <IgnoreAllNoiseQuery>true</IgnoreAllNoiseQuery>
        <KeywordInclusion>AllKeywords</KeywordInclusion>
        <SiteId>SiteID</SiteId>
        <SummaryLength>180</SummaryLength>
        <TrimDuplicates>true</TrimDuplicates>
        <WcfTimeout>120000</WcfTimeout>
        <WebId>WebID</WebId>
        <Properties xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <a:KeyValueOfstringanyType>
            <a:Key>_IsEntSearchLicensed</a:Key>
            <a:Value i:type="b:boolean" xmlns:b="http://www.w3.org/2001/XMLSchema">true</a:Value>
          </a:KeyValueOfstringanyType>
          <a:KeyValueOfstringanyType>
            <a:Key>EnableSorting</a:Key>
            <a:Value i:type="b:boolean" xmlns:b="http://www.w3.org/2001/XMLSchema">true</a:Value>
          </a:KeyValueOfstringanyType>
          <a:KeyValueOfstringanyType>
            <a:Key>MaxKeywordQueryTextLength</a:Key>
            <a:Value i:type="b:int" xmlns:b="http://www.w3.org/2001/XMLSchema">4096</a:Value>
          </a:KeyValueOfstringanyType>
          <a:KeyValueOfstringanyType>
            <a:Key>TryCache</a:Key>
            <a:Value i:type="b:boolean" xmlns:b="http://www.w3.org/2001/XMLSchema">true</a:Value>
          </a:KeyValueOfstringanyType>
        </Properties>
        <PropertiesContractVersion>15.0.0.0</PropertiesContractVersion>
        <EnableFQL>false</EnableFQL>
        <EnableSpellcheck>Suggest</EnableSpellcheck>
        <EnableUrlSmashing>true</EnableUrlSmashing>
        <IsCachable>false</IsCachable>
        <MaxShallowRefinementHits>100</MaxShallowRefinementHits>
        <MaxSummaryLength>185</MaxSummaryLength>
        <MaxUrlLength>2048</MaxUrlLength>
        <SimilarType>None</SimilarType>
        <SortSimilar>true</SortSimilar>
        <TrimDuplicatesIncludeId>0</TrimDuplicatesIncludeId>
        <TrimDuplicatesKeepCount>1</TrimDuplicatesKeepCount>
      </QueryProperties>
      <WhiteList xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a:string>RowLimit</a:string>
        <a:string>SortList</a:string>
        <a:string>StartRow</a:string>
        <a:string>RefinementFilters</a:string>
        <a:string>Culture</a:string>
        <a:string>RankingModelId</a:string>
        <a:string>TrimDuplicatesIncludeId</a:string>
        <a:string>ReorderingRules</a:string>
        <a:string>EnableQueryRules</a:string>
        <a:string>HiddenConstraints</a:string>
        <a:string>QueryText</a:string>
        <a:string>QueryTemplate</a:string>
      </WhiteList>
    </QueryPropertiesTemplate>
    
  4. Aktualisieren Sie die Elemente SiteId, FarmId und WebId mit den Werten für Ihre Farm-, Website- und Veröffentlichungswebsitesammlung.Update the SiteId, FarmId, and WebId elements with the values for your farm, website and publishing site collection.

  5. Speichern Sie die Datei queryparametertemplate.xml in der QueryPropertiesTemplate-Dokumentbibliothek.Save queryparametertemplate.xml to the QueryPropertiesTemplate document library.

  6. Fügen Sie den Parameter QueryTemplatePropertiesUrl zu Ihrem Search-REST-Aufruf hinzu, und geben Sie spfile://webroot/queryparametertemplate.xml als Wert an.Add the QueryTemplatePropertiesUrlQueryTemplatePropertiesUrl parameter to your Search REST call, specifying spfile://webroot/queryparametertemplate.xmlspfile://webroot/queryparametertemplate.xml as the value.

Datei "queryparametertemplate.xml"queryparametertemplate.xml file

Die wichtigsten Elemente in der Datei queryparametertemplate.xml sind:The primary elements in the queryparametertemplate.xml file are:

  • Element QueryPropertiesQueryProperties element

    Enthält ein serialisiertes QueryProperties -Objekt.Contains a serialized QueryProperties object.

  • Element WhiteListWhiteList element

    Enthält die Liste der Abfrageeigenschaften, die der anonyme Benutzer festlegen darf.Contains the list of query properties that the anonymous user is allowed to set.

Wenn eine anonyme Search-REST-Abfrage gesendet wird, wird das Abfrageobjekt mit den Informationen im QueryProperties-Element erstellt. Dann werden alle Eigenschaften in der Positivliste aus der eingehenden Abfrage in das neu erstellte Abfrageobjekt kopiert.When an anonymous Search REST query is submitted, the query object is constructed using what's specified in the QueryProperties element. Then, all the properties that are listed in the whitelist are copied from the incoming query to the newly constructed query object.

Inhalt dieses AbschnittsIn this section

Weitere ArtikelSee also