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
Flow: implicit
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	Идентификатор запроса.

AutoCompleteOptions

Полезные данные запроса автозаполнения.

Имя	Тип	Описание
filter		Фильтр для запроса автозаполнения.
keywords	string	Ключевые слова, применяемые ко всем полям, поддерживающим операцию автозаполнения. Он должен содержать не менее 1 символа и не более 100 символов.
limit	integer	Количество результатов автозаполнения, которые мы надеемся вернуть. Значение по умолчанию — 50. Значение должно быть числом от 1 до 100.

AutoCompleteResult

Результат запроса автозаполнения.

Имя	Тип	Описание
value	AutoCompleteResultValue[]	Результирующий результат

AutoCompleteResultValue

Элемент значения предложения автозаполнения.

Имя	Тип	Описание
queryPlusText	string	Текст завершенного поискового запроса.
text	string	Завершенный термин или фраза.

Поделиться через