Discovery - Auto Complete

サービス:

Purview

API バージョン:

2023-09-01

オートコンプリート オプションを取得します。

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

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string
api-version	query	True	string	この操作に使用する API バージョン。

要求本文

名前	型	説明
filter		オートコンプリート要求のフィルター。
keywords	string	オートコンプリート操作をサポートするすべてのフィールドに適用されるキーワード。 1 文字以上で、100 文字以下にする必要があります。
limit	integer	返すオートコンプリートの結果の数。 既定値は 50 です。 値は 1 ～ 100 の数値である必要があります。

応答

名前	型	説明
200 OK	AutoCompleteResult	要求は成功しました。
Other Status Codes	AtlasErrorResponse	予期しないエラー応答。

セキュリティ

OAuth2Auth

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
https://purview.azure.net/.default

例

Discovery_AutoComplete

要求のサンプル

HTTP

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

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

応答のサンプル

状態コード:

200

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

定義

名前	説明
AtlasErrorResponse	サービスからのエラー応答
AutoCompleteOptions	オートコンプリート要求のペイロード。
AutoCompleteResult	オートコンプリート要求の結果。
AutoCompleteResultValue	オートコンプリートの値項目が提案されます。

AtlasErrorResponse

サービスからのエラー応答

名前	型	説明
errorCode	string	エラー コード。
errorMessage	string	エラー メッセージ。
requestId	string	要求 ID です。

AutoCompleteOptions

オートコンプリート要求のペイロード。

名前	型	説明
filter		オートコンプリート要求のフィルター。
keywords	string	オートコンプリート操作をサポートするすべてのフィールドに適用されるキーワード。 1 文字以上で、100 文字以下にする必要があります。
limit	integer	返すオートコンプリートの結果の数。 既定値は 50 です。 値は 1 ～ 100 の数値である必要があります。

AutoCompleteResult

オートコンプリート要求の結果。

名前	型	説明
value	AutoCompleteResultValue[]	結果の値

AutoCompleteResultValue

オートコンプリートの値項目が提案されます。

名前	型	説明
queryPlusText	string	完了した検索クエリ テキスト。
text	string	完了した用語または語句。