Discovery - Auto Complete

Dienst:

Purview

API-Version:

2023-09-01

Rufen Sie die Optionen für den automatischen Abschluss ab.

POST {endpoint}/datamap/api/search/autocomplete?api-version=2023-09-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string (uri)
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name	Typ	Beschreibung
filter		Der Filter für die AutoVervollständigen-Anforderung.
keywords	string	Die Schlüsselwörter, die auf alle Felder angewendet werden, die den AutoVervollständigen-Vorgang unterstützen. Es muss mindestens 1 Zeichen und nicht mehr als 100 Zeichen lang sein.
limit	integer (int32)	Die Anzahl der Ergebnisse des autoVervollständigens, die zurückgegeben werden sollen. Der Standardwert ist 50. Der Wert muss eine Zahl zwischen 1 und 100 sein.

Antworten

Name	Typ	Beschreibung
200 OK	AutoCompleteResult	Die Anforderung ist erfolgreich.
Other Status Codes	AtlasErrorResponse	Unerwartete Fehlerantwort.

Sicherheit

OAuth2Auth

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
https://purview.azure.net/.default

Beispiele

Discovery_AutoComplete

Beispielanforderung

HTTP

POST {endpoint}/datamap/api/search/autocomplete?api-version=2023-09-01

{
  "keywords": "exa",
  "filter": {
    "and": [
      {
        "entityType": "azure_blob_path",
        "includeSubTypes": false
      }
    ]
  },
  "limit": 10
}

Beispiel für eine Antwort

Statuscode:

200

{
  "value": [
    {
      "text": "example",
      "queryPlusText": "example"
    },
    {
      "text": "exampleconfiguration",
      "queryPlusText": "exampleconfiguration"
    },
    {
      "text": "exampleresources",
      "queryPlusText": "exampleresources"
    }
  ]
}

Definitionen

Name	Beschreibung
AtlasErrorResponse	Eine Fehlerantwort des Diensts
AutoCompleteOptions	Die Nutzlast der AutoVervollständigen-Anforderung.
AutoCompleteResult	Das Ergebnis der AutoVervollständigen-Anforderung.
AutoCompleteResultValue	Das Wertelement des Vorschlags für autoVervollständigen.

AtlasErrorResponse

Objekt

Eine Fehlerantwort des Diensts

Name	Typ	Beschreibung
errorCode	string	Der Fehlercode.
errorMessage	string	Die Fehlermeldung.
requestId	string (uuid)	Die Anforderungs-ID.

AutoCompleteOptions

Objekt

Die Nutzlast der AutoVervollständigen-Anforderung.

Name	Typ	Beschreibung
filter		Der Filter für die AutoVervollständigen-Anforderung.
keywords	string	Die Schlüsselwörter, die auf alle Felder angewendet werden, die den AutoVervollständigen-Vorgang unterstützen. Es muss mindestens 1 Zeichen und nicht mehr als 100 Zeichen lang sein.
limit	integer (int32)	Die Anzahl der Ergebnisse des autoVervollständigens, die zurückgegeben werden sollen. Der Standardwert ist 50. Der Wert muss eine Zahl zwischen 1 und 100 sein.

AutoCompleteResult

Objekt

Das Ergebnis der AutoVervollständigen-Anforderung.

Name	Typ	Beschreibung
value	AutoCompleteResultValue[]	Der Ergebniswert

AutoCompleteResultValue

Objekt

Das Wertelement des Vorschlags für autoVervollständigen.

Name	Typ	Beschreibung
queryPlusText	string	Der text der abgeschlossenen Suchabfrage.
text	string	Der abgeschlossene Ausdruck oder Ausdruck.