Feedback Bearbeiten

searchRequest-Ressourcentyp

  • Artikel
  • 2 Minuten Lesedauer

Namespace: microsoft.graph

Eine Suchanforderung, die in einem JSON-Blob formatiert ist.

Das JSON-Blob enthält die In der Antwort erwarteten Ressourcentypen, die zugrunde liegenden Quellen, Pagingparameter, Sortieroptionen, angeforderte Aggregationen und Felder sowie die tatsächliche Suchabfrage. Sehen Sie sich Beispiele für Suchanforderungen für verschiedene Ressourcen an.

Hinweis

Beachten Sie bekannte Einschränkungen bei der Suche nach bestimmten Kombinationen von Entitätstypen sowie beim Sortieren oder Aggregieren von Suchergebnissen.

Eigenschaften

Eigenschaft Typ Beschreibung
aggregationFilters String collection Enthält einen oder mehrere Filter zum Abrufen von Suchergebnissen, die aggregiert und nach einem bestimmten Wert eines Felds gefiltert werden. Optional.
Erstellen Sie diesen Filter basierend auf einer vorherigen Suche, die nach demselben Feld aggregiert wird. Identifizieren Sie aus der Antwort der vorherigen Suche das searchBucket-Objekt , das Ergebnisse auf den spezifischen Wert des Felds filtert, verwenden Sie die Zeichenfolge in der aggregationFilterToken-Eigenschaft , und erstellen Sie eine Aggregationsfilterzeichenfolge im Format "{field}:\"{aggregationFilterToken}\".
Wenn mehrere Werte für dasselbe Feld angegeben werden müssen, verwenden Sie die Zeichenfolgen in der aggregationFilterToken-Eigenschaft , und erstellen Sie eine Aggregationsfilterzeichenfolge im Format "{field}:or("\{aggregationFilterToken1}\",\"{aggregationFilterToken2}\")".
Beispielsweise gibt das Suchen und Aggregieren von Laufwerkelementen nach Dateityp ein searchBucket für den Dateityp docx in der Antwort zurück. Sie können das für dieses searchBucket zurückgegebene aggregationFilterToken bequem in einer nachfolgenden Suchabfrage verwenden und Übereinstimmungen filtern, um Elemente des docx Dateityps zu steuern. Beispiel 1 und Beispiel 2 zeigen die tatsächlichen Anforderungen und Antworten.
aggregations aggregationOption-Auflistung Gibt Aggregationen (auch als Einschränkungen bezeichnet) an, die zusammen mit den Suchergebnissen zurückgegeben werden sollen. Optional.
contentSources Zeichenfolgenauflistung Enthält die zielorientierte Verbindung.
enableTopResults Boolean Dies löst die Hybridsortierreihenfolge für Nachrichten aus: Die ersten drei Nachrichten sind die relevantesten. Diese Eigenschaft gilt nur für entityType=message. Optional.
entityTypes entityType-Auflistung Mindestens eine Art von Ressourcen, die in der Antwort erwartet wird. Mögliche Werte: list, site, listItem, message, event, drive, driveItem, externalItem. Siehe bekannte Einschränkungen für kombinationen von zwei oder mehr Entitätstypen, die in derselben Suchanforderung unterstützt werden. Erforderlich.
fields String collection Enthält die Felder, die für jedes in entityTypes angegebene Ressourcenobjekt zurückgegeben werden sollen, sodass die Standardmäßig zurückgegebenen Felder angepasst werden können. andernfalls einschließlich zusätzlicher Felder wie benutzerdefinierter verwalteter Eigenschaften aus SharePoint und OneDrive oder benutzerdefinierten Feldern in externalItem aus dem Inhalt, den Microsoft Graph Connectors einbringen. Die Fields-Eigenschaft kann die semantischen Bezeichnungen verwenden, die auf Eigenschaften angewendet werden. Wenn eine Eigenschaft beispielsweise als Titel bezeichnet wird, können Sie sie mit der folgenden Syntax abrufen: label_title. Optional.
Von Int32 Gibt den Offset für die Suchergebnisse an. Offset 0 gibt das erste Ergebnis zurück. Optional.
Abfrage searchQuery Enthält die Abfragebegriffe. Erforderlich.
queryAlterationOptions searchAlterationOptions Abfrageänderungsoptionen, die in einem JSON-Blob formatiert sind, das zwei optionale Flags im Zusammenhang mit der Rechtschreibkorrektur enthält. Optional.
resultTemplateOptions resultTemplateOption-Auflistung Stellt die Suchergebnisvorlagenoptionen zum Rendern von Suchergebnissen aus Connectors bereit.
size Int32 Die Größe der abzurufenden Seite. Der Höchstwert ist 1000. Optional.
sortProperties sortProperty-Auflistung Enthält die sortierte Auflistung von Feldern und die Richtung zum Sortieren von Ergebnissen. Es können höchstens fünf Sortiereigenschaften in der Auflistung vorhanden sein. Optional.

JSON-Darstellung

Es folgt eine JSON-Darstellung der Ressource.

{
  "aggregationFilters": ["String"],
  "aggregations": {"@odata.type": "microsoft.graph.aggregationOption"},
  "enableTopResults": "Boolean",
  "entityTypes": ["String"],
  "contentSources": ["String"],
  "fields": ["String"],
  "from": "Int32",
  "query": {"@odata.type": "microsoft.graph.searchQuery"},
  "queryAlterationOptions": {"@odata.type": "microsoft.graph.searchAlterationOptions"},
  "resultTemplateOptions": [{"@odata.type": "microsoft.graph.resultTemplateOption"}],
  "size": "Int32"
}

Siehe auch