searchEntity: Abfrage

Namespace: microsoft.graph

Wichtig

Die APIs unter der /beta Version in Microsoft Graph können sich ändern. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in v1.0 verfügbar ist, verwenden Sie die Version Selektor.

Ausführen einer bestimmten Suchabfrage. Suchergebnisse werden in der Antwort bereitgestellt.

Achtung

Bei Ressourcen, die in einer Microsoft Search API-Anfrage und -Antwort verwendet werden, wurden Eigenschaften umbenannt oder entfernt, oder sie sind veraltet. Hier finden Sie weitere Einzelheiten über das Ende der Unterstützung. Aktualisieren Sie Such-API-Abfragen in allen früheren Apps entsprechend.

Diese API ist in den folgenden nationalen Cloudbereitstellungen verfügbar.

Weltweiter Service US Government L4 US Government L5 (DOD) China, betrieben von 21Vianet
✅ ✅ ✅ ✅

Berechtigungen

Wählen Sie die Berechtigungen aus, die für diese API als am wenigsten privilegiert markiert sind. Verwenden Sie eine höhere Berechtigung oder Berechtigungen nur, wenn Ihre App dies erfordert. Ausführliche Informationen zu delegierten Berechtigungen und Anwendungsberechtigungen finden Sie unter Berechtigungstypen. Weitere Informationen zu diesen Berechtigungen finden Sie in der Berechtigungsreferenz.

Berechtigungstyp Berechtigungen mit den geringsten Berechtigungen Berechtigungen mit höheren Berechtigungen
Delegiert (Geschäfts-, Schul- oder Unikonto) Mail.Read Acronym.Read.All, Bookmark.Read.All, Calendars.Read, Chat. Read, ExternalItem.Read.All, Files. Read.All, QnA.Read.All, Sites.Read.All
Delegiert (persönliches Microsoft-Konto) Nicht unterstützt Nicht unterstützt
Application Files.Read.All Sites.Read.All

HTTP-Anforderung

POST /search/query

Anforderungsheader

Name Beschreibung
Authorization Bearer {token}. Erforderlich. Erfahren Sie mehr über Authentifizierung und Autorisierung.
Content-type application/json. Erforderlich.

Anforderungstext

Geben Sie im Anforderungstext ein JSON-Objekt mit den folgenden Parametern an.

Parameter Typ Beschreibung
Anforderungen searchRequest-Sammlung Eine Sammlung von einer oder mehreren Suchanforderungen, die jeweils in einem JSON-BLOB formatiert sind. Jedes JSON-Blob enthält die in der Antwort erwarteten Ressourcentypen, die zugrunde liegenden Quellen, Auslagerungsparameter, angeforderten Felder und die tatsächliche Suchabfrage. Beachte bekannte Einschränkungen bei der Suche nach bestimmten Kombinationen von Entitätstypen und beim Sortieren oder Aggregieren von Suchergebnissen.

Antwort

Bei erfolgreicher Ausführung gibt diese Methode einen HTTP 200 OK Antwortcode und eine Auflistung von searchResponse-Objekten im Antworttext zurück.

Jedes searchHit-Objekt kann die sensitivityLabel-Eigenschaft enthalten, wenn die Ergebnisressource über eine Vertraulichkeitsbezeichnung verfügt.

Beispiele

Beispiel 1: Einfacher Aufruf zum Ausführen einer Suchabfrage

Im folgenden Beispiel wird gezeigt, wie Sie eine Suche durchführen, um die erwarteten Connectorelemente zu erhalten.

Anforderung

POST https://graph.microsoft.com/beta/search/query
Content-type: application/json

{
  "requests": [
    {
      "entityTypes": [
        "externalItem"
      ],
      "contentSources": [
        "/external/connections/connectionfriendlyname"
      ],
      "region": "US",
      "query": {
        "queryString": "contoso product"
      },
      "from": 0,
      "size": 25,
      "fields": [
        "title",
        "description"
      ]
    }
  ]
}

Antwort

Das folgende Beispiel zeigt die Antwort.

Hinweis: Das hier gezeigte Antwortobjekt kann zur besseren Lesbarkeit gekürzt werden.

HTTP/1.1 200 OK
Content-type: application/json

{
  "value": [
    {
      "searchTerms": [
        "searchTerms-value"
      ],
      "hitsContainers": [
        {
          "hits": [
            {
              "hitId": "1",
              "rank": 1,
              "summary": "_summary-value",
              "resource": "The source field will contain the underlying graph entity part of the response"
            }
          ],
          "total": 47,
          "moreResultsAvailable": true
        }
      ]
    }
  ]
}

Beispiel 2: Grundlegender Aufruf zur Verwendung von queryTemplate

Im folgenden Beispiel wird gezeigt, wie Sie die abfragbare Eigenschaft createdBy verwenden, um alle von einem Benutzer erstellten Dateien abzurufen.

Anforderung

POST https://graph.microsoft.com/beta/search/query
Content-type: application/json

{
  "requests": [
    {
      "entityTypes": [
        "listItem"
      ],
      "region": "US",
      "query": {
        "queryString": "contoso",
        "queryTemplate":"{searchTerms} CreatedBy:Bob"
      },
      "from": 0,
      "size": 25
    }
  ]
}

Antwort

Das folgende Beispiel zeigt die Antwort.

HTTP/1.1 200 OK
Content-type: application/json

{
    "value": [
        {
            "searchTerms": [
                "contoso"
            ],
            "hitsContainers": [
                {
                    "hits": [
                        {
                            "hitId": "1",
                            "rank": 1,
                            "summary": "_summary-value",
                            "resource": {
                                "@odata.type": "#microsoft.graph.listItem",
                                "id": "c23c7035-73d6-4bad-8901-9e2930d4be8e",
                                "createdBy": {
                                    "user": {
                                        "displayName": "Bob",
                                        "email": "[email protected]"
                                    }
                                },
                                "createdDateTime": "2021-11-19T17:04:18Z",
                                "lastModifiedDateTime": "2023-03-09T18:52:26Z"
                            },
                            "sensitivityLabel": {
                                "sensitivityLabelId": "f71f1f74-bf1f-4e6b-b266-c777ea76e288",
                                "displayName": "Confidential",
                                "tooltip": "Data intended only for approved recipients.",
                                "priority": 4,
                                "color": "#FF8C00"
                            }
                        }
                    ],
                    "total": 1,
                    "moreResultsAvailable": false
                }
            ]
        }
    ]
}